@redsift/ds-mcp-server 12.3.1-muiv6-alpha.2

package/data/docs/components/pickers/BaseCombobox.json

@@ -0,0 +1,320 @@
+{
+  "name": "BaseCombobox",
+  "description": "Combobox combines a text input with a filterable dropdown list.\nSupports single or multiple selection with type-ahead filtering.\n\nVariants:\n- `options`: Shows predefined options only (default)\n- `freeform`: Allows custom values not in the list\n\nSelection modes: `single`, `multiple`",
+  "package": "@redsift/pickers",
+  "filePath": "packages/pickers/src/components/combobox/Combobox.tsx",
+  "props": [
+    {
+      "name": "variant",
+      "description": "If 'options', the input field cannot have free text, the selection has to be made within the options. If 'suggestions', then choosing from the list isn't mandatory and the user can write free text within the input.",
+      "type": [
+        "\"options\"",
+        "\"suggestions\""
+      ],
+      "required": false,
+      "defaultValue": "'options'",
+      "category": "props"
+    },
+    {
+      "name": "defaultValue",
+      "description": "Default selected value.\nUsed for uncontrolled version.",
+      "type": [
+        "string",
+        "string[]"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "description",
+      "description": "Description of the combobox.",
+      "type": [
+        "string",
+        "ReactElement<any, string | JSXElementConstructor<any>>"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "descriptionProps",
+      "description": "Additional description properties.",
+      "type": "Omit<TextProps, \"ref\">",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "filter",
+      "description": "Filtering parameters.",
+      "type": "{ type: \"startsWith\" | \"contains\" | \"endsWith\"; caseSensitive?: boolean | undefined; }",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "formRef",
+      "description": "Ref to the form, if any.",
+      "type": "RefObject<HTMLFormElement>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "submitRef",
+      "description": "Ref to the submit button, if any.",
+      "type": "RefObject<HTMLButtonElement>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isDisabled",
+      "description": "Whether the component is disabled or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isInvalid",
+      "description": "Whether the component is invalid or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "maxOptionsLength",
+      "description": "Maximum number of options displayed. Useful when too many options are displayed.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onChange",
+      "description": "Method to handle selection change.",
+      "type": "(value: ComboboxValue) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onInputChange",
+      "description": "Method to handle input change.",
+      "type": "(value: string) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "value",
+      "description": "Currently selected value.\nUsed for controlled version.",
+      "type": [
+        "string",
+        "string[]"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "inputValue",
+      "description": "Input value.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "selectionMode",
+      "description": "Whether the Combobox allow multiple selection or not.",
+      "type": [
+        "\"single\"",
+        "\"multiple\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "theme",
+      "description": "Theme.",
+      "type": [
+        "\"light\"",
+        "\"dark\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "triggerClassName",
+      "description": "Class name to append to the trigger.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "wrapperProps",
+      "description": "Props to forward to the wrapper.",
+      "type": "Omit<FlexboxProps, \"ref\">",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "width",
+      "description": "Popover content width. Can be either based on the trigger, the available space or define with a number of pixels.",
+      "type": [
+        "number",
+        "\"trigger-width\"",
+        "\"available-width\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "minWidth",
+      "description": "Popover content min width. Can be either based on the trigger, the available space or define with a number of pixels.",
+      "type": [
+        "number",
+        "\"trigger-width\"",
+        "\"available-width\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "maxWidth",
+      "description": "Popover content max width. Can be either based on the trigger, the available space or define with a number of pixels.",
+      "type": [
+        "number",
+        "\"trigger-width\"",
+        "\"available-width\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "color",
+      "description": "Button color that will be forward to the trigger.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "children",
+      "description": "Children. Can only be PopoverTrigger and PopoverContent.",
+      "type": "ReactNode",
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "defaultOpen",
+      "description": "Default open status.\nUsed for uncontrolled version.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "placement",
+      "description": "Default placement of the popover.",
+      "type": [
+        "\"top\"",
+        "\"bottom\"",
+        "\"left\"",
+        "\"right\"",
+        "\"top-start\"",
+        "\"top-end\"",
+        "\"right-start\"",
+        "\"right-end\"",
+        "\"bottom-start\"",
+        "\"bottom-end\"",
+        "\"left-start\"",
+        "\"left-end\""
+      ],
+      "required": false,
+      "defaultValue": "'bottom'",
+      "category": "props"
+    },
+    {
+      "name": "isModal",
+      "description": "Whether the popover is a modal or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": "false",
+      "category": "props"
+    },
+    {
+      "name": "isOpen",
+      "description": "Whether the component is opened or not.\nUsed for controlled version.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "offset",
+      "description": "Space between trigger and content (in pixels).",
+      "type": "number",
+      "required": false,
+      "defaultValue": "2",
+      "category": "props"
+    },
+    {
+      "name": "onOpen",
+      "description": "Method to handle component change.",
+      "type": "(open: boolean) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "overrideDisplayName",
+      "description": "Allows other components to be treated as trigger and content.",
+      "type": "{ content?: string | undefined; trigger?: string | undefined; }",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "role",
+      "description": "Role to apply to the popover.",
+      "type": [
+        "\"dialog\"",
+        "\"menu\"",
+        "\"listbox\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}