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

    Interface CPDFConfiguration

    PDF configuration class for customizing display and interaction via ComPDFKit.openDocument. Supports flexible customization of UI elements, PDF properties, toolbars, annotations, forms, content editing, etc.

    const configuration: CPDFConfiguration = {
      modeConfig: {
        initialViewMode: CPDFModeConfig.ViewMode.VIEWER,
        availableViewModes: [
          CPDFModeConfig.ViewMode.VIEWER,
          CPDFModeConfig.ViewMode.ANNOTATIONS,
          CPDFModeConfig.ViewMode.CONTENT_EDITOR,
          CPDFModeConfig.ViewMode.FORMS,
          CPDFModeConfig.ViewMode.SIGNATURES
        ]
      }
    };

    ComPDFKit.openDocument(document, 'password', JSON.stringify(configuration));

    CPDFReaderView(
     configuration={ComPDFKit.getDefaultConfig({
                  modeConfig: {
                     initialViewMode: CPDFViewMode.ANNOTATIONS,
                     uiVisibilityMode: "automatic",
                   },
                   toolbarConfig: {
                     annotationToolbarVisible: false,
                   },
                 })}
    );
    interface CPDFConfiguration {
        modeConfig?: CPDFModeConfig;
        toolbarConfig?: CPDFToolbarConfig;
        annotationsConfig?: CPDFAnnotationConfig;
        contentEditorConfig?: CPDFContentEditorConfig;
        formsConfig?: CPDFFormConfig;
        readerViewConfig?: CPDFReaderViewConfig;
        global?: CPDFGlobalConfig;
        contextMenuConfig?: CPDFContextMenuConfig;
    }
    Index

    Properties

    modeConfig? toolbarConfig? annotationsConfig? contentEditorConfig? formsConfig? readerViewConfig? global? contextMenuConfig?

    Properties

    modeConfig?: CPDFModeConfig

    PDF mode configuration. Used to set initial and available view modes (reading, annotation, content editing, forms, signatures, etc.), as well as behaviors like auto fullscreen and toolbar visibility.

    toolbarConfig?: CPDFToolbarConfig

    Configuration for the top toolbar and bottom toolbars in different modes.

    annotationsConfig?: CPDFAnnotationConfig

    Annotation configuration. Defines available annotation types, tools, and default properties in annotation mode.

    contentEditorConfig?: CPDFContentEditorConfig

    Content editor mode configuration. Sets editing tools, types, and default properties for content editing mode.

    formsConfig?: CPDFFormConfig

    Form configuration. Customizes form filling and field properties.

    readerViewConfig?: CPDFReaderViewConfig

    PDF view configuration. Sets page layout, scroll direction, theme color, etc.

    global?: CPDFGlobalConfig

    Global configuration. Sets global features such as theme mode, watermark, error prompts, etc.

    contextMenuConfig?: CPDFContextMenuConfig

    Context menu configuration. Customizes context menu options for annotations, forms, text, etc. in various modes.

    Settings

    Member Visibility

    On This Page

    Properties