@stripe/stripe-react-native/lib/typescript/src/components/AddressSheet.d.ts

Stripe SDK for React Native

import { AccessibilityProps } from 'react-native';
import type { PaymentSheet, AddressDetails, StripeError, AddressSheetError } from '../types';
/**
 *  Props
 */
export interface Props extends AccessibilityProps {
    /** Whether the sheet is visible. Defaults to false. */
    visible: boolean;
    /** Controls how the modal is presented (after animation). iOS only. Defaults to `popover`. See https://developer.apple.com/documentation/uikit/uimodalpresentationstyle for more info. */
    presentationStyle?: 'fullscreen' | 'popover' | 'pageSheet' | 'formSheet' | 'automatic' | 'overFullScreen';
    /** Controls how the modal animates. iOS only. */
    animationStyle?: 'flip' | 'curl' | 'slide' | 'dissolve';
    /** Configuration for the look and feel of the UI. */
    appearance?: PaymentSheet.AppearanceParams;
    /** The values to prepopulate the sheet's fields with. */
    defaultValues?: AddressDetails;
    /** Configuration for additional fields besides the physical address */
    additionalFields?: {
        /** Determines whether the phone number is hidden, required, or optional. Defaults to hidden. */
        phoneNumber?: 'hidden' | 'optional' | 'required';
        /** The label of a checkbox displayed below other fields. If null or undefined, the checkbox is not displayed. */
        checkboxLabel?: 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. */
    allowedCountries?: Array<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. */
    autocompleteCountries?: Array<string>;
    /** The title of the primary button displayed at the bottom of the screen. Defaults to "Save Address". */
    primaryButtonTitle?: string;
    /** Title displayed at the top of the sheet. Defaults to "Address". */
    sheetTitle?: string;
    /** Android only. Google Places api key used to provide autocomplete suggestions. When null, autocomplete is disabled on Android. */
    googlePlacesApiKey?: string;
    /** Called when the user submits their information */
    onSubmit: (result: CollectAddressResult) => void;
    /** Called when the user taps the button to close the sheet before submitting their information, or when an error occurs. */
    onError: (error: StripeError<AddressSheetError>) => void;
}
export declare type CollectAddressResult = Required<AddressDetails>;
/**
 *
 *
 * @example
 * ```ts
 *  <AddressSheet
 *
 *  />
 * ```
 * @param __namedParameters Props
 * @returns JSX.Element
 * @category ReactComponents
 */
export declare function AddressSheet({ onSubmit, onError, ...props }: Props): JSX.Element;