@hmiproject/helio-sdk
    Preparing search index...

    Type Alias ButtonProps

    type ButtonProps = {
        ariaLabel?: string;
        autoFocus?: boolean;
        checked?: boolean;
        children?: ReactNode;
        className?: string;
        destructive?: boolean;
        disabled?: boolean;
        leftItems?: ReactNode;
        rightItems?: ReactNode;
        variant?: ButtonVariant;
        onClick?(event?: MouseEvent<Element, MouseEvent>): void;
        onClick?(event: UIEvent): void;
    }
    Index

    Properties

    ariaLabel? autoFocus? checked? children? className? destructive? disabled? leftItems? rightItems? variant?

    Methods

    onClick?

    Properties

    ariaLabel?: string

    Provide an accessible name for screen readers. Use this when the button shows no visible text — e.g. an icon-only button. On a button with visible text, prefer omitting it.

    `Save document`
    autoFocus?: boolean

    Automatically focus the button when it is rendered to the UI

    checked?: boolean

    Display the button as checked (i.e. pressed in)

    children?: ReactNode
    className?: string

    Optional CSS class name

    className

    destructive?: boolean
    false
    disabled?: boolean
    false
    leftItems?: ReactNode

    Items to display in the left slot

    rightItems?: ReactNode

    Items to display in the right slot

    variant?: ButtonVariant
    'secondary'

    Methods

    • Parameters

      • Optionalevent: MouseEvent<Element, MouseEvent>

      Returns void

    • Parameters

      • event: UIEvent

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods