ComPDFKit Web SDK
    Preparing search index...

    Class Label

    Text label: label is required; disabled defaults to false.

    Hierarchy (View Summary)

    Index
    • Creates a label.

      Parameters

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

        dataElement and label (required), title, style.

      Returns Label

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

    label: string

    Text of the label, 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.

    type?: string

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