Type Alias HeaderButton
alignLeft?: boolean;
class?: string;
icon?: string;
keepMinimized?: boolean;
keyCode?: string;
label?: string;
onContextMenu?: HeaderButtonCallback;
onPress?: HeaderButtonCallback;
styles?: { [key: string]: string };
svelte?: Embed;
tooltipDirection?: string;
}
Properties
OptionalalignLeft
When true, the button is left aligned after the window title.
Optionalclass
Additional CSS class to add to the header button.
Optionalicon
Icon class identifier.
OptionalkeepMinimized
Keep the header button visible when the app is minimized.
OptionalkeyCode
Defines the KeyboardEvent 'code' that activates the button.
Optionallabel
Text label or language key to associate with button; used for tooltip.
OptionalonContextMenu
Callback when context menu activated. You may modify and return the button data to update it.
OptionalonPress
Callback when pressed. You may modify and return the button data to update it.
Optionalstyles
Hyphen case CSS property key / value object of properties to add as additional inline CSS styles to the button.
Optionalsvelte
You may load a custom Svelte component into the header to replace a button.
Note: supports just class, props definition.
OptionaltooltipDirection
Tooltip direction; valid options include: UP, DOWN, LEFT, RIGHT, CENTER.
Defines the application header button data handled in SvelteApp._getHeaderButtons and associated
getApplicationHeaderButtonshooks. SvelteApp extends the header button data from !ApplicationHeaderButton bringing an expanded feature set.