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

    Module index

    Classes

    CPDFReplyAnnotation

    A reply attached to a PDF annotation.

    CPDFTextStamp

    Copyright © 2014-2026 PDF Technologies, Inc. All Rights Reserved.

    CPDFFontName

    A font family and its available style names.

    CPDFPageSize
    CPDFTextLine
    CPDFTextRange

    Copyright © 2014-2026 PDF Technologies, Inc. All Rights Reserved.

    CPDFTextSearcher
    CPDFDateUtil

    Utility class for date and time formatting, specifically for CPDFTextStamp.

    CPDFImageData

    Represents different types of image data for inserting into PDF.

    CPDFWidgetUtil

    Copyright © 2014-2026 PDF Technologies, Inc. All Rights Reserved.

    Interfaces

    CPDFTextAttribute

    CPDFTextAttribute This class is used to represent text attributes, including color, font name, font size, bold and italic, etc.

    CPDFAnnotationRenderOptions
    CPDFEventDataMap

    Event data type mapping for type-safe event listeners

    CPDFSearchBackButtonTappedEvent
    CPDFAnnotationStyleDialogDismissedEvent
    CPDFFormStyleDialogDismissedEvent
    CPDFContentEditorStyleDialogDismissedEvent
    CPDFBorderStyleAttr
    CPDFTextAttr

    Attribute configuration for text (note) annotations.

    CPDFMarkupAttr

    Attribute configuration for markup annotations (e.g. highlight).

    CPDFHighlightAttr

    Attribute configuration for markup annotations (e.g. highlight).

    CPDFUnderlineAttr

    Attribute configuration for markup annotations (e.g. highlight).

    CPDFStrikeoutAttr

    Attribute configuration for markup annotations (e.g. highlight).

    CPDFSquigglyAttr

    Attribute configuration for markup annotations (e.g. highlight).

    CPDFInkAttr

    Attribute configuration for ink annotations.

    CPDFSquareAttr

    Attribute configuration for square annotations.

    CPDFCircleAttr

    Attribute configuration for circle annotations.

    CPDFLineAttr

    Attribute configuration for straight line annotations.

    CPDFArrowAttr

    Attribute configuration for arrow annotations.

    CPDFFreeTextAttr

    Attribute configuration for free text annotations.

    CPDFAnnotationAttr
    CPDFTextFieldAttr

    Attributes for a text field widget used in PDF forms.

    CPDFCheckBoxAttr

    Attributes for a checkbox widget used in PDF forms.

    CPDFRadioButtonAttr

    Attributes for a radio button widget used in PDF forms.

    CPDFListBoxAttr

    Attributes for a list box widget used in PDF forms.

    CPDFComboBoxAttr

    Attributes for a combo box (drop-down) widget used in PDF forms.

    CPDFPushButtonAttr

    Attributes for a push button widget used in PDF forms.

    CPDFSignatureWidgetAttr

    Attributes for a signature widget area used in PDF forms.

    CPDFWidgetAttr
    CPDFEditorTextAttr
    CPDFUIStyle

    Top-level UI style configuration for reader view elements.

    CPDFUIIcons
    CPDFUIBorderStyle
    CPDFUIDashBorderStyle
    CPDFUIFormPreview
    CPDFUIFocusStyle
    CPDFToolbarItem

    Configuration for a custom toolbar item. You can use this to add custom buttons to the toolbar.

    CPDFBookmark
    CPDFDestination
    CPDFDocumentPermissionInfo

    Copyright © 2014-2026 PDF Technologies, Inc. All Rights Reserved.

    CPDFFontNameProps

    Properties describing an imported or available PDF font.

    CPDFInfo

    Interface representing metadata information of a PDF document. Contains standard PDF document properties according to PDF specification.

    CPDFOutline

    Type Aliases

    CPDFViewMode
    CPDFToolbarAction

    Toolbar actions supported in the displayed PDF view

    CPDFAnnotationType

    annotations type. Please note that PENCIL is only available on ios platform.

    CPDFConfigTool

    CPDFViewMode.ANNOTATIONS, CPDFViewMode.CONTENT_EDITOR,CPDFViewMode.FORMS function tools. CPDFConfigTool.SETTING is not available in form functionality.

    CPDFBorderStyle
    CPDFLineType

    Arrow annotation, start and tail shapes

    CPDFAlignment

    text alignment

    CPDFContentEditorType
    CPDFWidgetType

    form types

    CPDFCheckStyle
    CPDFDisplayMode
    CPDFThemes
    CPDFThemeMode

    Set UI theme modes, including light, dark, and follow system modes Default: Follow system

    CPDFDocumentPermissions

    Represents the permissions available for the currently opened document.

    CPDFDocumentEncryptAlgo

    Specifies the encryption algorithms supported for a PDF document.

    CPDFBorderEffectType
    CPDFActionType
    CPDFSignatureType

    Used to configure the default signing method when signing in the form field of CPDFReaderView, including: digital signature, electronic signature, and manual selection

    CPDFUiVisibilityMode
    CPDFBotaTabs
    CPDFPageCompression
    CPDFEditType
    CPDFStandardStamp
    CPDFStampType
    CPDFEvent
    CPDFPrepareNextStampOptions
    AnyCase
    ValueOf
    CPDFAnnotationAttrUnion
    CPDFWidgetAttrUnion
    Padding

    Fixed-length padding tuple: [left, top, right, bottom]

    CPDFContextMenuItem

    Menu item type with optional sub-items. Use readonly arrays to encourage immutability.

    CommonAnnotationAction

    Common actions reused across multiple annotation menus

    Global

    ViewTextSelectKey

    View mode

    AnnotationTextSelectKey

    Annotation mode

    MarkupContentKey
    SoundContentKey
    InkContentKey
    ShapeContentKey
    FreeTextContentKey
    SignStampContentKey
    StampContentKey
    LinkContentKey
    LongPressContentKey
    EditTextAreaContentKey

    Content editor mode

    EditSelectTextContentKey
    EditTextContentKey
    ImageAreaContentKey

    Image area content

    ImageCropModeKey

    Crop mode

    EditPathContentKey

    Path in editor

    LongPressWithEditTextModeKey

    Long press in edit text mode

    LongPressWithEditImageModeKey

    Long press in edit image mode (typo-compatible)

    LongPressWithAllModeKey

    Long press for all modes (typo-compatible)

    SearchReplaceKey

    Search replace

    FormPropertiesDeleteKey

    Form mode keys

    FormOptionsPropertiesDeleteKey
    SignatureFieldKey
    CPDFBotaMenuItem
    CPDFContextMenuItemInput
    CPDFExtractImageResult

    Result returned when images are extracted from a PDF document.

    CPDFWatermarkType
    CPDFWatermarkVerticalAlignment
    CPDFWatermarkHorizontalAlignment
    CPDFWatermark
    CPDFTextLineJson
    CPDFRectF

    Copyright © 2014-2026 PDF Technologies, Inc. All Rights Reserved.

    Functions

    Helper function to create context menu items with default showType.

    botaMenus

    Helper function to create BOTA menu items.

    createTextWatermark
    createImageWatermark
    copyWatermark
    fromNativeWatermark
    toNativeWatermark

    Annotations

    CPDFAnnotation

    CPDFAnnotation

    CPDFCircleAnnotation

    CPDFCircleAnnotation

    CPDFFreeTextAnnotation

    CPDFFreeTextAnnotation

    CPDFImageAnnotation

    CPDFImageAnnotation

    CPDFInkAnnotation

    CPDFInkAnnotation

    CPDFLineAnnotation

    CPDFLineAnnotation

    CPDFLinkAnnotation

    CPDFLinkAnnotation

    CPDFMarkupAnnotation

    markup annotation class, highlight, underline, squiggly, strikeout CPDFMarkupAnnotation

    CPDFHighlightAnnotation

    markup annotation class, highlight, underline, squiggly, strikeout CPDFMarkupAnnotation

    CPDFUnderlineAnnotation

    markup annotation class, highlight, underline, squiggly, strikeout CPDFMarkupAnnotation

    CPDFSquigglyAnnotation

    markup annotation class, highlight, underline, squiggly, strikeout CPDFMarkupAnnotation

    CPDFStrikeOutAnnotation

    markup annotation class, highlight, underline, squiggly, strikeout CPDFMarkupAnnotation

    CPDFNoteAnnotation

    CPDFNoteAnnotation

    CPDFSignatureAnnotation

    CPDFSignatureAnnotation

    CPDFSoundAnnotation

    CPDFSoundAnnotation

    CPDFSquareAnnotation

    CPDFSquareAnnotation

    CPDFStampAnnotation

    CPDFStampAnnotation

    CPDFAnnotationHistoryManager

    Manages the undo and redo history for PDF annotation actions within a viewer component.

    Configuration

    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.

    CPDFAnnotationConfig

    CPDFAnnotationConfig

    CPDFContentEditorConfig

    CPDFContentEditorConfig

    CPDFContextMenuConfig

    Context menu configuration interface. Used to customize long-press menu options in different modes. For example, selecting a highlight annotation in annotation mode, or long-pressing a blank area in text editing mode.

    CPDFFormConfig

    CPDFFormConfig

    CPDFGlobalConfig

    CPDFGlobalConfig

    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.

    CPDFAccessibilityConfig

    Accessibility configuration for the reader view.

    CPDFReaderViewConfig
    CPDFToolbarConfig

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

    CPDFWatermarkConfig

    Global watermark configuration.

    Core

    getDefaultConfig

    Creates the default reader configuration and applies the provided overrides. The returned value is a JSON string accepted by CPDFReaderView.

    Document

    CPDFDocument

    Provides document-level operations for the PDF reader.

    CPDFAction

    Base model for actions attached to PDF annotations and links.

    CPDFGoToAction

    Base model for actions attached to PDF annotations and links.

    CPDFUriAction

    Base model for actions attached to PDF annotations and links.

    Edit

    CPDFEditArea

    Base model for a content-editor area on a PDF page.

    CPDFEditImageArea

    Base model for a content-editor area on a PDF page.

    CPDFEditManager

    Controls content-editor modes and editing history for the current reader.

    CPDFEditTextArea

    Base model for a content-editor area on a PDF page.

    CPDFEditorHistoryManager

    Manages the history of editing actions within a PDF document, allowing for undo and redo operations. This class extends the CPDFHistoryManagerBase and provides methods to interact with the native PDF view.

    Enumerations

    CPDFAnnotationMarkState
    CPDFAnnotationReviewState
    CPDFTextStampShape
    CPDFTextStampColor
    CPDFSearchOptions

    Copyright © 2014-2026 PDF Technologies, Inc. All Rights Reserved.

    CPDFImageType

    Enumeration of supported image data types for inserting into PDF

    Forms

    CPDFCheckboxWidget

    Class representing a checkbox form widget, storing basic information about the checkbox form.

    CPDFComboboxWidget

    Class representing a combobox form widget, storing basic information about the combobox form.

    CPDFListboxWidget

    Class representing a listbox form widget, storing basic information about the listbox form.

    CPDFPushbuttonWidget

    A class representing a push button form widget, storing basic information about the button form.

    CPDFRadiobuttonWidget

    Class representing a radiobutton form widget, storing basic information about the radiobutton form.

    CPDFSignatureWidget

    Class representing a signature form widget, storing basic information about the signature form. It includes general form attributes as well as the signature content.

    CPDFTextWidget

    Class representing a text field form widget, storing basic information about the text field form. It includes general form attributes as well as the text content of the text field.

    CPDFWidget

    Base class for form widgets, storing essential form information.

    CPDFWidgetItem

    Page

    CPDFPage

    CPDFPage The CPDFPage class represents a page in a PDF document. It provides methods to retrieve annotations and form widgets present on the page.

    Utilities

    CPDFImageUtil

    Image conversion and image-data helpers used by annotation APIs.

    Variables

    CPDFViewMode
    CPDFToolbarAction

    Toolbar actions supported in the displayed PDF view

    CPDFAnnotationType

    annotations type. Please note that PENCIL is only available on ios platform.

    CPDFConfigTool

    CPDFViewMode.ANNOTATIONS, CPDFViewMode.CONTENT_EDITOR,CPDFViewMode.FORMS function tools. CPDFConfigTool.SETTING is not available in form functionality.

    CPDFBorderStyle
    CPDFLineType

    Arrow annotation, start and tail shapes

    CPDFAlignment

    text alignment

    CPDFContentEditorType
    CPDFWidgetType

    form types

    CPDFCheckStyle
    CPDFDisplayMode
    CPDFThemes
    CPDFThemeMode

    Set UI theme modes, including light, dark, and follow system modes Default: Follow system

    CPDFDocumentPermissions

    Represents the permissions available for the currently opened document.

    CPDFDocumentEncryptAlgo

    Specifies the encryption algorithms supported for a PDF document.

    CPDFBorderEffectType
    CPDFActionType
    CPDFSignatureType

    Used to configure the default signing method when signing in the form field of CPDFReaderView, including: digital signature, electronic signature, and manual selection

    CPDFUiVisibilityMode
    CPDFBotaTabs
    CPDFPageCompression
    CPDFEditType
    CPDFStandardStamp
    CPDFStampType
    CPDFEvent
    ComPDFKit
    PDFReaderContext
    default → PDFReaderContext

    Viewer

    CPDFReaderViewProps

    Props used to configure and observe the native PDF reader view.

    CPDFReaderView

    Native PDF reader component for viewing and editing a document.