beez-ui 2.7.0 → 3.0.0

package/dist/components/radio-group.d.ts

@@ -1,21 +1,34 @@
-import type { ComponentProps } from "react";
-import { RadioGroup as RadioGroupPrimitive } from "radix-ui";
-/**
- * Hosts the radios, controlled or uncontrolled like Radix's radio group, and moves the highlight of option rows.
- * @param radioGroupProps - Every Radix radio group prop, including `ref`.
- * @returns The radio group.
- */
-declare function RadioGroup({ className, children, value, defaultValue, onValueChange, ref, asChild, ...props }: ComponentProps<typeof RadioGroupPrimitive.Root>): import("react").JSX.Element;
-export type RadioGroupItemProps = ComponentProps<typeof RadioGroupPrimitive.Item> & {
-    /** Visible option label: turns the item into Arc's option row, which also names the radio. */
-    label?: string;
-    /** Helper copy under the label, linked through `aria-describedby`. Shown only with a `label`. */
+/** One choice of a radio group. */
+export type RadioGroupOption = {
+    /** Value reported to `onValueChange` and submitted with the form. */
+    value: string;
+    /** Visible option label, which also names the radio. */
+    label: string;
+    /** Helper copy under the label, linked through `aria-describedby`. */
     description?: string;
+    /** Keeps the option visible but not selectable. */
+    disabled?: boolean;
+};
+export type RadioGroupProps = {
+    /** Visible legend of the fieldset, which names the group. */
+    label: string;
+    /** Rows in order. Values double as keys, so keep them unique. */
+    options: RadioGroupOption[];
+    /** Selected value when controlled. */
+    value?: string;
+    /** Initial value when uncontrolled; a form reset restores it. */
+    defaultValue?: string;
+    /** Called with the chosen value. */
+    onValueChange?: (value: string) => void;
+    /** Name the chosen value is submitted under. Generated when omitted. */
+    name?: string;
+    /** Classes for the fieldset. */
+    className?: string;
 };
 /**
- * One radio of the group: a bare mark, or Arc's option row when it receives a `label`.
- * @param radioGroupItemProps - Every Radix radio item prop, including `ref`, plus optional Arc `label` and `description`.
- * @returns The radio, wrapped in its option row when it has a label.
+ * A choice of one option from a visible set, controlled with `value` or uncontrolled with `defaultValue`.
+ * @param props - Legend, options, value, change handler, form name and classes.
+ * @returns The fieldset with its legend and option rows.
  */
-declare function RadioGroupItem({ className, label, description, id, value, ...props }: RadioGroupItemProps): import("react").JSX.Element;
-export { RadioGroup, RadioGroupItem };
+declare function RadioGroup({ label, options, value, defaultValue, onValueChange, name, className }: RadioGroupProps): import("react").JSX.Element;
+export { RadioGroup };