IProps | @jupyterlab (original) (raw)

Interface IProps

Interface for CommandToolbarButtonComponent props.

interface IProps {
args?: ReadonlyJSONObject;
caption?: string;
commands: CommandRegistry;
icon?: LabIcon;
id: string;
label?: string | CommandFunc<string>;
noFocusOnClick?: boolean;
}

Index

Properties

args? caption? commands icon? id label? noFocusOnClick?

Properties

Optionalargs

args?: ReadonlyJSONObject

Command arguments

Optionalcaption

caption?: string

Overrides command caption

commands

commands: CommandRegistry

Application commands registry

Optionalicon

icon?: LabIcon

Overrides command icon

id

id: string

Command unique id

Optionallabel

label?: string | CommandFunc<string>

Overrides command label

OptionalnoFocusOnClick

noFocusOnClick?: boolean

Trigger the button on onMouseDown event rather than onClick, to avoid giving the focus on the button.