common-intellisense/scripts/nextui/CheckboxGroup.json

%description%

{
  "props": [
    {
      "Attribute": "children",
      "Type": "`ReactNode[]` | `ReactNode[]`",
      "Description": "The checkboxes items.",
      "Default": "-"
    },
    {
      "Attribute": "orientation",
      "Type": "`vertical` | `horizontal`",
      "Description": "The axis the checkbox group items should align with.",
      "Default": "`vertical`"
    },
    {
      "Attribute": "color",
      "Type": "`default` | `primary` | `secondary` | `success` | `warning` | `danger`",
      "Description": "The color of the checkboxes.",
      "Default": "`primary`"
    },
    {
      "Attribute": "size",
      "Type": "`xs` | `sm` | `md` | `lg` | `xl`",
      "Description": "The size of the checkboxes.",
      "Default": "`md`"
    },
    {
      "Attribute": "radius",
      "Type": "`none` | `base` | `xs` | `sm` | `md` | `lg` | `xl` | `full`",
      "Description": "The radius of the checkboxes.",
      "Default": "`md`"
    },
    {
      "Attribute": "name",
      "Type": "`string`",
      "Description": "The name of the CheckboxGroup, used when submitting an HTML form.",
      "Default": "-"
    },
    {
      "Attribute": "value",
      "Type": "`string[]`",
      "Description": "The current selected values. (controlled).",
      "Default": "-"
    },
    {
      "Attribute": "lineThrough",
      "Type": "`boolean`",
      "Description": "Whether the checkboxes label should be crossed out.",
      "Default": "`false`"
    },
    {
      "Attribute": "defaultValue",
      "Type": "`string[]`",
      "Description": "The default selected values. (uncontrolled).",
      "Default": "-"
    },
    {
      "Attribute": "isInvalid",
      "Type": "`boolean`",
      "Description": "Whether the checkbox 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": "-"
    },
    {
      "Attribute": "description",
      "Type": "`ReactNode`",
      "Description": "The checkbox group description.",
      "Default": "-"
    },
    {
      "Attribute": "errorMessage",
      "Type": "`ReactNode`",
      "Description": "The checkbox group error message.",
      "Default": "-"
    },
    {
      "Attribute": "isDisabled",
      "Type": "`boolean`",
      "Description": "Whether the checkbox 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": "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 checkbox group slots.",
      "Default": "-"
    }
  ],
  "link": "https://nextui.org/docs/components/checkbox",
  "events": [
    {
      "Attribute": "onChange",
      "Type": "`((value: string[]) => void)`",
      "Description": "Handler that is called when the value changes."
    }
  ]
}