ComPDFKit Web SDK
    Preparing search index...

    Class Item

    Base class of the items placed in modular headers, grouped items and flyouts. It cannot be instantiated directly; use one of its subclasses.

    Hierarchy (View Summary)

    Index
    • Sets the options shared by all items (called by subclasses).

      Parameters

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

        Common options: dataElement, title, disabled, style, className and hidden.

      Returns Item

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

    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.