ComPDFKit Web SDK
    Preparing search index...

    Class CustomElement

    An item rendered by your own function, for content the built-in items cannot express.

    const pageInfo = new instance.UI.Components.CustomElement({
    dataElement: 'pageInfo',
    render: () => {
    const span = document.createElement('span');
    span.textContent = 'Draft';
    return span;
    },
    });
    const header = instance.UI.getModularHeader('default-top-header');
    header.setItems([...header.getItems(), pageInfo]);

    Hierarchy (View Summary)

    Index
    • Creates a custom element.

      Parameters

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

        dataElement and render (required), renderArguments, className, title.

      Returns CustomElement

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

    render: unknown

    Returns the content of the item: an HTMLElement or an HTML string.

    renderArguments?: unknown[]

    Arguments passed to render.

    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.