Options
All
  • Public
  • Public/Protected
  • All
Menu

Card Field Component Props

Index

Properties

Optional accessibilityActions

accessibilityActions: readonly Readonly<{ label?: string; name: AccessibilityActionName }>[]

Provides an array of custom actions available for accessibility.

Optional accessibilityComponentType

accessibilityComponentType: "none" | "button" | "radiobutton_checked" | "radiobutton_unchecked"

In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). If we were using native buttons, this would work automatically. Since we are using javascript, we need to provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.

platform

android

Optional accessibilityElementsHidden

accessibilityElementsHidden: boolean

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

platform

ios

Optional accessibilityHint

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.

Optional accessibilityIgnoresInvertColors

accessibilityIgnoresInvertColors: boolean

Optional accessibilityLabel

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.

Optional accessibilityLiveRegion

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.

platform

android

Optional accessibilityRole

accessibilityRole: AccessibilityRole

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

Optional accessibilityState

accessibilityState: AccessibilityState

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

Optional accessibilityTraits

accessibilityTraits: AccessibilityTrait | AccessibilityTrait[]

Accessibility traits tell a person using VoiceOver what kind of element they have selected. Is this element a label? A button? A header? These questions are answered by accessibilityTraits.

platform

ios

Optional accessibilityValue

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).

Optional accessibilityViewIsModal

accessibilityViewIsModal: boolean

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

platform

ios

Optional accessible

accessible: boolean

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

Optional autofocus

autofocus: boolean

Optional cardStyle

cardStyle: Styles

Optional dangerouslyGetFullCardDetails

dangerouslyGetFullCardDetails: boolean

WARNING: If set to true the full card number will be returned in the onCardChange handler. Only do this if you're certain that you fulfill the necessary PCI compliance requirements. Make sure that you're not mistakenly logging or storing full card details! See the docs for details: https://stripe.com/docs/security/guide#validating-pci-compliance

Optional importantForAccessibility

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.

Optional placeholder

placeholder: Placeholders

Optional postalCodeEnabled

postalCodeEnabled: boolean

Optional style

style: StyleProp<ViewStyle>

Optional testID

testID: string

Methods

Optional onAccessibilityAction

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

    Parameters

    • event: AccessibilityActionEvent

Optional onAccessibilityEscape

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

    platform

    ios

Optional onAccessibilityTap

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

    platform

    ios

Optional onBlur

Optional onCardChange

Optional onFocus

Optional onMagicTap

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

    platform

    ios

Legend

  • Property
  • Method

Generated using TypeDoc