common-intellisense/scripts/nextui/RadioGroup.json

%description%

{
  "props": [
    {
      "Attribute": "children",
      "Type": "`ReactNode` | `ReactNode[]`",
      "Description": "The list of radio elements.",
      "Default": "-"
    },
    {
      "Attribute": "label",
      "Type": "`ReactNode`",
      "Description": "The label of the radio group.",
      "Default": "-"
    },
    {
      "Attribute": "size",
      "Type": "`sm` | `md` | `lg`",
      "Description": "The size of the radios.",
      "Default": "`md`"
    },
    {
      "Attribute": "color",
      "Type": "`default` | `primary` | `secondary` | `success` | `warning` | `danger`",
      "Description": "The color of the radios.",
      "Default": "`primary`"
    },
    {
      "Attribute": "orientation",
      "Type": "`horizontal` | `vertical`",
      "Description": "The orientation of the radio group.",
      "Default": "`vertical`"
    },
    {
      "Attribute": "name",
      "Type": "`string`",
      "Description": "The name of the RadioGroup, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name_and_radio_buttons).",
      "Default": "-"
    },
    {
      "Attribute": "value",
      "Type": "`string[]`",
      "Description": "The current selected value. (controlled).",
      "Default": "-"
    },
    {
      "Attribute": "defaultValue",
      "Type": "`string[]`",
      "Description": "The default selected value. (uncontrolled).",
      "Default": "-"
    },
    {
      "Attribute": "description",
      "Type": "`ReactNode`",
      "Description": "Radio group description .",
      "Default": "-"
    },
    {
      "Attribute": "errorMessage",
      "Type": "`ReactNode`",
      "Description": "Radio group error message.",
      "Default": "-"
    },
    {
      "Attribute": "isDisabled",
      "Type": "`boolean`",
      "Description": "Whether the radio group is disabled.",
      "Default": "`false`"
    },
    {
      "Attribute": "isRequired",
      "Type": "`boolean`",
      "Description": "Whether user checkboxes are required on the input before form submission.",
      "Default": "`false`"
    },
    {
      "Attribute": "isReadOnly",
      "Type": "`boolean`",
      "Description": "Whether the checkboxes can be selected but not changed by the user.",
      "Default": "-"
    },
    {
      "Attribute": "isInvalid",
      "Type": "`boolean`",
      "Description": "Whether the radio group is invalid.",
      "Default": "`false`"
    },
    {
      "Attribute": "validationState",
      "Type": "`valid` | `invalid`",
      "Description": "Whether the inputs should display its \"valid\" or \"invalid\" visual styling. (**Deprecated**) use **isInvalid** instead.",
      "Default": "`false`"
    },
    {
      "Attribute": "disableAnimation",
      "Type": "`boolean`",
      "Description": "Whether the animation should be disabled.",
      "Default": "`false`"
    },
    {
      "Attribute": "classNames",
      "Type": "`Record<\"base\"｜ \"wrapper\"｜ \"label\", string>`",
      "Description": "Allows to set custom class names for the radio group slots.",
      "Default": "-"
    }
  ],
  "link": "https://nextui.org/docs/components/radiogroup",
  "events": [
    {
      "Attribute": "onChange",
      "Type": "`React.ChangeEvent<HTMLInputElement>`",
      "Description": "Handler that is called when the element's value changes. You can pull out the new value by accessing `event.target.value` (string)."
    },
    {
      "Attribute": "onValueChange",
      "Type": "`((value: string) => void)`",
      "Description": "Handler that is called when the value changes."
    }
  ]
}