• Frontend Script API
• <internal>
• AddToToolbarOpts

Interface AddToToolbarOpts

An instance of the frontend api available globally.

Global

Var

api

interface AddToToolbarOpts {
action: () => void;
icon: string;
id: string;
shortcut: string;
title: string;
}

Index

Properties

actioniconidshortcuttitle

Properties

action

action: () => void

callback handling the click on the button

icon

icon: string

name of the boxicon to be used (e.g. "time" for "bx-time" icon)

id

id: string

id of the button, used to identify the old instances of this button to be replaced ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.

shortcut

shortcut: string

keyboard shortcut for the button, e.g. "alt+t"

title

title: string

Settings

Member Visibility

• Protected
• Inherited
• External

ThemeOSLightDark

On This Page

Properties actioniconidshortcuttitle