Askr documentation
Generated API snapshot

@askrjs/ui/radio-group

Exports from the declarations published in @askrjs/ui. Signatures reflect the published artifact.

Exports

This entrypoint publishes 9 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

RADIO_GROUP_A11Y_CONTRACTtype

RADIO_GROUP_A11Y_CONTRACT: { readonly GROUP_ROLE: "radiogroup"; readonly ITEM_ROLE: "radio"; readonly CHECKED_ATTRIBUTE: "aria-checked"; readonly ORIENTATION_ATTRIBUTE: "aria-orientation"; readonly DATA_ATTRIBUTES: { readonly slot: "data-slot"; readonly state: "data-state"; readonly disabled: "data-disabled"; readonly orientation: "data-orientation"; }; readonly KEYBOARD_NAVIGATION: readonly ["ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown"]; readonly ROVING_FOCUS: { readonly activeItemTabIndex: 0; readonly inactiveItemTabIndex: -1; }; readonly FORM_INTEGRATION: { readonly hiddenInputType: "hidden"; }; }

WAI-ARIA Radio Group Pattern Specification: https://www.w3.org/WAI/ARIA/apg/patterns/radio/

RadioGrouptype

RadioGroup: (props: RadioGroupProps) => JSX.Element

Renders a part of `radio-group`.

RadioGroupA11yContracttype

RadioGroupA11yContract: typeof RADIO_GROUP_A11Y_CONTRACT

Type of the Radio Group A11y Contract object.

RadioGroupItemtype

RadioGroupItem: { (props: RadioGroupItemProps): JSX.Element; (props: RadioGroupItemAsChildProps): JSX.Element; }

Renders the `radio-group-item` part of `radio-group` with `role="radio"`. Supports polymorphic rendering via `asChild`.

RadioGroupItemAsChildPropstype

RadioGroupItemAsChildProps: RadioGroupItemOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<Element>;
}

Props for the `asChild` (polymorphic) rendering of Radio Group Item.

asChild
asChild: true;
children
children: JSXElement;
disabled
disabled?: boolean | undefined;
ref
ref?: Ref<Element>;
value
value: string;

RadioGroupItemOwnPropstype

RadioGroupItemOwnProps: {
  value: string;
  disabled?: boolean;
  children?: unknown;
}

Own props for Radio Group Item, before merging with native element attributes.

children
children?: unknown;
disabled
disabled?: boolean | undefined;
value
value: string;

RadioGroupItemPropstype

RadioGroupItemProps: Omit<JSX.IntrinsicElements['button'], 'children' | 'ref' | 'onClick' | 'type' | 'value'> & RadioGroupItemOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLButtonElement>;
}

Props for Radio Group Item.

asChild
asChild?: false | undefined;
children
children?: unknown;
ref
ref?: Ref<HTMLButtonElement>;
value
value: string;

RadioGroupOwnPropstype

RadioGroupOwnProps: {
  value?: string;
  defaultValue?: string;
  onValueChange?: (value: string) => void;
  disabled?: boolean;
  name?: string;
  orientation?: Orientation;
  loop?: boolean;
  /** Supports literal, nested, array-mapped, and `For`-rendered descendants. */
  children?: unknown;
}

Own props for Radio Group, before merging with native element attributes.

children
Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue
defaultValue?: string | undefined;
disabled
disabled?: boolean | undefined;
loop
loop?: boolean | undefined;
name
name?: string | undefined;
onValueChange
onValueChange?: ((value: string) => void) | undefined;
orientation
orientation?: Orientation | undefined;
value
value?: string | undefined;

RadioGroupPropstype

RadioGroupProps: Omit<JSX.IntrinsicElements['div'], 'children' | 'ref'> & RadioGroupOwnProps & {
  ref?: Ref<HTMLDivElement>;
}

Props for Radio Group.

children
Supports literal, nested, array-mapped, and `For`-rendered descendants.
defaultValue
defaultValue?: string | undefined;
disabled
disabled?: boolean | undefined;
loop
loop?: boolean | undefined;
name
name?: string | undefined;
onValueChange
onValueChange?: ((value: string) => void) | undefined;
orientation
orientation?: Orientation | undefined;
ref
ref?: Ref<HTMLDivElement>;
value
value?: string | undefined;