Function Button

Parameters

• props: ButtonProps

  • OptionalariaLabel?: 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.

    Example

    `Save document`
    Copy

  • OptionalautoFocus?: boolean

    Automatically focus the button when it is rendered to the UI

  • Optionalchecked?: boolean

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

  • Optionalchildren?: ReactNode

  • OptionalclassName?: string

    Optional CSS class name

    See

    className

  • Optionaldestructive?: boolean

    Default

    false
    Copy

  • Optionaldisabled?: boolean

    Default

    false
    Copy

  • OptionalleftItems?: ReactNode

    Items to display in the left slot

  • OptionalrightItems?: ReactNode

    Items to display in the right slot

  • Optionalvariant?: ButtonVariant

    Default

    'secondary'
    Copy

  • onClick?: function

    • onClick?(event?: MouseEvent<Element, MouseEvent>): void

      Parameters

      • Optionalevent: MouseEvent<Element, MouseEvent>

      Returns void

    • onClick?(event: UIEvent): void

      Parameters

      • event: UIEvent

      Returns void