ComPDFKit Web SDK
    Preparing search index...

    Class ToggleElementButton

    A button that opens or closes another UI element (a panel, flyout or overlay) when clicked.

    const notesToggle = new instance.UI.Components.ToggleElementButton({
    dataElement: 'notesToggleButton',
    toggleElement: instance.UI.Panels.NOTES,
    img: 'Annotation', // a built-in icon name
    title: 'Comments',
    });
    const header = instance.UI.getModularHeader('default-top-header');
    header.setItems([...header.getItems(), notesToggle]);

    Hierarchy (View Summary)

    • Item
      • ToggleElementButton
    Index
    • Replaces the inline CSS styles of the item and updates it on screen when it is already in the UI.

      Parameters

      • style: Record<string, unknown>

        CSS property names (camelCase) mapped to their values.

      Returns void

    className?: string

    Extra CSS class names added to the item's element.

    dataElement: string

    Unique name of the item; used to find, show, hide or update it later.

    disabled?: boolean

    Whether the item is disabled (rendered but not clickable).

    hidden?: boolean | string[]

    Hides the item: true always hides it; an array of screen sizes ('desktop', 'tablet', 'mobile', 'small-mobile') hides it only on those screen sizes.

    img?: string

    Icon of the button: an icon name, an image URL or inline SVG markup.

    label?: string

    Text shown on the button, or a translation key.

    style?: Record<string, unknown>

    Inline CSS styles applied to the item's element.

    title?: string

    Tooltip text, or a translation key that is resolved in the current language.

    toggleElement?: string

    dataElement of the element the button opens and closes.

    type?: string

    Item type (for example 'customButton', 'toolButton', 'divider'); set by each subclass.