ComPDFKit Web SDK
    Preparing search index...

    Function importUserSettings

    • Imports user settings; only the given items change. keyboardShortcut replaces the whole key map; shortcuts it does not list are unbound (set to an empty string). UI.hotkeys and key presses then follow the new map.

      Parameters

      • 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;
        }

        The user settings, as returned by exportUserSettings.

        • OptionaldisableAutoExpandCommentThread?: boolean

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

        • OptionaldisableClearSearchOnPanelClose?: boolean

          Search results are kept when the search panel closes.

        • OptionaldisableFadePageNavigationComponent?: boolean

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

        • OptionaldisableNativeScrolling?: boolean

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

        • OptionaldisableNoteSubmissionWithEnter?: boolean

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

        • OptionaldisablePageDeletionConfirmationModal?: boolean

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

        • OptionaldisableReplyCollapse?: boolean

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

        • OptionaldisableTextCollapse?: boolean

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

        • OptionaldisableThumbnailMultiselect?: 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.

        • OptionaldisableToolDefaultStyleUpdateFromAnnotationPopup?: 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.

        • OptionaldisableViewportRelativePositioning?: boolean

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

        • OptionalkeyboardShortcut?: 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.

        • Optionallanguage?: string

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

        • Optionaltheme?: string

          UI theme: 'light' or 'dark'.

      Returns void