Type alias AcceptTermsProps

AcceptTermsProps: {
    componentProps?: ViewProps;
    disableContainerPadding?: boolean;
    forceView?: "ios" | "android";
    resultsCallback: ((result) => void);
    source: DocumentViewerSource;
    style?: StyleProp<ViewStyle>;
    textStrings: {
        agree: string;
        disagree: string;
        modalBody: string;
        modalPrimaryAction: string;
        modalSecondaryAction: string;
        modalTitle: string;
    };
    title: string;
}

Props for AcceptTerms component

Type declaration

  • Optional componentProps?: ViewProps

    Direct props to set on the React Native component (including iOS and Android specific props). Most use cases should not need this.

  • Optional disableContainerPadding?: boolean

    Disable padding (useful for loading websites)

  • Optional forceView?: "ios" | "android"

    Force the view (mostly for teting) to a specific platform

  • resultsCallback: ((result) => void)
      • (result): void
      • Callback when flow finishes. Returns success variable indicating if user accepted or refused the terms

        Parameters

        • result: boolean

        Returns void

  • source: DocumentViewerSource

    Content to render (supports HTML (text or URL) and plain text)

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • textStrings: {
        agree: string;
        disagree: string;
        modalBody: string;
        modalPrimaryAction: string;
        modalSecondaryAction: string;
        modalTitle: string;
    }

    Text strings needed for the flow

    • agree: string

      Agree action on toolbar. Ex: "Agree"

    • disagree: string

      Disagree action on toolbar. Ex: "Disagree"

    • modalBody: string

      Popup body for disagreeing. Ex: "The use of this app requires agreement to the Terms and Conditions."

    • modalPrimaryAction: string

      Popup primary option for disagreeing. Ex: "Continue"

    • modalSecondaryAction: string

      Popup seondary option for disagreeing. Ex: "Disagree"

    • modalTitle: string

      Popup title for disagreeing. Ex: "Are you sure?"

  • title: string

    Title of text document

Generated using TypeDoc