UNPKG

common-intellisense

Version:
96 lines (95 loc) 3.08 kB
{ "props": [ { "Attribute": "children", "Type": "`ReactNode[]`", "Description": "The children to render. Usually a list of `ListboxItem` or `ListboxSection`", "Default": "-" }, { "Attribute": "items", "Type": "[`Iterable<T>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols)", "Description": "Item objects in the collection. (dynamic)", "Default": "-" }, { "Attribute": "variant", "Type": "`solid` | `bordered` | `light` | `flat` | `faded` | `shadow`", "Description": "The listbox items appearance style.", "Default": "`solid`" }, { "Attribute": "color", "Type": "`default` | `primary` | `secondary` | `success` | `warning` | `danger`", "Description": "The listbox items color theme.", "Default": "`default`" }, { "Attribute": "selectionMode", "Type": "`none` | `single` | `multiple`", "Description": "The type of selection that is allowed in the collection.", "Default": "-" }, { "Attribute": "selectedKeys", "Type": "`React.Key[]`", "Description": "The currently selected keys in the collection (controlled).", "Default": "-" }, { "Attribute": "disabledKeys", "Type": "`React.Key[]`", "Description": "The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with.", "Default": "-" }, { "Attribute": "defaultSelectedKeys", "Type": "`all` | `React.Key[]`", "Description": "The initial selected keys in the collection (uncontrolled).", "Default": "-" }, { "Attribute": "disallowEmptySelection", "Type": "`boolean`", "Description": "Whether the collection allows empty selection.", "Default": "`false`" }, { "Attribute": "autoFocus", "Type": "`boolean` | `first` | `last`", "Description": "Where the focus should be set.", "Default": "`false`" }, { "Attribute": "shouldFocusWrap", "Type": "`boolean`", "Description": "Whether keyboard navigation is circular.", "Default": "`false`" }, { "Attribute": "disableAnimation", "Type": "`boolean`", "Description": "Whether to disable the animation of the listbox items.", "Default": "`false`" }, { "Attribute": "itemClasses", "Type": "`Record<\"base\"\"wrapper\"\"title\"\"description\"\"selectedIcon\", string>`", "Description": "Allows to set custom class names for the listbox item slots.", "Default": "-" } ], "link": "https://nextui.org/docs/components/listbox", "events": [ { "Attribute": "onAction", "Type": "`(key: React.Key) => void`", "Description": "Handler that is called when an item is selected." }, { "Attribute": "onSelectionChange", "Type": "`(keys: React.Key[]) => void`", "Description": "Handler that is called when the selection changes." } ] }