Interface RadioToggleCardProps

interface RadioToggleCardProps {
    about?: string;
    accessKey?: string;
    action?: Ref<ButtonBaseActions>;
    active: boolean;
    activeState?: "active" | "warning";
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?:
        | "none"
        | "list"
        | "both"
        | "inline";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?:
        | boolean
        | "mixed"
        | "false"
        | "true";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?:
        | boolean
        | "page"
        | "time"
        | "step"
        | "false"
        | "true"
        | "location"
        | "date";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?:
        | "link"
        | "none"
        | "copy"
        | "move"
        | "execute"
        | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?:
        | boolean
        | "menu"
        | "grid"
        | "dialog"
        | "listbox"
        | "false"
        | "true"
        | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?:
        | boolean
        | "false"
        | "true"
        | "grammar"
        | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "assertive" | "polite" | "off";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?:
        | boolean
        | "mixed"
        | "false"
        | "true";
    aria-readonly?: Booleanish;
    aria-relevant?:
        | "all"
        | "text"
        | "additions"
        | "additions removals"
        | "additions text"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?:
        | "none"
        | "other"
        | "ascending"
        | "descending";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    autoCapitalize?:
        | string & {}
        | "none"
        | "on"
        | "off"
        | "sentences"
        | "words"
        | "characters";
    autoCorrect?: string;
    autoFocus?: boolean;
    autoSave?: string;
    boxProps?: Partial<Record<
        | "margin"
        | "padding"
        | "p"
        | "marginBlockEnd"
        | "marginBlockStart"
        | "marginBottom"
        | "marginInlineEnd"
        | "marginInlineStart"
        | "marginLeft"
        | "marginRight"
        | "marginTop"
        | "paddingBlockEnd"
        | "paddingBlockStart"
        | "paddingBottom"
        | "paddingInlineEnd"
        | "paddingInlineStart"
        | "paddingLeft"
        | "paddingRight"
        | "paddingTop"
        | "marginBlock"
        | "marginInline"
        | "paddingBlock"
        | "paddingInline"
        | "m"
        | "mt"
        | "mr"
        | "mb"
        | "ml"
        | "mx"
        | "marginX"
        | "my"
        | "marginY"
        | "pt"
        | "pr"
        | "pb"
        | "pl"
        | "px"
        | "paddingX"
        | "py"
        | "paddingY", any>>;
    cardSize?: "small" | "medium";
    cardSx?: SxProps<Theme>;
    centerRipple?: boolean;
    checked?: boolean;
    children?: ReactNode;
    classes?: Partial<ToggleButtonClasses> & Partial<ClassNameMap<never>>;
    className?: string;
    color?: OverridableStringUnion<
        | "error"
        | "warning"
        | "success"
        | "standard"
        | "primary"
        | "secondary"
        | "info", ToggleButtonPropsColorOverrides>;
    component?: ElementType<any, (keyof IntrinsicElements)>;
    content?: string;
    contentEditable?: "inherit" | Booleanish | "plaintext-only";
    contextMenu?: string;
    customAttribute?: {
        attribute: string;
        value: string | number;
    };
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    datatype?: string;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    dir?: string;
    disableContentPadding?: boolean;
    disabled?: boolean;
    disableFocusRipple?: boolean;
    disableRightComponentPadding?: boolean;
    disableRipple?: boolean;
    disableTouchRipple?: boolean;
    draggable?: Booleanish;
    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send";
    error?: boolean;
    focusRipple?: boolean;
    focusVisibleClassName?: string;
    form?: string;
    formAction?: string | ((formData: FormData) => void | Promise<void>);
    formEncType?: string;
    formMethod?: string;
    formNoValidate?: boolean;
    formTarget?: string;
    fullWidth?: boolean;
    hidden?: boolean;
    id: string;
    inert?: boolean;
    inlist?: any;
    inputMode?:
        | "search"
        | "none"
        | "url"
        | "text"
        | "tel"
        | "email"
        | "numeric"
        | "decimal";
    is?: string;
    isLoading?: boolean;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    label: string;
    labelSecondaryText?: string;
    labelSecondaryTextColor?: string;
    labelSecondaryTextNode?: ReactNode;
    lang?: string;
    limitedClickArea?: boolean;
    LinkComponent?: ElementType<any, (keyof IntrinsicElements)>;
    name?: string;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLButtonElement>;
    onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
    onAuxClick?: MouseEventHandler<HTMLButtonElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
    onBeforeInput?: FormEventHandler<HTMLButtonElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
    onBeforeToggle?: ToggleEventHandler<HTMLButtonElement>;
    onBlur?: FocusEventHandler<HTMLButtonElement>;
    onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
    onCanPlay?: ReactEventHandler<HTMLButtonElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
    onChange?: ((event: ChangeEvent<unknown>) => void);
    onChangeCapture?: FormEventHandler<HTMLButtonElement>;
    onClick?: ((event: MouseEvent<HTMLElement, MouseEvent>, value: any) => void);
    onClickCapture?: MouseEventHandler<HTMLButtonElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
    onContextMenu?: MouseEventHandler<HTMLButtonElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
    onCopy?: ClipboardEventHandler<HTMLButtonElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
    onCut?: ClipboardEventHandler<HTMLButtonElement>;
    onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
    onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
    onDrag?: DragEventHandler<HTMLButtonElement>;
    onDragCapture?: DragEventHandler<HTMLButtonElement>;
    onDragEnd?: DragEventHandler<HTMLButtonElement>;
    onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
    onDragEnter?: DragEventHandler<HTMLButtonElement>;
    onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
    onDragExit?: DragEventHandler<HTMLButtonElement>;
    onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
    onDragLeave?: DragEventHandler<HTMLButtonElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
    onDragOver?: DragEventHandler<HTMLButtonElement>;
    onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
    onDragStart?: DragEventHandler<HTMLButtonElement>;
    onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
    onDrop?: DragEventHandler<HTMLButtonElement>;
    onDropCapture?: DragEventHandler<HTMLButtonElement>;
    onDurationChange?: ReactEventHandler<HTMLButtonElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
    onEmptied?: ReactEventHandler<HTMLButtonElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
    onEncrypted?: ReactEventHandler<HTMLButtonElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
    onEnded?: ReactEventHandler<HTMLButtonElement>;
    onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
    onError?: ReactEventHandler<HTMLButtonElement>;
    onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
    onFocus?: FocusEventHandler<HTMLButtonElement>;
    onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
    onFocusVisible?: FocusEventHandler<any>;
    onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
    onInput?: FormEventHandler<HTMLButtonElement>;
    onInputCapture?: FormEventHandler<HTMLButtonElement>;
    onInvalid?: FormEventHandler<HTMLButtonElement>;
    onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
    onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
    onLoad?: ReactEventHandler<HTMLButtonElement>;
    onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
    onLoadedData?: ReactEventHandler<HTMLButtonElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
    onLoadStart?: ReactEventHandler<HTMLButtonElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
    onMouseDown?: MouseEventHandler<HTMLButtonElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
    onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
    onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
    onMouseMove?: MouseEventHandler<HTMLButtonElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
    onMouseOut?: MouseEventHandler<HTMLButtonElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
    onMouseOver?: MouseEventHandler<HTMLButtonElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
    onMouseUp?: MouseEventHandler<HTMLButtonElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
    onPaste?: ClipboardEventHandler<HTMLButtonElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
    onPause?: ReactEventHandler<HTMLButtonElement>;
    onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
    onPlay?: ReactEventHandler<HTMLButtonElement>;
    onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
    onPlaying?: ReactEventHandler<HTMLButtonElement>;
    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
    onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerDown?: PointerEventHandler<HTMLButtonElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
    onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
    onPointerMove?: PointerEventHandler<HTMLButtonElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerOut?: PointerEventHandler<HTMLButtonElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerOver?: PointerEventHandler<HTMLButtonElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
    onPointerUp?: PointerEventHandler<HTMLButtonElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
    onProgress?: ReactEventHandler<HTMLButtonElement>;
    onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
    onRateChange?: ReactEventHandler<HTMLButtonElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
    onReset?: FormEventHandler<HTMLButtonElement>;
    onResetCapture?: FormEventHandler<HTMLButtonElement>;
    onResize?: ReactEventHandler<HTMLButtonElement>;
    onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
    onScroll?: UIEventHandler<HTMLButtonElement>;
    onScrollCapture?: UIEventHandler<HTMLButtonElement>;
    onSeeked?: ReactEventHandler<HTMLButtonElement>;
    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
    onSeeking?: ReactEventHandler<HTMLButtonElement>;
    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
    onSelect?: ReactEventHandler<HTMLButtonElement>;
    onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
    onSizeChange?: ((size: undefined | "small" | "medium") => void);
    onStalled?: ReactEventHandler<HTMLButtonElement>;
    onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
    onSubmit?: FormEventHandler<HTMLButtonElement>;
    onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
    onSuspend?: ReactEventHandler<HTMLButtonElement>;
    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
    onToggle?: ToggleEventHandler<HTMLButtonElement>;
    onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
    onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
    onTouchMove?: TouchEventHandler<HTMLButtonElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
    onTouchStart?: TouchEventHandler<HTMLButtonElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
    onTransitionCancel?: TransitionEventHandler<HTMLButtonElement>;
    onTransitionCancelCapture?: TransitionEventHandler<HTMLButtonElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
    onTransitionRun?: TransitionEventHandler<HTMLButtonElement>;
    onTransitionRunCapture?: TransitionEventHandler<HTMLButtonElement>;
    onTransitionStart?: TransitionEventHandler<HTMLButtonElement>;
    onTransitionStartCapture?: TransitionEventHandler<HTMLButtonElement>;
    onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
    onWaiting?: ReactEventHandler<HTMLButtonElement>;
    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
    onWheel?: WheelEventHandler<HTMLButtonElement>;
    onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
    popover?: "" | "auto" | "manual";
    popoverTarget?: string;
    popoverTargetAction?: "toggle" | "hide" | "show";
    prefix?: string;
    primaryMetaText?: string;
    primaryMetaTextColor?: "disabled" | "textPrimary" | "textSecondary";
    property?: string;
    radioGroup?: string;
    ref?: null | ((instance: null | HTMLButtonElement) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement>;
    rel?: string;
    resource?: string;
    results?: number;
    rev?: string;
    rightComponent?: ReactNode;
    role?: AriaRole;
    secondaryMetaText?: string;
    secondaryMetaTextColor?: "disabled" | "textPrimary" | "textSecondary";
    security?: string;
    selected?: boolean;
    size?: OverridableStringUnion<"small" | "medium" | "large", ToggleButtonPropsSizeOverrides>;
    sizeValue?: "small" | "medium";
    skeletonSx?: SxProps<Theme>;
    slot?: string;
    spellCheck?: Booleanish;
    style?: CSSProperties;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    sx?: SxProps<Theme>;
    tabIndex?: number;
    title?: string;
    toggleButtonRef?: RefObject<null | HTMLButtonElement>;
    TouchRippleProps?: Partial<TouchRippleProps>;
    touchRippleRef?: Ref<TouchRippleActions>;
    translate?: "yes" | "no";
    tw?: string;
    type?: "reset" | "submit" | "button";
    typeof?: string;
    unselectable?: "on" | "off";
    value: string;
    vocab?: string;
    wrapRightComponentToBottom?: boolean;
}

Hierarchy

Omit<MuiToggleButtonProps, "id">
Omit<InputCardContentProps, "InputComponent" | "id">
- RadioToggleCardProps

Index

Properties

about? accessKey? action? active activeState? aria-activedescendant? aria-atomic? aria-autocomplete? aria-braillelabel? aria-brailleroledescription? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colindextext? aria-colspan? aria-controls? aria-current? aria-describedby? aria-description? aria-details? aria-disabled? aria-dropeffect? aria-errormessage? aria-expanded? aria-flowto? aria-grabbed? aria-haspopup? aria-hidden? aria-invalid? aria-keyshortcuts? aria-label? aria-labelledby? aria-level? aria-live? aria-modal? aria-multiline? aria-multiselectable? aria-orientation? aria-owns? aria-placeholder? aria-posinset? aria-pressed? aria-readonly? aria-relevant? aria-required? aria-roledescription? aria-rowcount? aria-rowindex? aria-rowindextext? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? autoCapitalize? autoCorrect? autoFocus? autoSave? boxProps? cardSize? cardSx? centerRipple? checked? children? classes? className? color? component? content? contentEditable? contextMenu? customAttribute? dangerouslySetInnerHTML? datatype? defaultChecked? defaultValue? dir? disableContentPadding? disabled? disableFocusRipple? disableRightComponentPadding? disableRipple? disableTouchRipple? draggable? enterKeyHint? error? focusRipple? focusVisibleClassName? form? formAction? formEncType? formMethod? formNoValidate? formTarget? fullWidth? hidden? id inert? inlist? inputMode? is? isLoading? itemID? itemProp? itemRef? itemScope? itemType? key? label labelSecondaryText? labelSecondaryTextColor? labelSecondaryTextNode? lang? limitedClickArea? LinkComponent? name? nonce? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBeforeToggle? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClick? onClickCapture? onCompositionEnd? onCompositionEndCapture? onCompositionStart? onCompositionStartCapture? onCompositionUpdate? onCompositionUpdateCapture? onContextMenu? onContextMenuCapture? onCopy? onCopyCapture? onCut? onCutCapture? onDoubleClick? onDoubleClickCapture? onDrag? onDragCapture? onDragEnd? onDragEndCapture? onDragEnter? onDragEnterCapture? onDragExit? onDragExitCapture? onDragLeave? onDragLeaveCapture? onDragOver? onDragOverCapture? onDragStart? onDragStartCapture? onDrop? onDropCapture? onDurationChange? onDurationChangeCapture? onEmptied? onEmptiedCapture? onEncrypted? onEncryptedCapture? onEnded? onEndedCapture? onError? onErrorCapture? onFocus? onFocusCapture? onFocusVisible? onGotPointerCapture? onGotPointerCaptureCapture? onInput? onInputCapture? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPress? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLoadStart? onLoadStartCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onProgress? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onResize? onResizeCapture? onScroll? onScrollCapture? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onSizeChange? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onTimeUpdate? onTimeUpdateCapture? onToggle? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionCancel? onTransitionCancelCapture? onTransitionEnd? onTransitionEndCapture? onTransitionRun? onTransitionRunCapture? onTransitionStart? onTransitionStartCapture? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? popover? popoverTarget? popoverTargetAction? prefix? primaryMetaText? primaryMetaTextColor? property? radioGroup? ref? rel? resource? results? rev? rightComponent? role? secondaryMetaText? secondaryMetaTextColor? security? selected? size? sizeValue? skeletonSx? slot? spellCheck? style? suppressContentEditableWarning? suppressHydrationWarning? sx? tabIndex? title? toggleButtonRef? TouchRippleProps? touchRippleRef? translate? tw? type? typeof? unselectable? value vocab? wrapRightComponentToBottom?

Properties

`Optional`about

about?: string

`Optional`accessKey

accessKey?: string

`Optional`action

action?: Ref<ButtonBaseActions>

A ref for imperative actions. It currently only supports focusVisible() action.

active

active: boolean

Indicates if the card is currently active.

`Optional`activeState

activeState?: "active" | "warning"

Defines the border color of the card when it is active.

`Optional`aria-activedescendant

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

`Optional`aria-atomic

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

`Optional`aria-autocomplete

aria-autocomplete?:
    | "none"
    | "list"
    | "both"
    | "inline"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

`Optional`aria-braillelabel

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

`Optional`aria-brailleroledescription

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

`Optional`aria-busy

aria-busy?: Booleanish

`Optional`aria-checked

aria-checked?:
    | boolean
    | "mixed"
    | "false"
    | "true"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

aria-pressed
aria-selected.

`Optional`aria-colcount

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

`Optional`aria-colindex

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

aria-colcount
aria-colspan.

`Optional`aria-colindextext

aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

`Optional`aria-colspan

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

aria-colindex
aria-rowspan.

`Optional`aria-controls

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

`Optional`aria-current

Indicates the element that represents the current item within a container or set of related elements.

`Optional`aria-describedby

aria-describedby?: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

`Optional`aria-description

aria-description?: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

`Optional`aria-details

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

`Optional`aria-disabled

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

aria-hidden
aria-readonly.

`Optional`aria-dropeffect

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

`Optional`aria-errormessage

aria-errormessage?: string

Identifies the element that provides an error message for the object.

See

aria-invalid
aria-describedby.

`Optional`aria-expanded

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

`Optional`aria-flowto

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

`Optional`aria-grabbed

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

`Optional`aria-haspopup

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

`Optional`aria-hidden

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

`Optional`aria-invalid

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

`Optional`aria-keyshortcuts

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

`Optional`aria-label

aria-label?: string

Defines a string value that labels the current element.

See

aria-labelledby.

`Optional`aria-labelledby

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

`Optional`aria-level

aria-level?: number

Defines the hierarchical level of an element within a structure.

`Optional`aria-live

aria-live?: "assertive" | "polite" | "off"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

`Optional`aria-modal

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

`Optional`aria-multiline

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

`Optional`aria-multiselectable

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

`Optional`aria-orientation

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

`Optional`aria-owns

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

`Optional`aria-placeholder

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

`Optional`aria-posinset

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

`Optional`aria-pressed

aria-pressed?:
    | boolean
    | "mixed"
    | "false"
    | "true"

Indicates the current "pressed" state of toggle buttons.

See

aria-checked
aria-selected.

`Optional`aria-readonly

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

`Optional`aria-relevant

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

`Optional`aria-required

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

`Optional`aria-roledescription

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

`Optional`aria-rowcount

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

`Optional`aria-rowindex

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

aria-rowcount
aria-rowspan.

`Optional`aria-rowindextext

aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

`Optional`aria-rowspan

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

aria-rowindex
aria-colspan.

`Optional`aria-selected

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

See

aria-checked
aria-pressed.

`Optional`aria-setsize

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

`Optional`aria-sort

aria-sort?:
    | "none"
    | "other"
    | "ascending"
    | "descending"

Indicates if items in a table or grid are sorted in ascending or descending order.

`Optional`aria-valuemax

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

`Optional`aria-valuemin

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

`Optional`aria-valuenow

aria-valuenow?: number

Defines the current value for a range widget.

See

aria-valuetext.

`Optional`aria-valuetext

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

`Optional`autoCapitalize

autoCapitalize?:
    | string & {}
    | "none"
    | "on"
    | "off"
    | "sentences"
    | "words"
    | "characters"

`Optional`autoCorrect

autoCorrect?: string

`Optional`autoFocus

autoFocus?: boolean

`Optional`autoSave

autoSave?: string

`Optional`boxProps

Additional properties for the box component, used to resolve layout issues when combined with a toggle button.

`Optional`cardSize

cardSize?: "small" | "medium"

Specifies a fixed size for the card, overriding responsive breakpoints.

`Optional`cardSx

cardSx?: SxProps<Theme>

Custom styles applied to the card.

`Optional`centerRipple

centerRipple?: boolean

If true, the ripples are centered. They won't start at the cursor interaction position.

Default

false

`Optional`checked

checked?: boolean

Indicates whether the component is checked.

`Optional`children

children?: ReactNode

The content of the component.

`Optional`classes

classes?: Partial<ToggleButtonClasses> & Partial<ClassNameMap<never>>

Override or extend the styles applied to the component.

`Optional`className

className?: string

`Optional`color

The color of the button when it is in an active state. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Default

'standard'

`Optional`component

component?: ElementType<any, (keyof IntrinsicElements)>

`Optional`content

content?: string

`Optional`contentEditable

contentEditable?: "inherit" | Booleanish | "plaintext-only"

`Optional`contextMenu

contextMenu?: string

`Optional`customAttribute

customAttribute?: {
attribute: string;
value: string | number;
}

Used for tests. Clickable and requested subcomponents will be suffixed with "-[ComponentName]".

`Optional`dangerouslySetInnerHTML

dangerouslySetInnerHTML?: {
__html: string | TrustedHTML;
}

`Optional`datatype

datatype?: string

`Optional`defaultChecked

defaultChecked?: boolean

`Optional`defaultValue

defaultValue?: string | number | readonly string[]

`Optional`dir

dir?: string

`Optional`disableContentPadding

disableContentPadding?: boolean

If true, disables padding on the bottom content to allow usage of the full width.

`Optional`disabled

disabled?: boolean

If true, the component is disabled.

Default

false

`Optional`disableFocusRipple

disableFocusRipple?: boolean

If true, the keyboard focus ripple is disabled.

Default

false

`Optional`disableRightComponentPadding

disableRightComponentPadding?: boolean

If true, disables padding in the right component.

`Optional`disableRipple

disableRipple?: boolean

If true, the ripple effect is disabled.

⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.

Default

false

`Optional`disableTouchRipple

disableTouchRipple?: boolean

If true, the touch ripple effect is disabled.

Default

false

`Optional`draggable

draggable?: Booleanish

`Optional`enterKeyHint

`Optional`error

error?: boolean

Indicates if the component is in an error state, applying error-specific styling for validation feedback.

`Optional`focusRipple

focusRipple?: boolean

If true, the base button will have a keyboard focus ripple.

Default

false

`Optional`focusVisibleClassName

focusVisibleClassName?: string

This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.

`Optional`form

form?: string

`Optional`formAction

formAction?: string | ((formData: FormData) => void | Promise<void>)

`Optional`formEncType

formEncType?: string

`Optional`formMethod

formMethod?: string

`Optional`formNoValidate

formNoValidate?: boolean

`Optional`formTarget

formTarget?: string

`Optional`fullWidth

fullWidth?: boolean

If true, the button will take up the full width of its container.

Default

false

`Optional`hidden

hidden?: boolean

id

id: string

Unique identifier for the checkbox value.

`Optional`inert

inert?: boolean

See

https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert

`Optional`inlist

inlist?: any

`Optional`inputMode

Hints at the type of data that might be entered by the user while editing the element or its contents

See

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

`Optional`is

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

See

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

`Optional`isLoading

isLoading?: boolean

If true, a loading skeleton will be rendered instead of the component.

`Optional`itemID

itemID?: string

`Optional`itemProp

itemProp?: string

`Optional`itemRef

itemRef?: string

`Optional`itemScope

itemScope?: boolean

`Optional`itemType

itemType?: string

`Optional`key

key?: null | Key

label

label: string

The label text.

`Optional`labelSecondaryText

labelSecondaryText?: string

Optional secondary text displayed below the primary text.

`Optional`labelSecondaryTextColor

labelSecondaryTextColor?: string

Color of the secondary label text.

`Optional`labelSecondaryTextNode

labelSecondaryTextNode?: ReactNode

Optional secondary text component instead of string. Will not be wrapped in , developers need to provide their own styles. It's only used when there is no labelSecondaryText present

`Optional`lang

lang?: string

`Optional`limitedClickArea

limitedClickArea?: boolean

If true, the card will have a limited click area.

`Optional`LinkComponent

LinkComponent?: ElementType<any, (keyof IntrinsicElements)>

The component used to render a link when the href prop is provided.

Default

'a'

`Optional`name

name?: string

`Optional`nonce

nonce?: string

`Optional`onAbort

onAbort?: ReactEventHandler<HTMLButtonElement>

`Optional`onAbortCapture

onAbortCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onAnimationEnd

onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>

`Optional`onAnimationEndCapture

onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>

`Optional`onAnimationIteration

onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>

`Optional`onAnimationIterationCapture

onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>

`Optional`onAnimationStart

onAnimationStart?: AnimationEventHandler<HTMLButtonElement>

`Optional`onAnimationStartCapture

onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>

`Optional`onAuxClick

onAuxClick?: MouseEventHandler<HTMLButtonElement>

`Optional`onAuxClickCapture

onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>

`Optional`onBeforeInput

onBeforeInput?: FormEventHandler<HTMLButtonElement>

`Optional`onBeforeInputCapture

onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>

`Optional`onBeforeToggle

onBeforeToggle?: ToggleEventHandler<HTMLButtonElement>

`Optional`onBlur

onBlur?: FocusEventHandler<HTMLButtonElement>

`Optional`onBlurCapture

onBlurCapture?: FocusEventHandler<HTMLButtonElement>

`Optional`onCanPlay

onCanPlay?: ReactEventHandler<HTMLButtonElement>

`Optional`onCanPlayCapture

onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onCanPlayThrough

onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>

`Optional`onCanPlayThroughCapture

onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onChange

onChange?: ((event: ChangeEvent<unknown>) => void)

Function to handle change events, triggered when the card's selection state changes.

`Optional`onChangeCapture

onChangeCapture?: FormEventHandler<HTMLButtonElement>

`Optional`onClick

onClick?: ((event: MouseEvent<HTMLElement, MouseEvent>, value: any) => void)

Callback fired when the button is clicked.

Type declaration

- (event, value): void
- Parameters
  - event: MouseEvent<HTMLElement, MouseEvent>
    The event source of the callback.
  - value: any
    of the selected button.
  Returns void

`Optional`onClickCapture

onClickCapture?: MouseEventHandler<HTMLButtonElement>

`Optional`onCompositionEnd

onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>

`Optional`onCompositionEndCapture

onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>

`Optional`onCompositionStart

onCompositionStart?: CompositionEventHandler<HTMLButtonElement>

`Optional`onCompositionStartCapture

onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>

`Optional`onCompositionUpdate

onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>

`Optional`onCompositionUpdateCapture

onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>

`Optional`onContextMenu

onContextMenu?: MouseEventHandler<HTMLButtonElement>

`Optional`onContextMenuCapture

onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>

`Optional`onCopy

onCopy?: ClipboardEventHandler<HTMLButtonElement>

`Optional`onCopyCapture

onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>

`Optional`onCut

onCut?: ClipboardEventHandler<HTMLButtonElement>

`Optional`onCutCapture

onCutCapture?: ClipboardEventHandler<HTMLButtonElement>

`Optional`onDoubleClick

onDoubleClick?: MouseEventHandler<HTMLButtonElement>

`Optional`onDoubleClickCapture

onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>

`Optional`onDrag

onDrag?: DragEventHandler<HTMLButtonElement>

`Optional`onDragCapture

onDragCapture?: DragEventHandler<HTMLButtonElement>

`Optional`onDragEnd

onDragEnd?: DragEventHandler<HTMLButtonElement>

`Optional`onDragEndCapture

onDragEndCapture?: DragEventHandler<HTMLButtonElement>

`Optional`onDragEnter

onDragEnter?: DragEventHandler<HTMLButtonElement>

`Optional`onDragEnterCapture

onDragEnterCapture?: DragEventHandler<HTMLButtonElement>

`Optional`onDragExit

onDragExit?: DragEventHandler<HTMLButtonElement>

`Optional`onDragExitCapture

onDragExitCapture?: DragEventHandler<HTMLButtonElement>

`Optional`onDragLeave

onDragLeave?: DragEventHandler<HTMLButtonElement>

`Optional`onDragLeaveCapture

onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>

`Optional`onDragOver

onDragOver?: DragEventHandler<HTMLButtonElement>

`Optional`onDragOverCapture

onDragOverCapture?: DragEventHandler<HTMLButtonElement>

`Optional`onDragStart

onDragStart?: DragEventHandler<HTMLButtonElement>

`Optional`onDragStartCapture

onDragStartCapture?: DragEventHandler<HTMLButtonElement>

`Optional`onDrop

onDrop?: DragEventHandler<HTMLButtonElement>

`Optional`onDropCapture

onDropCapture?: DragEventHandler<HTMLButtonElement>

`Optional`onDurationChange

onDurationChange?: ReactEventHandler<HTMLButtonElement>

`Optional`onDurationChangeCapture

onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onEmptied

onEmptied?: ReactEventHandler<HTMLButtonElement>

`Optional`onEmptiedCapture

onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onEncrypted

onEncrypted?: ReactEventHandler<HTMLButtonElement>

`Optional`onEncryptedCapture

onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onEnded

onEnded?: ReactEventHandler<HTMLButtonElement>

`Optional`onEndedCapture

onEndedCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onError

onError?: ReactEventHandler<HTMLButtonElement>

`Optional`onErrorCapture

onErrorCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onFocus

onFocus?: FocusEventHandler<HTMLButtonElement>

`Optional`onFocusCapture

onFocusCapture?: FocusEventHandler<HTMLButtonElement>

`Optional`onFocusVisible

onFocusVisible?: FocusEventHandler<any>

Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.

`Optional`onGotPointerCapture

onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onGotPointerCaptureCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onInput

onInput?: FormEventHandler<HTMLButtonElement>

`Optional`onInputCapture

onInputCapture?: FormEventHandler<HTMLButtonElement>

`Optional`onInvalid

onInvalid?: FormEventHandler<HTMLButtonElement>

`Optional`onInvalidCapture

onInvalidCapture?: FormEventHandler<HTMLButtonElement>

`Optional`onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLButtonElement>

`Optional`onKeyDownCapture

onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>

`Optional`onKeyPress

onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

Deprecated

Use onKeyUp or onKeyDown instead

`Optional`onKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

Deprecated

Use onKeyUpCapture or onKeyDownCapture instead

`Optional`onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLButtonElement>

`Optional`onKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>

`Optional`onLoad

onLoad?: ReactEventHandler<HTMLButtonElement>

`Optional`onLoadCapture

onLoadCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onLoadedData

onLoadedData?: ReactEventHandler<HTMLButtonElement>

`Optional`onLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>

`Optional`onLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onLoadStart

onLoadStart?: ReactEventHandler<HTMLButtonElement>

`Optional`onLoadStartCapture

onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onLostPointerCapture

onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onLostPointerCaptureCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onMouseDown

onMouseDown?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseDownCapture

onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseEnter

onMouseEnter?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseLeave

onMouseLeave?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseMove

onMouseMove?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseMoveCapture

onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseOut

onMouseOut?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseOutCapture

onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseOver

onMouseOver?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseOverCapture

onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseUp

onMouseUp?: MouseEventHandler<HTMLButtonElement>

`Optional`onMouseUpCapture

onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>

`Optional`onPaste

onPaste?: ClipboardEventHandler<HTMLButtonElement>

`Optional`onPasteCapture

onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>

`Optional`onPause

onPause?: ReactEventHandler<HTMLButtonElement>

`Optional`onPauseCapture

onPauseCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onPlay

onPlay?: ReactEventHandler<HTMLButtonElement>

`Optional`onPlayCapture

onPlayCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onPlaying

onPlaying?: ReactEventHandler<HTMLButtonElement>

`Optional`onPlayingCapture

onPlayingCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onPointerCancel

onPointerCancel?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerCancelCapture

onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerDown

onPointerDown?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerDownCapture

onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerEnter

onPointerEnter?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerLeave

onPointerLeave?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerMove

onPointerMove?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerMoveCapture

onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerOut

onPointerOut?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerOutCapture

onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerOver

onPointerOver?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerOverCapture

onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerUp

onPointerUp?: PointerEventHandler<HTMLButtonElement>

`Optional`onPointerUpCapture

onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>

`Optional`onProgress

onProgress?: ReactEventHandler<HTMLButtonElement>

`Optional`onProgressCapture

onProgressCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onRateChange

onRateChange?: ReactEventHandler<HTMLButtonElement>

`Optional`onRateChangeCapture

onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onReset

onReset?: FormEventHandler<HTMLButtonElement>

`Optional`onResetCapture

onResetCapture?: FormEventHandler<HTMLButtonElement>

`Optional`onResize

onResize?: ReactEventHandler<HTMLButtonElement>

`Optional`onResizeCapture

onResizeCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onScroll

onScroll?: UIEventHandler<HTMLButtonElement>

`Optional`onScrollCapture

onScrollCapture?: UIEventHandler<HTMLButtonElement>

`Optional`onSeeked

onSeeked?: ReactEventHandler<HTMLButtonElement>

`Optional`onSeekedCapture

onSeekedCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onSeeking

onSeeking?: ReactEventHandler<HTMLButtonElement>

`Optional`onSeekingCapture

onSeekingCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onSelect

onSelect?: ReactEventHandler<HTMLButtonElement>

`Optional`onSelectCapture

onSelectCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onSizeChange

onSizeChange?: ((size: undefined | "small" | "medium") => void)

Callback function triggered when the card size changes. This is typically used in conjunction with the RadioPriceCard.

`Optional`onStalled

onStalled?: ReactEventHandler<HTMLButtonElement>

`Optional`onStalledCapture

onStalledCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onSubmit

onSubmit?: FormEventHandler<HTMLButtonElement>

`Optional`onSubmitCapture

onSubmitCapture?: FormEventHandler<HTMLButtonElement>

`Optional`onSuspend

onSuspend?: ReactEventHandler<HTMLButtonElement>

`Optional`onSuspendCapture

onSuspendCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onTimeUpdate

onTimeUpdate?: ReactEventHandler<HTMLButtonElement>

`Optional`onTimeUpdateCapture

onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onToggle

onToggle?: ToggleEventHandler<HTMLButtonElement>

`Optional`onTouchCancel

onTouchCancel?: TouchEventHandler<HTMLButtonElement>

`Optional`onTouchCancelCapture

onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>

`Optional`onTouchEnd

onTouchEnd?: TouchEventHandler<HTMLButtonElement>

`Optional`onTouchEndCapture

onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>

`Optional`onTouchMove

onTouchMove?: TouchEventHandler<HTMLButtonElement>

`Optional`onTouchMoveCapture

onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>

`Optional`onTouchStart

onTouchStart?: TouchEventHandler<HTMLButtonElement>

`Optional`onTouchStartCapture

onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>

`Optional`onTransitionCancel

onTransitionCancel?: TransitionEventHandler<HTMLButtonElement>

`Optional`onTransitionCancelCapture

onTransitionCancelCapture?: TransitionEventHandler<HTMLButtonElement>

`Optional`onTransitionEnd

onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>

`Optional`onTransitionEndCapture

onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>

`Optional`onTransitionRun

onTransitionRun?: TransitionEventHandler<HTMLButtonElement>

`Optional`onTransitionRunCapture

onTransitionRunCapture?: TransitionEventHandler<HTMLButtonElement>

`Optional`onTransitionStart

onTransitionStart?: TransitionEventHandler<HTMLButtonElement>

`Optional`onTransitionStartCapture

onTransitionStartCapture?: TransitionEventHandler<HTMLButtonElement>

`Optional`onVolumeChange

onVolumeChange?: ReactEventHandler<HTMLButtonElement>

`Optional`onVolumeChangeCapture

onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onWaiting

onWaiting?: ReactEventHandler<HTMLButtonElement>

`Optional`onWaitingCapture

onWaitingCapture?: ReactEventHandler<HTMLButtonElement>

`Optional`onWheel

onWheel?: WheelEventHandler<HTMLButtonElement>

`Optional`onWheelCapture

onWheelCapture?: WheelEventHandler<HTMLButtonElement>

`Optional`popover

popover?: "" | "auto" | "manual"

`Optional`popoverTarget

popoverTarget?: string

`Optional`popoverTargetAction

popoverTargetAction?: "toggle" | "hide" | "show"

`Optional`prefix

prefix?: string

`Optional`primaryMetaText

primaryMetaText?: string

Optional primary meta text. Will be dispayed to the right in the card.

`Optional`primaryMetaTextColor

primaryMetaTextColor?: "disabled" | "textPrimary" | "textSecondary"

Color of the primary meta text.

`Optional`property

property?: string

`Optional`radioGroup

radioGroup?: string

`Optional`ref

ref?: null | ((instance: null | HTMLButtonElement) => void | (() => VoidOrUndefinedOnly)) | RefObject<HTMLButtonElement>

`Optional`rel

rel?: string

`Optional`resource

resource?: string

`Optional`results

results?: number

`Optional`rev

rev?: string

`Optional`rightComponent

rightComponent?: ReactNode

Optional component to be rendered to the right in the card

`Optional`role

role?: AriaRole

`Optional`secondaryMetaText

secondaryMetaText?: string

Optional secondary meta text. Will be dispayed to the right in the card under the primary meta

`Optional`secondaryMetaTextColor

secondaryMetaTextColor?: "disabled" | "textPrimary" | "textSecondary"

Color of the secondary meta text.

`Optional`security

security?: string

`Optional`selected

selected?: boolean

If true, the button is rendered in an active state.

`Optional`size

size?: OverridableStringUnion<"small" | "medium" | "large", ToggleButtonPropsSizeOverrides>

The size of the component. The prop defaults to the value inherited from the parent ToggleButtonGroup component.

Default

'medium'

`Optional`sizeValue

sizeValue?: "small" | "medium"

Current size of the card

`Optional`skeletonSx

skeletonSx?: SxProps<Theme>

Custom styles for the loading skeleton displayed when the card is loading.

`Optional`slot

slot?: string

`Optional`spellCheck

spellCheck?: Booleanish

`Optional`style

style?: CSSProperties

`Optional`suppressContentEditableWarning

suppressContentEditableWarning?: boolean

`Optional`suppressHydrationWarning

suppressHydrationWarning?: boolean

`Optional`sx

sx?: SxProps<Theme>

The system prop that allows defining system overrides as well as additional CSS styles.

`Optional`tabIndex

tabIndex?: number

Default

`Optional`title

title?: string

`Optional`toggleButtonRef

toggleButtonRef?: RefObject<null | HTMLButtonElement>

Reference to the toggle button element, used for managing focus and other direct manipulations.

`Optional`TouchRippleProps

TouchRippleProps?: Partial<TouchRippleProps>

Props applied to the TouchRipple element.

`Optional`touchRippleRef

touchRippleRef?: Ref<TouchRippleActions>

A ref that points to the TouchRipple element.

`Optional`translate

translate?: "yes" | "no"

`Optional`tw

tw?: string

Specify styles using Tailwind CSS classes. This feature is currently experimental. If style prop is also specified, styles generated with tw prop will be overridden.

Example:

tw='w-full h-full bg-blue-200'
tw='text-9xl'
tw='text-[80px]'

`Optional`type

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

`Optional`typeof

typeof?: string

`Optional`unselectable

unselectable?: "on" | "off"

value

value: string

The value associated with the card, used in form submissions.

`Optional`vocab

vocab?: string

`Optional`wrapRightComponentToBottom

wrapRightComponentToBottom?: boolean

If true, positions the right component below the main content on small screens.

Interface RadioToggleCardProps

Hierarchy

Index

Properties

Properties

Optionalabout

OptionalaccessKey

Optionalaction

active

OptionalactiveState

Optionalaria-activedescendant

Optionalaria-atomic

Optionalaria-autocomplete

Optionalaria-braillelabel

See

Optionalaria-brailleroledescription

See

Optionalaria-busy

Optionalaria-checked

See

Optionalaria-colcount

See

Optionalaria-colindex

See

Optionalaria-colindextext

See

Optionalaria-colspan

See

Optionalaria-controls

See

Optionalaria-current

Optionalaria-describedby

See

Optionalaria-description

See

Optionalaria-details

See

Optionalaria-disabled

See

Optionalaria-dropeffect

Deprecated

Optionalaria-errormessage

See

Optionalaria-expanded

Optionalaria-flowto

Optionalaria-grabbed

Deprecated

Optionalaria-haspopup

Optionalaria-hidden

See

Optionalaria-invalid

See

Optionalaria-keyshortcuts

Optionalaria-label

See

Optionalaria-labelledby

See

Optionalaria-level

Optionalaria-live

Optionalaria-modal

Optionalaria-multiline

Optionalaria-multiselectable

Optionalaria-orientation

Optionalaria-owns

See

Optionalaria-placeholder

Optionalaria-posinset

See

Optionalaria-pressed

See

Optionalaria-readonly

See

Optionalaria-relevant

See

Optionalaria-required

Optionalaria-roledescription

Optionalaria-rowcount

See

Optionalaria-rowindex

See

`Optional`about

`Optional`accessKey

`Optional`action

`Optional`activeState

`Optional`aria-activedescendant

`Optional`aria-atomic

`Optional`aria-autocomplete

`Optional`aria-braillelabel

`Optional`aria-brailleroledescription

`Optional`aria-busy

`Optional`aria-checked

`Optional`aria-colcount

`Optional`aria-colindex

`Optional`aria-colindextext

`Optional`aria-colspan

`Optional`aria-controls

`Optional`aria-current

`Optional`aria-describedby

`Optional`aria-description

`Optional`aria-details

`Optional`aria-disabled

`Optional`aria-dropeffect

`Optional`aria-errormessage

`Optional`aria-expanded

`Optional`aria-flowto

`Optional`aria-grabbed

`Optional`aria-haspopup

`Optional`aria-hidden

`Optional`aria-invalid

`Optional`aria-keyshortcuts

`Optional`aria-label

`Optional`aria-labelledby

`Optional`aria-level

`Optional`aria-live

`Optional`aria-modal

`Optional`aria-multiline

`Optional`aria-multiselectable

`Optional`aria-orientation

`Optional`aria-owns

`Optional`aria-placeholder

`Optional`aria-posinset

`Optional`aria-pressed

`Optional`aria-readonly

`Optional`aria-relevant

`Optional`aria-required

`Optional`aria-roledescription

`Optional`aria-rowcount

`Optional`aria-rowindex

`Optional`aria-rowindextext

`Optional`aria-rowspan

`Optional`aria-selected

`Optional`aria-setsize

`Optional`aria-sort

`Optional`aria-valuemax

`Optional`aria-valuemin

`Optional`aria-valuenow

`Optional`aria-valuetext

`Optional`autoCapitalize

`Optional`autoCorrect

`Optional`autoFocus

`Optional`autoSave

`Optional`boxProps

`Optional`cardSize

`Optional`cardSx

`Optional`centerRipple

`Optional`checked

`Optional`children

`Optional`classes

`Optional`className

`Optional`color

`Optional`component

`Optional`content

`Optional`contentEditable

`Optional`contextMenu

`Optional`customAttribute

`Optional`dangerouslySetInnerHTML

`Optional`datatype

`Optional`defaultChecked

`Optional`defaultValue

`Optional`dir