Interface ApplicationHeaderControlsEntry

interface ApplicationHeaderControlsEntry {
    action: string;
    icon: string;
    label: string;
    onClick?: (event: PointerEvent) => void | Promise<void>;
    ownership?: DocumentOwnershipLevel;
    visible?: boolean | () => boolean;
}

Properties

action icon label onClick? ownership? visible?

Properties

action

action: string

The action name triggered by clicking the control button

icon

icon: string

A font-awesome icon class which denotes the control button

label

label: string

The text label for the control button. This label will be automatically localized when the button is rendered

OptionalonClick

onClick?: (event: PointerEvent) => void | Promise<void>

A custom click handler function. Asynchronous functions are not awaited.

Optionalownership

ownership?: DocumentOwnershipLevel

A key or value in CONST.DOCUMENT_OWNERSHIP_LEVELS that restricts visibility of this option for the current user. This option only applies to DocumentSheetV2 instances.

Optionalvisible

visible?: boolean | () => boolean

Is the control button visible for the current client?

Settings

Member Visibility

On This Page

Properties