Type alias DocumentViewerProps

DocumentViewerProps: {
    componentProps?: ViewProps;
    disableContainerPadding?: boolean;
    disableScrollView?: boolean;
    dismissText?: string;
    forceView?: "ios" | "android";
    navigationFooter?: React.ReactNode;
    onDismiss?: (() => void);
    renderChildComponent?: React.ReactNode;
    source?: DocumentViewerSource;
    sourceNode?: React.ReactNode;
    style?: StyleProp<ViewStyle>;
    title: string;
}

Props for DocumentViewer 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 disableScrollView?: boolean

    Force no scroll view for sourceNode

  • Optional dismissText?: string

    On dismiss accessibility or visible text (iOS is visible, Android is accessibility). Defaults to ENGLISH "Done"

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

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

  • Optional navigationFooter?: React.ReactNode

    Navigation footer to load in the document viewer (used mostly by other flows)

  • Optional onDismiss?: (() => void)
      • (): void
      • Callback when the view is dismissed (if not set will not render close option)

        Returns void

  • Optional renderChildComponent?: React.ReactNode

    Render children component into the document viewer. This is useful for rendering a modal within here.

  • Optional source?: DocumentViewerSource

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

  • Optional sourceNode?: React.ReactNode

    Content to render as React Nodes. If set source is not used. Content is automatically wrapped in a ScrollView.

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • title: string

    Title of text document

Generated using TypeDoc