Interface ButtonProps

Properties of a Button component displayed by the toolbar.

interface ButtonProps {
    ariaLabel?: string;
    children?: ReactElement<DropdownButtonChildrenProps>;
    color?:
        | "inherit"
        | "primary"
        | "secondary"
        | "success"
        | "error"
        | "info"
        | "warning";
    disabled?: boolean;
    icon?: ReactNode;
    onClick: () => void;
    size?: number | "small" | "medium" | "large";
    text?: string;
    tooltip?: string;
    variant?: "text" | "outlined" | "contained";
}

Properties

ariaLabel? children? color? disabled? icon? onClick size? text? tooltip? variant?

Properties

OptionalariaLabel

ariaLabel?: string

Aria label.

Optionalchildren

children?: ReactElement<DropdownButtonChildrenProps>

Chidren to be displayed in this button if this button should be a DropdownButton

Optionalcolor

color?:
    | "inherit"
    | "primary"
    | "secondary"
    | "success"
    | "error"
    | "info"
    | "warning"

The button color.

Optionaldisabled

disabled?: boolean

Set to true to disable this button.

Optionalicon

icon?: ReactNode

Icon to be displayed in this button.

onClick

onClick: () => void

Callback that will be called when this button has been clicked.

Optionalsize

size?: number | "small" | "medium" | "large"

Size of this button.

Optionaltext

text?: string

Text to be displayed in this button.

Optionaltooltip

tooltip?: string

A tooltip of this button.

Optionalvariant

variant?: "text" | "outlined" | "contained"

The button variant.

Settings

Member Visibility

On This Page

Properties