ComPDFKit Web SDK
    Preparing search index...

    Function exportModularComponents

    • Exports the modular UI data of this viewer. The result is JSON-serializable and can be passed to importModularComponents as is. Functions are written as their names in the function map given to importModularComponents (functions not in it are left out with a warning); disabled items get disabled: true; the viewer's built-in flyouts are skipped.

      Returns {
          flyouts: Record<string, Partial<FlyoutData>>;
          modularComponents: Record<string, Partial<ModularComponent>>;
          modularHeaders: Record<string, Partial<ModularHeaderData>>;
          panels: Record<string, Partial<PanelData>>;
          popups: Record<string, PopupItem[]>;
      }

      The modular UI data.

      • flyouts: Record<string, Partial<FlyoutData>>

        Flyouts keyed by dataElement.

      • modularComponents: Record<string, Partial<ModularComponent>>

        Components (buttons, groups, dividers and so on) keyed by dataElement.

      • modularHeaders: Record<string, Partial<ModularHeaderData>>

        Headers keyed by dataElement.

      • panels: Record<string, Partial<PanelData>>

        Panels keyed by dataElement.

      • popups: Record<string, PopupItem[]>

        Items of each popup, keyed by popup dataElement.

      const json = JSON.stringify(instance.UI.exportModularComponents(), null, 2);