GenericPressableProps

export

interface GenericPressableProps {
  accessibilityActions?: readonly Array<Readonly<{
    label?: string;
    name: string;
  }>>;
  accessibilityElementsHidden?: boolean;
  accessibilityHint?: string;
  accessibilityIgnoresInvertColors?: boolean;
  accessibilityLabel?: string;
  accessibilityLiveRegion?: "none"
    | "polite"
    | "assertive";
  accessibilityRole?: AccessibilityRole;
  accessibilityState?: AccessibilityState;
  accessibilityValue?: AccessibilityValue;
  accessibilityViewIsModal?: boolean;
  accessible?: boolean;
  borderless?: boolean;
  importantForAccessibility?: "auto"
    | "yes"
    | "no"
    | "no-hide-descendants";
  onAccessibilityAction?: (event: AccessibilityActionEvent) => void;
  onAccessibilityEscape?: () => void;
  onAccessibilityTap?: () => void;
  onMagicTap?: () => void;
  onPress?: (event: GestureResponderEvent) => void;
  style?: StyleProp<ViewStyle>;
}

Defined in packages/render-html/src/shared-types.ts

Props for custom Pressable components.

Fields

accessibilityActions

optional

accessibilityActions?: readonly Array<Readonly<{
  label?: string;
  name: string;
}>>;

Provides an array of custom actions available for accessibility.

accessibilityElementsHidden

optional

accessibilityElementsHidden?: boolean;

A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.

accessibilityHint

optional

accessibilityHint?: string;

An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.

accessibilityIgnoresInvertColors

optional

accessibilityIgnoresInvertColors?: boolean;

https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios

accessibilityLabel

optional

accessibilityLabel?: string;

Overrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space.

accessibilityLiveRegion

optional

accessibilityLiveRegion?: "none"
  | "polite"
  | "assertive";

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.

accessibilityRole

optional

accessibilityRole?: AccessibilityRole;

Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.

accessibilityState

optional

accessibilityState?: AccessibilityState;

Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.

accessibilityValue

optional

accessibilityValue?: AccessibilityValue;

Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum).

accessibilityViewIsModal

optional

accessibilityViewIsModal?: boolean;

A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

accessible

optional

accessible?: boolean;

When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.

borderless

optional

borderless?: boolean;

importantForAccessibility

optional

importantForAccessibility?: "auto"
  | "yes"
  | "no"
  | "no-hide-descendants";

Controls how view is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen. Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.

Possible values: 'auto' - The system determines whether the view is important for accessibility - default (recommended). 'yes' - The view is important for accessibility. 'no' - The view is not important for accessibility. 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.

onAccessibilityAction

optional

onAccessibilityAction?: (event: AccessibilityActionEvent) => void;

When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.

onAccessibilityEscape

optional

onAccessibilityEscape?: () => void;

When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).

onAccessibilityTap

optional

onAccessibilityTap?: () => void;

When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.

onMagicTap

optional

onMagicTap?: () => void;

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

onPress

optional

onPress?: (event: GestureResponderEvent) => void;

style

optional

style?: StyleProp<ViewStyle>;