Interface CardFieldProps

Card Field Component Props

interface CardFieldProps {
    accessible?: boolean;
    accessibilityActions?: readonly Readonly<{ name: string; label?: string }>[];
    accessibilityLabel?: string;
    "aria-label"?: string;
    accessibilityRole?: AccessibilityRole;
    accessibilityState?: AccessibilityState;
    "aria-busy"?: boolean;
    "aria-checked"?: boolean | "mixed";
    "aria-disabled"?: boolean;
    "aria-expanded"?: boolean;
    "aria-selected"?: boolean;
    accessibilityHint?: string;
    accessibilityValue?: AccessibilityValue;
    "aria-valuemax"?: number;
    "aria-valuemin"?: number;
    "aria-valuenow"?: number;
    "aria-valuetext"?: string;
    onAccessibilityAction?: (event: AccessibilityActionEvent) => void;
    importantForAccessibility?: "auto" | "yes" | "no" | "no-hide-descendants";
    "aria-hidden"?: boolean;
    "aria-modal"?: boolean;
    role?: Role;
    accessibilityLabelledBy?: string | string[];
    "aria-labelledby"?: string;
    accessibilityLiveRegion?: "none" | "polite" | "assertive";
    "aria-live"?: "off" | "polite" | "assertive";
    accessibilityElementsHidden?: boolean;
    accessibilityViewIsModal?: boolean;
    onAccessibilityEscape?: () => void;
    onAccessibilityTap?: () => void;
    onMagicTap?: () => void;
    accessibilityIgnoresInvertColors?: boolean;
    accessibilityLanguage?: string;
    accessibilityShowsLargeContentViewer?: boolean;
    accessibilityLargeContentTitle?: string;
    style?: StyleProp<ViewStyle>;
    postalCodeEnabled?: boolean;
    countryCode?: string;
    disabled?: boolean;
    cardStyle?: CardFieldInput.Styles;
    placeholders?: CardFieldInput.Placeholders;
    autofocus?: boolean;
    onCardChange(card: CardFieldInput.Details): void;
    onBlur(): void;
    onFocus(focusedField: null | CardFieldInput.FieldName): void;
    testID?: string;
    preferredNetworks?: CardBrand[];
    onBehalfOf?: string;
    dangerouslyGetFullCardDetails?: boolean;
}

Hierarchy

  • AccessibilityProps
    • CardFieldProps

Properties

accessible? accessibilityActions? accessibilityLabel? aria-label? accessibilityRole? accessibilityState? aria-busy? aria-checked? aria-disabled? aria-expanded? aria-selected? accessibilityHint? accessibilityValue? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? onAccessibilityAction? importantForAccessibility? aria-hidden? aria-modal? role? accessibilityLabelledBy? aria-labelledby? accessibilityLiveRegion? aria-live? accessibilityElementsHidden? accessibilityViewIsModal? onAccessibilityEscape? onAccessibilityTap? onMagicTap? accessibilityIgnoresInvertColors? accessibilityLanguage? accessibilityShowsLargeContentViewer? accessibilityLargeContentTitle? style? postalCodeEnabled? countryCode? disabled? cardStyle? placeholders? autofocus? testID? preferredNetworks? onBehalfOf? dangerouslyGetFullCardDetails?

Methods

onCardChange? onBlur? onFocus?

Properties

Optionalaccessible

accessible?: boolean

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

OptionalaccessibilityActions

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

Provides an array of custom actions available for accessibility.

OptionalaccessibilityLabel

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.

Optionalaria-label

"aria-label"?: string

Alias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/facebook/react-native/issues/34424

OptionalaccessibilityRole

accessibilityRole?: AccessibilityRole

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

OptionalaccessibilityState

accessibilityState?: AccessibilityState

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

Optionalaria-busy

"aria-busy"?: boolean

alias for accessibilityState

see https://reactnative.dev/docs/accessibility#accessibilitystate

Optionalaria-checked

"aria-checked"?: boolean | "mixed"

Optionalaria-disabled

"aria-disabled"?: boolean

Optionalaria-expanded

"aria-expanded"?: boolean

Optionalaria-selected

"aria-selected"?: boolean

OptionalaccessibilityHint

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.

OptionalaccessibilityValue

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

Optionalaria-valuemax

"aria-valuemax"?: number

Optionalaria-valuemin

"aria-valuemin"?: number

Optionalaria-valuenow

"aria-valuenow"?: number

Optionalaria-valuetext

"aria-valuetext"?: string

OptionalonAccessibilityAction

onAccessibilityAction?: (event: AccessibilityActionEvent) => void

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

OptionalimportantForAccessibility

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

[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.

Optionalaria-hidden

"aria-hidden"?: boolean

A value indicating whether the accessibility elements contained within this accessibility element are hidden.

Optionalaria-modal

"aria-modal"?: boolean

Optionalrole

role?: Role

Indicates to accessibility services to treat UI component like a specific role.

OptionalaccessibilityLabelledBy

accessibilityLabelledBy?: string | string[]

Identifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.

Platform

android

Optionalaria-labelledby

"aria-labelledby"?: string

Identifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.

Platform

android

OptionalaccessibilityLiveRegion

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

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.

Platform

android

See https://reactnative.dev/docs/view#accessibilityliveregion

Optionalaria-live

"aria-live"?: "off" | "polite" | "assertive"

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.

Platform

android

See https://reactnative.dev/docs/view#accessibilityliveregion

OptionalaccessibilityElementsHidden

accessibilityElementsHidden?: boolean

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

Platform

ios

OptionalaccessibilityViewIsModal

accessibilityViewIsModal?: boolean

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

Platform

ios

OptionalonAccessibilityEscape

onAccessibilityEscape?: () => void

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

Platform

ios

OptionalonAccessibilityTap

onAccessibilityTap?: () => void

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

Platform

ios

OptionalonMagicTap

onMagicTap?: () => void

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

Platform

ios

OptionalaccessibilityIgnoresInvertColors

accessibilityIgnoresInvertColors?: boolean

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

Platform

ios

OptionalaccessibilityLanguage

accessibilityLanguage?: string

By using the accessibilityLanguage property, the screen reader will understand which language to use while reading the element's label, value and hint. The provided string value must follow the BCP 47 specification (https://www.rfc-editor.org/info/bcp47). https://reactnative.dev/docs/accessibility#accessibilitylanguage-ios

Platform

ios

OptionalaccessibilityShowsLargeContentViewer

accessibilityShowsLargeContentViewer?: boolean

A Boolean value that indicates whether or not to show the item in the large content viewer. Available on iOS 13.0+ https://reactnative.dev/docs/accessibility#accessibilityshowslargecontentviewer

Platform

ios

OptionalaccessibilityLargeContentTitle

accessibilityLargeContentTitle?: string

When accessibilityShowsLargeContentViewer is set, this string will be used as title for the large content viewer. https://reactnative.dev/docs/accessibility#accessibilitylargecontenttitle

Platform

ios

Optionalstyle

style?: StyleProp<ViewStyle>

OptionalpostalCodeEnabled

postalCodeEnabled?: boolean

Controls if a postal code entry field can be displayed to the user. If true, the type of code entry shown is controlled by the set countryCode prop. Some country codes may result in no postal code entry being shown if those countries do not commonly use postal codes. If false, no postal code entry will ever be displayed. Defaults to true.

OptionalcountryCode

countryCode?: string

Controls the postal code entry shown (if the postalCodeEnabled prop is set to true). Defaults to the device's default locale.

Optionaldisabled

disabled?: boolean

Applies a disabled state such that user input is not accepted. Defaults to false.

OptionalcardStyle

cardStyle?: CardFieldInput.Styles

Optionalplaceholders

placeholders?: CardFieldInput.Placeholders

Optionalautofocus

autofocus?: boolean

OptionaltestID

testID?: string

OptionalpreferredNetworks

preferredNetworks?: CardBrand[]

The list of preferred networks that should be used to process payments made with a co-branded card. This value will only be used if your user hasn't selected a network themselves.

OptionalonBehalfOf

onBehalfOf?: string

The account (if any) for which the funds of the intent are intended.

OptionaldangerouslyGetFullCardDetails

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

Methods

OptionalonCardChange

OptionalonBlur

  • onBlur(): void

    Returns void

OptionalonFocus

Settings

Member Visibility

On This Page

Properties
Methods