@ark-ui/vue/dist/components/radio-group/radio-group.types.d.ts

A collection of unstyled, accessible UI components for Vue, utilizing state machines for seamless interaction.

import type * as radioGroup from '@zag-js/radio-group';
export interface RootProps {
    /**
     * The initial value of the checked radio when rendered.
     * Use when you don't need to control the value of the radio group.
     */
    defaultValue?: string | null;
    /**
     * If `true`, the radio group will be disabled
     */
    disabled?: boolean;
    /**
     * The associate form of the underlying input.
     */
    form?: string;
    /**
     * The unique identifier of the machine.
     */
    id?: string;
    /**
     * The ids of the elements in the radio. Useful for composition.
     */
    ids?: Partial<{
        root: string;
        label: string;
        indicator: string;
        item(value: string): string;
        itemLabel(value: string): string;
        itemControl(value: string): string;
        itemHiddenInput(value: string): string;
    }>;
    /**
     * The v-model value of the radio group
     */
    modelValue?: string | null;
    /**
     * The name of the input fields in the radio
     * (Useful for form submission).
     */
    name?: string;
    /**
     * Orientation of the radio group
     */
    orientation?: 'horizontal' | 'vertical';
    /**
     * Whether the checkbox is read-only
     */
    readOnly?: boolean;
}
export type RootEmits = {
    /**
     * Function called once a radio is checked
     */
    valueChange: [details: radioGroup.ValueChangeDetails];
    /**
     * The callback fired when the model value changes.
     */
    'update:modelValue': [value: radioGroup.ValueChangeDetails['value']];
};