Interface AddressSheetProps

Props

interface AddressSheetProps {
    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;
    visible: boolean;
    presentationStyle?:
        | "automatic"
        | "fullscreen"
        | "popover"
        | "pageSheet"
        | "formSheet"
        | "overFullScreen";
    animationStyle?: "flip"
    | "curl"
    | "slide"
    | "dissolve";
    appearance?: RecursivePartial<
        {
            font: PaymentSheet.FontConfig;
            colors: | PaymentSheet.GlobalColorConfig
            | {
                light: PaymentSheet.GlobalColorConfig;
                dark: PaymentSheet.GlobalColorConfig;
            };
            shapes: {
                borderRadius: number;
                borderWidth: number;
                shadow: PaymentSheet.ShadowConfig;
            };
            primaryButton: PaymentSheet.PrimaryButtonConfig;
            embeddedPaymentElement: PaymentSheet.EmbeddedPaymentElementAppearance;
            formInsetValues: PaymentSheet.EdgeInsetsConfig;
            applyLiquidGlass?: boolean;
            navigationBarStyle?: PaymentSheet.NavigationBarStyle;
        },
    >;
    defaultValues?: AddressDetails;
    additionalFields?: {
        phoneNumber?: "hidden"
        | "optional"
        | "required";
        checkboxLabel?: string;
    };
    allowedCountries?: string[];
    autocompleteCountries?: string[];
    primaryButtonTitle?: string;
    sheetTitle?: string;
    googlePlacesApiKey?: string;
    onSubmit: (result: Required) => void;
    onError: (error: StripeError<AddressSheetError>) => void;
}

Hierarchy

  • AccessibilityProps
    • AddressSheetProps

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? visible presentationStyle? animationStyle? appearance? defaultValues? additionalFields? allowedCountries? autocompleteCountries? primaryButtonTitle? sheetTitle? googlePlacesApiKey? onSubmit onError

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

visible

visible: boolean

Whether the sheet is visible. Defaults to false.

OptionalpresentationStyle

presentationStyle?:
    | "automatic"
    | "fullscreen"
    | "popover"
    | "pageSheet"
    | "formSheet"
    | "overFullScreen"

Controls how the modal is presented (after animation). iOS only. Defaults to popover. See https://developer.apple.com/documentation/uikit/uimodalpresentationstyle for more info.

OptionalanimationStyle

animationStyle?: "flip" | "curl" | "slide" | "dissolve"

Controls how the modal animates. iOS only.

Optionalappearance

appearance?: RecursivePartial<
    {
        font: PaymentSheet.FontConfig;
        colors: | PaymentSheet.GlobalColorConfig
        | {
            light: PaymentSheet.GlobalColorConfig;
            dark: PaymentSheet.GlobalColorConfig;
        };
        shapes: {
            borderRadius: number;
            borderWidth: number;
            shadow: PaymentSheet.ShadowConfig;
        };
        primaryButton: PaymentSheet.PrimaryButtonConfig;
        embeddedPaymentElement: PaymentSheet.EmbeddedPaymentElementAppearance;
        formInsetValues: PaymentSheet.EdgeInsetsConfig;
        applyLiquidGlass?: boolean;
        navigationBarStyle?: PaymentSheet.NavigationBarStyle;
    },
>

Configuration for the look and feel of the UI.

OptionaldefaultValues

defaultValues?: AddressDetails

The values to prepopulate the sheet's fields with.

OptionaladditionalFields

additionalFields?: {
    phoneNumber?: "hidden" | "optional" | "required";
    checkboxLabel?: string;
}

Configuration for additional fields besides the physical address

Type declaration

  • OptionalphoneNumber?: "hidden" | "optional" | "required"

    Determines whether the phone number is hidden, required, or optional. Defaults to hidden.

  • OptionalcheckboxLabel?: string

    The label of a checkbox displayed below other fields. If null or undefined, the checkbox is not displayed.

OptionalallowedCountries

allowedCountries?: string[]

A list of two-letter country codes representing countries the customers can select. If the list is empty (the default), we display all countries.

OptionalautocompleteCountries

autocompleteCountries?: string[]

A list of two-letter country codes representing countries that support address autocomplete. Defaults to a list of countries that Stripe has audited to ensure a good autocomplete experience.

OptionalprimaryButtonTitle

primaryButtonTitle?: string

The title of the primary button displayed at the bottom of the screen. Defaults to "Save Address".

OptionalsheetTitle

sheetTitle?: string

Title displayed at the top of the sheet. Defaults to "Address".

OptionalgooglePlacesApiKey

googlePlacesApiKey?: string

Android only. Google Places api key used to provide autocomplete suggestions. When null, autocomplete is disabled on Android.

onSubmit

onSubmit: (result: Required) => void

Called when the user submits their information

onError

onError: (error: StripeError<AddressSheetError>) => void

Called when the user taps the button to close the sheet before submitting their information, or when an error occurs.

Settings

Member Visibility

On This Page

Properties