@antadesign/anta
    Preparing search index...

    Interface RadioOptionUnreviewed

    One option in a <RadioGroup>. The wrapper renders an <a-radio> per entry.

    interface RadioOption {
        value: string;
        label?: ReactNode;
        hint?: ReactNode;
        disabled?: boolean;
        tone?:
            | "brand"
            | "neutral"
            | "info"
            | "success"
            | "warning"
            | "critical"
            | string & {};
        toneScope?: ToneScope;
        size?: "small"
        | "medium"
        | "large";
        className?: string;
        style?: CSSProperties;
        [key: `data-${string}`]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: `data-${string}`]: unknown

      Additional data attributes on the option's rendered row.

    Index
    value label? hint? disabled? tone? toneScope? size? className? style?
    value: string

    This option's identity and the value submitted when it's selected. Must be unique within the group (a dev-only warning fires on duplicates).

    label?: ReactNode

    The visible label.

    hint?: ReactNode

    Secondary text under the label and exposed as this radio option's accessible description.

    disabled?: boolean

    Disable just this option (skipped by keyboard, dropped from the tab order).

    tone?:
        | "brand"
        | "neutral"
        | "info"
        | "success"
        | "warning"
        | "critical"
        | string & {}

    Override this one option's mark tone (defaults to the group's tone).

    toneScope?: ToneScope

    Override this option's tone scope. The group scope is inherited when omitted.

    size?: "small" | "medium" | "large"

    Override this one option's size (defaults to the group's size).

    className?: string

    CSS class on the option's rendered row.

    style?: CSSProperties

    Inline styles on the option's rendered row.

    Settings
    Member Visibility

    On This Page
    Properties