ButtonConfig

Defined in: packages/core/src/config/ButtonConfig.ts:151

Properties

action?

optional action: ButtonAction

Defined in: packages/core/src/config/ButtonConfig.ts:193

A single action to run when the button is clicked Mutually exclusive with actions

actions?

optional actions: ButtonAction[]

Defined in: packages/core/src/config/ButtonConfig.ts:198

Multiple actions to run when the button is clicked Mutually exclusive with action

backgroundImage?

optional backgroundImage: string

Defined in: packages/core/src/config/ButtonConfig.ts:176

Optional background image to add to the button, needed since you can’t load images from the vault via pure CSS

class?

optional class: string

Defined in: packages/core/src/config/ButtonConfig.ts:167

Optional CSS class to add to the button

cssStyle?

optional cssStyle: string

Defined in: packages/core/src/config/ButtonConfig.ts:171

Optional CSS styles to add to the button

hidden?

optional hidden: boolean

Defined in: packages/core/src/config/ButtonConfig.ts:188

Whether the button is hidden

icon?

optional icon: string

Defined in: packages/core/src/config/ButtonConfig.ts:159

Optional icon to display in front of the label

id?

optional id: string

Defined in: packages/core/src/config/ButtonConfig.ts:184

Optional ID for use in inline buttons

label

label: string

Defined in: packages/core/src/config/ButtonConfig.ts:155

The text displayed on the button

style

style: ButtonStyleType

Defined in: packages/core/src/config/ButtonConfig.ts:163

The style of the button

optional tooltip: string

Defined in: packages/core/src/config/ButtonConfig.ts:180

Optional tooltip to display when hovering over the button