ComPDFKit Web SDK
    Preparing search index...

    Interface UserSettings

    User settings returned by UI.exportUserSettings and accepted by UI.importUserSettings. A disableXxx key set to true means the item is turned off.

    interface UserSettings {
        disableAutoExpandCommentThread: boolean;
        disableClearSearchOnPanelClose: boolean;
        disableFadePageNavigationComponent: boolean;
        disableNativeScrolling: boolean;
        disableNoteSubmissionWithEnter: boolean;
        disablePageDeletionConfirmationModal: boolean;
        disableReplyCollapse: boolean;
        disableTextCollapse: boolean;
        disableThumbnailMultiselect: boolean;
        disableToolDefaultStyleUpdateFromAnnotationPopup: boolean;
        disableViewportRelativePositioning: boolean;
        keyboardShortcut: Record<string, string>;
        language: string;
        theme: string;
    }
    Index
    disableAutoExpandCommentThread: boolean

    Replies in the notes panel are shown only for the selected item, instead of expanded for every item.

    disableClearSearchOnPanelClose: boolean

    Search results are kept when the search panel closes.

    disableFadePageNavigationComponent: boolean

    Page navigation fading is off. Kept with the settings; it does not affect the UI (the page number overlay stays visible).

    disableNativeScrolling: boolean

    Native scrolling on mobile is off. Kept with the settings; it does not affect the UI.

    disableNoteSubmissionWithEnter: boolean

    Pressing Enter in the reply box adds a new line instead of submitting.

    disablePageDeletionConfirmationModal: boolean

    Deleting pages in the page editor does not ask for confirmation.

    disableReplyCollapse: boolean

    Reply collapsing in the notes panel is off. Kept with the settings; it does not affect the notes panel.

    disableTextCollapse: boolean

    Long note collapsing in the notes panel is off. Kept with the settings; it does not affect the notes panel.

    disableThumbnailMultiselect: boolean

    The thumbnails panel is not in multi-select mode (see UI.ThumbnailsPanel.enableMultiSelect). Kept with the settings; it does not affect the thumbnails panel.

    disableToolDefaultStyleUpdateFromAnnotationPopup: boolean

    Style changes made on an annotation are not copied to the tool defaults. Kept with the settings; the style panel follows UI.enableAnnotationToolStyleSyncing instead.

    disableViewportRelativePositioning: boolean

    Pasted annotations keep their page positions instead of following their positions in the viewport.

    keyboardShortcut: Record<string, string>

    Key of each keyboard shortcut, keyed by shortcut name; an empty string means unbound. Importing it replaces the whole map, so shortcuts it does not list are unbound.

    language: string

    Language code of the UI, for example 'en'.

    theme: string

    UI theme: 'light' or 'dark'.