ComPDF React Native - v3.0.0
    Preparing search index...

    Interface CPDFReaderViewConfig

    interface CPDFReaderViewConfig {
        linkHighlight?: boolean;
        formFieldHighlight?: boolean;
        displayMode?: string;
        continueMode?: boolean;
        verticalMode?: boolean;
        cropMode?: boolean;
        themes?: string;
        enableSliderBar?: boolean;
        enablePageIndicator?: boolean;
        pageSpacing?: number;
        margins?: number[];
        pageScale?: number;
        pageSameWidth?: boolean;
        annotationsVisible?: boolean;
        enableCreateEditTextInput?: boolean;
        enableCreateImagePickerDialog?: boolean;
        enableDoubleTapZoom?: boolean;
        accessibilityConfig?: CPDFAccessibilityConfig;
        uiStyle?: CPDFUIStyle;
    }
    Index

    Properties

    linkHighlight? formFieldHighlight? displayMode? continueMode? verticalMode? cropMode? themes? enableSliderBar? enablePageIndicator? pageSpacing? margins? pageScale? pageSameWidth? annotationsVisible? enableCreateEditTextInput? enableCreateImagePickerDialog? enableDoubleTapZoom? accessibilityConfig? uiStyle?

    Properties

    linkHighlight?: boolean

    Sets whether hyperlinks in the PDF document annotations are highlighted.

    formFieldHighlight?: boolean

    Sets whether form fields in the PDF document are highlighted.

    displayMode?: string

    Display mode of the PDF document, single page, double page, or book mode. Default: CPDFDisplayMode.SINGLE_PAGE

    continueMode?: boolean

    Whether PDF page flipping is continuous scrolling.

    verticalMode?: boolean

    Whether scrolling is in vertical direction. true: Vertical scrolling, false: Horizontal scrolling. Default: true

    cropMode?: boolean

    Cropping mode. Whether to crop blank areas of PDF pages. Default: false

    themes?: string

    Theme color. Default: CPDFThemes.LIGHT

    enableSliderBar?: boolean

    Whether to display the sidebar quick scroll bar.

    enablePageIndicator?: boolean

    Whether to display the bottom page indicator.

    pageSpacing?: number

    Spacing between each page of the PDF, default 10px.

    margins?: number[]

    Sets the outer margins for the PDF reading view.

    • index 0: margin left
    • index 1: margin top
    • index 2: margin right
    • index 3: margin bottom

    Default: [0,0,0,0]

    pageScale?: number

    Page scale value, default 1.0.

    pageSameWidth?: boolean

    only android platform.

    annotationsVisible?: boolean

    Sets whether to display annotations in the PDF document.

    enableCreateEditTextInput?: boolean

    In content editing mode, when only text editing is selected, whether to enable creating a text input box by clicking the page area. Default value: true

    enableCreateImagePickerDialog?: boolean

    In content editing mode, when only image editing is selected, whether to enable creating an image picker dialog by clicking the page area. Default value: true

    enableDoubleTapZoom?: boolean

    Sets whether to enable double-tap zooming in the PDF document. Default value: true

    accessibilityConfig?: CPDFAccessibilityConfig

    Accessibility configuration for hardware keyboard navigation and TalkBack.

    Since v3.0.0, this configuration is currently only effective on Android.

    uiStyle?: CPDFUIStyle

    UI style customizations for various interactive elements in the reader view. Use this to customize colors, icons and border styles for selections, screenshots, form previews, cropping and other visual helpers.

    Settings

    Member Visibility

    On This Page

    Properties