Axinom Mosaic Libraries
    Preparing search index...

    Interface ToggleButtonProps

    interface ToggleButtonProps {
        className?: string;
        confirmationConfig?: ConfirmationConfig;
        confirmationMode?: "None" | "Advanced";
        dataTestId?: string;
        disabled?: boolean;
        error?: string;
        height?: string | number;
        id?: string;
        inlineMode?: boolean;
        label?: string;
        name: string;
        onBlur?: FocusEventHandler<HTMLButtonElement>;
        onButtonClicked?: (
            event: MouseEvent<HTMLButtonElement, MouseEvent>,
            value: boolean,
        ) => void;
        openInNewTab?: undefined;
        path?: undefined;
        showONOFFText?: boolean;
        title?: string;
        tooltipContent?: ReactNode;
        type?: "button" | "submit" | "reset";
        value?: boolean;
        width?: string | number;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    className?: string

    Optional class

    confirmationConfig?: ConfirmationConfig

    Optional text overrides for the confirmation pop up.

    confirmationMode?: "None" | "Advanced"

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

    dataTestId?: string

    Optional data-test-id

    disabled?: boolean

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

    error?: string

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

    height?: string | number

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

    id?: string

    Form control id

    inlineMode?: boolean

    Hide options not needed in the “inline” scenario

    label?: string

    Form control label

    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.

    onBlur?: FocusEventHandler<HTMLButtonElement>
    onButtonClicked?: (
        event: MouseEvent<HTMLButtonElement, MouseEvent>,
        value: boolean,
    ) => void

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

    openInNewTab?: undefined

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

    path?: undefined

    Where to navigate to when the action is clicked.

    showONOFFText?: boolean

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

    title?: string

    Optional title attribute for the button

    tooltipContent?: ReactNode

    A tooltip of additional information

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

    HTML button type attribute (default: 'button')

    value?: boolean

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

    width?: string | number

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

    Settings

    Member Visibility

    On This Page

    Properties