ComPDFKit Web SDK
    Preparing search index...

    Class ToolGroupToggleButton

    Tool group toggle button: shouldToggleVisibility defaults to true; onClick is only present when given.

    Hierarchy (View Summary)

    • Item
      • ToolGroupToggleButton
    Index
    • Creates a tool group toggle button.

      Parameters

      • props: { [x: string]: unknown }

        dataElement, groupedItems, label, img, title, onClick, color, isActive, shouldToggleVisibility.

      Returns ToolGroupToggleButton

    • 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.

    color?: string

    Icon color of the button.

    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).

    groupedItems?: string

    dataElement of the grouped items the button shows and hides.

    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.

    isActive?: boolean

    Whether the button is shown as active.

    label?: string

    Text shown on the button, or a translation key.

    onClick?: unknown

    Called when the button is clicked.

    shouldToggleVisibility: boolean

    Whether clicking the button toggles the visibility of the grouped items; true by default.

    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.

    type?: string

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