Interface ToggleButtonProps

Hierarchy

Properties

className? confirmationConfig? confirmationMode? dataTestId? disabled? error? height? id? inlineMode? label? name onBlur? onButtonClicked? openInNewTab? path? showONOFFText? tooltipContent? type? value? width?

Properties

Optional className

className?: string

Optional class

Optional confirmationConfig

confirmationConfig?: ConfirmationConfig

Optional text overrides for the confirmation pop up.

Optional confirmationMode

confirmationMode?: "None" | "Advanced"

If set to 'Advanced', action will require confirmation via a confirmation pop up. (default: 'None')

Optional dataTestId

dataTestId?: string

Optional data-test-id

Optional disabled

disabled?: boolean

Whether the button is disabled. If set to true, disallows interactions. (default: undefined)

Optional error

error?: string

If set, indicates the control has an error and will display this prop as the error message

Optional height

height?: string | number

Button's height (default: '50px')

Optional id

id?: string

Form control id

Optional inlineMode

inlineMode?: boolean

Hide options not needed in the “inline” scenario

Optional label

label?: string

Form control label

name

name: string

Name of form control, required and must be unique from other form control names. This name should match the the name of the object corresponding to this control.

Optional onBlur

onBlur?: FocusEventHandler<HTMLButtonElement>

Optional onButtonClicked

onButtonClicked?: ((event, value) => void)

Type declaration

    • (event, value): void

    • Event to raise when the button is clicked. Selected state is return as a second argument

      Parameters

      • event: MouseEvent<HTMLButtonElement, MouseEvent>
      • value: boolean

      Returns void

Optional openInNewTab

openInNewTab?: undefined

If set to true, the link will open in a new tab.

Optional path

path?: undefined

Where to navigate to when the action is clicked.

Optional showONOFFText

showONOFFText?: boolean

Whether the 'OFF'/'ON' text is shown (default: true)

Optional tooltipContent

tooltipContent?: ReactNode

A tooltip of additional information

Optional type

type?: "button" | "reset" | "submit"

HTML button type attribute (default: 'button')

Optional value

value?: boolean

Current value. Can be used to control state (default: false)

Optional width

width?: string | number

Button's width (default: '100px')

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc