Backstage
    Preparing search index...

    Interface RadioProps

    interface RadioProps {
        "aria-describedby"?: string;
        "aria-details"?: string;
        "aria-label"?: string;
        "aria-labelledby"?: string;
        autoFocus?: boolean;
        children?: ChildrenOrFunction<RadioRenderProps>;
        className?: string;
        dir?: string;
        hidden?: boolean;
        id?: string;
        inert?: boolean;
        inputRef?: RefObject<HTMLInputElement | null>;
        isDisabled?: boolean;
        lang?: string;
        onAnimationEnd?: AnimationEventHandler<HTMLLabelElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLLabelElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLLabelElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLLabelElement>;
        onAnimationStart?: AnimationEventHandler<HTMLLabelElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLLabelElement>;
        onAuxClick?: MouseEventHandler<HTMLLabelElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLLabelElement>;
        onBlur?: (e: FocusEvent<Element>) => void;
        onClick?: (e: MouseEvent<FocusableElement>) => void;
        onClickCapture?: MouseEventHandler<HTMLLabelElement>;
        onContextMenu?: MouseEventHandler<HTMLLabelElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLLabelElement>;
        onDoubleClick?: MouseEventHandler<HTMLLabelElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLLabelElement>;
        onFocus?: (e: FocusEvent<Element>) => void;
        onFocusChange?: (isFocused: boolean) => void;
        onGotPointerCapture?: PointerEventHandler<HTMLLabelElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLLabelElement>;
        onHoverChange?: (isHovering: boolean) => void;
        onHoverEnd?: (e: HoverEvent) => void;
        onHoverStart?: (e: HoverEvent) => void;
        onKeyDown?: (e: KeyboardEvent) => void;
        onKeyUp?: (e: KeyboardEvent) => void;
        onLostPointerCapture?: PointerEventHandler<HTMLLabelElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLLabelElement>;
        onMouseDown?: MouseEventHandler<HTMLLabelElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLLabelElement>;
        onMouseEnter?: MouseEventHandler<HTMLLabelElement>;
        onMouseLeave?: MouseEventHandler<HTMLLabelElement>;
        onMouseMove?: MouseEventHandler<HTMLLabelElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLLabelElement>;
        onMouseOut?: MouseEventHandler<HTMLLabelElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLLabelElement>;
        onMouseOver?: MouseEventHandler<HTMLLabelElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLLabelElement>;
        onMouseUp?: MouseEventHandler<HTMLLabelElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLLabelElement>;
        onPointerCancel?: PointerEventHandler<HTMLLabelElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLLabelElement>;
        onPointerDown?: PointerEventHandler<HTMLLabelElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLLabelElement>;
        onPointerEnter?: PointerEventHandler<HTMLLabelElement>;
        onPointerLeave?: PointerEventHandler<HTMLLabelElement>;
        onPointerMove?: PointerEventHandler<HTMLLabelElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLLabelElement>;
        onPointerOut?: PointerEventHandler<HTMLLabelElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLLabelElement>;
        onPointerOver?: PointerEventHandler<HTMLLabelElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLLabelElement>;
        onPointerUp?: PointerEventHandler<HTMLLabelElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLLabelElement>;
        onPress?: (e: PressEvent) => void;
        onPressChange?: (isPressed: boolean) => void;
        onPressEnd?: (e: PressEvent) => void;
        onPressStart?: (e: PressEvent) => void;
        onPressUp?: (e: PressEvent) => void;
        onScroll?: UIEventHandler<HTMLLabelElement>;
        onScrollCapture?: UIEventHandler<HTMLLabelElement>;
        onTouchCancel?: TouchEventHandler<HTMLLabelElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLLabelElement>;
        onTouchEnd?: TouchEventHandler<HTMLLabelElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLLabelElement>;
        onTouchMove?: TouchEventHandler<HTMLLabelElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLLabelElement>;
        onTouchStart?: TouchEventHandler<HTMLLabelElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLLabelElement>;
        onTransitionCancel?: TransitionEventHandler<HTMLLabelElement>;
        onTransitionCancelCapture?: TransitionEventHandler<HTMLLabelElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLLabelElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLLabelElement>;
        onTransitionRun?: TransitionEventHandler<HTMLLabelElement>;
        onTransitionRunCapture?: TransitionEventHandler<HTMLLabelElement>;
        onTransitionStart?: TransitionEventHandler<HTMLLabelElement>;
        onTransitionStartCapture?: TransitionEventHandler<HTMLLabelElement>;
        onWheel?: WheelEventHandler<HTMLLabelElement>;
        onWheelCapture?: WheelEventHandler<HTMLLabelElement>;
        render?: DOMRenderFunction<"label", RadioRenderProps>;
        slot?: string | null;
        style?: StyleOrFunction<RadioRenderProps>;
        translate?: "yes" | "no";
        value: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    aria-describedby? aria-details? aria-label? aria-labelledby? autoFocus? children? className? dir? hidden? id? inert? inputRef? isDisabled? lang? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBlur? onClick? onClickCapture? onContextMenu? onContextMenuCapture? onDoubleClick? onDoubleClickCapture? onFocus? onFocusChange? onGotPointerCapture? onGotPointerCaptureCapture? onHoverChange? onHoverEnd? onHoverStart? onKeyDown? onKeyUp? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onPress? onPressChange? onPressEnd? onPressStart? onPressUp? onScroll? onScrollCapture? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionCancel? onTransitionCancelCapture? onTransitionEnd? onTransitionEndCapture? onTransitionRun? onTransitionRunCapture? onTransitionStart? onTransitionStartCapture? onWheel? onWheelCapture? render? slot? style? translate? value

    Properties

    "aria-describedby"?: string

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

    "aria-details"?: string

    Identifies the element (or elements) that provide a detailed, extended description for the object.

    "aria-label"?: string

    Defines a string value that labels the current element.

    "aria-labelledby"?: string

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

    autoFocus?: boolean

    Whether the element should receive focus on render.

    children?: ChildrenOrFunction<RadioRenderProps>

    The children of the component. A function may be provided to alter the children based on component state.

    className?: string
    dir?: string
    hidden?: boolean
    id?: string

    The element's unique identifier. See MDN.

    inert?: boolean
    inputRef?: RefObject<HTMLInputElement | null>

    A ref for the HTML input element.

    isDisabled?: boolean

    Whether the radio button is disabled or not. Shows that a selection exists, but is not available in that circumstance.

    lang?: string
    onAnimationEnd?: AnimationEventHandler<HTMLLabelElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLLabelElement>
    onAnimationIteration?: AnimationEventHandler<HTMLLabelElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLLabelElement>
    onAnimationStart?: AnimationEventHandler<HTMLLabelElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLLabelElement>
    onAuxClick?: MouseEventHandler<HTMLLabelElement>
    onAuxClickCapture?: MouseEventHandler<HTMLLabelElement>
    onBlur?: (e: FocusEvent<Element>) => void

    Handler that is called when the element loses focus.

    onClick?: (e: MouseEvent<FocusableElement>) => void

    Not recommended – use onPress instead. onClick is an alias for onPress provided for compatibility with other libraries. onPress provides additional event details for non-mouse interactions.

    onClickCapture?: MouseEventHandler<HTMLLabelElement>
    onContextMenu?: MouseEventHandler<HTMLLabelElement>
    onContextMenuCapture?: MouseEventHandler<HTMLLabelElement>
    onDoubleClick?: MouseEventHandler<HTMLLabelElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLLabelElement>
    onFocus?: (e: FocusEvent<Element>) => void

    Handler that is called when the element receives focus.

    onFocusChange?: (isFocused: boolean) => void

    Handler that is called when the element's focus status changes.

    onGotPointerCapture?: PointerEventHandler<HTMLLabelElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLLabelElement>
    onHoverChange?: (isHovering: boolean) => void

    Handler that is called when the hover state changes.

    onHoverEnd?: (e: HoverEvent) => void

    Handler that is called when a hover interaction ends.

    onHoverStart?: (e: HoverEvent) => void

    Handler that is called when a hover interaction starts.

    onKeyDown?: (e: KeyboardEvent) => void

    Handler that is called when a key is pressed.

    onKeyUp?: (e: KeyboardEvent) => void

    Handler that is called when a key is released.

    onLostPointerCapture?: PointerEventHandler<HTMLLabelElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLLabelElement>
    onMouseDown?: MouseEventHandler<HTMLLabelElement>
    onMouseDownCapture?: MouseEventHandler<HTMLLabelElement>
    onMouseEnter?: MouseEventHandler<HTMLLabelElement>
    onMouseLeave?: MouseEventHandler<HTMLLabelElement>
    onMouseMove?: MouseEventHandler<HTMLLabelElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLLabelElement>
    onMouseOut?: MouseEventHandler<HTMLLabelElement>
    onMouseOutCapture?: MouseEventHandler<HTMLLabelElement>
    onMouseOver?: MouseEventHandler<HTMLLabelElement>
    onMouseOverCapture?: MouseEventHandler<HTMLLabelElement>
    onMouseUp?: MouseEventHandler<HTMLLabelElement>
    onMouseUpCapture?: MouseEventHandler<HTMLLabelElement>
    onPointerCancel?: PointerEventHandler<HTMLLabelElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLLabelElement>
    onPointerDown?: PointerEventHandler<HTMLLabelElement>
    onPointerDownCapture?: PointerEventHandler<HTMLLabelElement>
    onPointerEnter?: PointerEventHandler<HTMLLabelElement>
    onPointerLeave?: PointerEventHandler<HTMLLabelElement>
    onPointerMove?: PointerEventHandler<HTMLLabelElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLLabelElement>
    onPointerOut?: PointerEventHandler<HTMLLabelElement>
    onPointerOutCapture?: PointerEventHandler<HTMLLabelElement>
    onPointerOver?: PointerEventHandler<HTMLLabelElement>
    onPointerOverCapture?: PointerEventHandler<HTMLLabelElement>
    onPointerUp?: PointerEventHandler<HTMLLabelElement>
    onPointerUpCapture?: PointerEventHandler<HTMLLabelElement>
    onPress?: (e: PressEvent) => void

    Handler that is called when the press is released over the target.

    onPressChange?: (isPressed: boolean) => void

    Handler that is called when the press state changes.

    onPressEnd?: (e: PressEvent) => void

    Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.

    onPressStart?: (e: PressEvent) => void

    Handler that is called when a press interaction starts.

    onPressUp?: (e: PressEvent) => void

    Handler that is called when a press is released over the target, regardless of whether it started on the target or not.

    onScroll?: UIEventHandler<HTMLLabelElement>
    onScrollCapture?: UIEventHandler<HTMLLabelElement>
    onTouchCancel?: TouchEventHandler<HTMLLabelElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLLabelElement>
    onTouchEnd?: TouchEventHandler<HTMLLabelElement>
    onTouchEndCapture?: TouchEventHandler<HTMLLabelElement>
    onTouchMove?: TouchEventHandler<HTMLLabelElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLLabelElement>
    onTouchStart?: TouchEventHandler<HTMLLabelElement>
    onTouchStartCapture?: TouchEventHandler<HTMLLabelElement>
    onTransitionCancel?: TransitionEventHandler<HTMLLabelElement>
    onTransitionCancelCapture?: TransitionEventHandler<HTMLLabelElement>
    onTransitionEnd?: TransitionEventHandler<HTMLLabelElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLLabelElement>
    onTransitionRun?: TransitionEventHandler<HTMLLabelElement>
    onTransitionRunCapture?: TransitionEventHandler<HTMLLabelElement>
    onTransitionStart?: TransitionEventHandler<HTMLLabelElement>
    onTransitionStartCapture?: TransitionEventHandler<HTMLLabelElement>
    onWheel?: WheelEventHandler<HTMLLabelElement>
    onWheelCapture?: WheelEventHandler<HTMLLabelElement>
    render?: DOMRenderFunction<"label", RadioRenderProps>

    Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components.

    Requirements:

    • You must render the expected element type (e.g. if <button> is expected, you cannot render an <a>).
    • Only a single root DOM element can be rendered (no fragments).
    • You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
    slot?: string | null

    A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.

    style?: StyleOrFunction<RadioRenderProps>

    The inline style for the element. A function may be provided to compute the style based on component state.

    translate?: "yes" | "no"
    value: string

    The value of the radio button, used when submitting an HTML form. See MDN.

    Settings

    Member Visibility

    On This Page

    Properties
    aria-describedbyaria-detailsaria-labelaria-labelledbyautoFocuschildrenclassNamedirhiddenidinertinputRefisDisabledlangonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBluronClickonClickCaptureonContextMenuonContextMenuCaptureonDoubleClickonDoubleClickCaptureonFocusonFocusChangeonGotPointerCaptureonGotPointerCaptureCaptureonHoverChangeonHoverEndonHoverStartonKeyDownonKeyUponLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonPressonPressChangeonPressEndonPressStartonPressUponScrollonScrollCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonWheelonWheelCapturerenderslotstyletranslatevalue