docs: update types and storydocs

chakra-ui · Jul 29, 2023 · 3ad8c35 · 3ad8c35 · vercel · Jul 29, 2023
1 parent 45b79f9
commit 3ad8c35
Show file tree

Hide file tree

Showing 28 changed files with 927 additions and 25 deletions.
diff --git a/packages/react/src/accordion/docs/accordion.types.json b/packages/react/src/accordion/docs/accordion.types.json
@@ -46,6 +46,10 @@
       "isRequired": false,
       "description": "The orientation of the accordion items."
     },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    },
     "value": {
       "type": "string | string[]",
       "isRequired": false,
@@ -60,6 +64,10 @@
     },
     "onExitComplete": { "type": "() => void", "isRequired": false },
     "present": { "type": "boolean", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    },
     "unmountOnExit": {
       "type": "boolean",
       "isRequired": false,
@@ -68,6 +76,16 @@
   },
   "AccordionItemProps": {
     "value": { "type": "string", "isRequired": true },
-    "disabled": { "type": "boolean", "isRequired": false }
+    "disabled": { "type": "boolean", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "AccordionTriggerProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLButtonElement | null) => void)\n  | RefObject<HTMLButtonElement>",
+      "isRequired": false
+    }
   }
 }
diff --git a/packages/react/src/avatar/docs/avatar.types.json b/packages/react/src/avatar/docs/avatar.types.json
@@ -11,6 +11,22 @@
       "description": "The unique identifier of the machine."
     },
     "onError": { "type": "() => void", "isRequired": false },
-    "onLoad": { "type": "() => void", "isRequired": false }
+    "onLoad": { "type": "() => void", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "AvatarFallbackProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLSpanElement | null) => void)\n  | RefObject<HTMLSpanElement>",
+      "isRequired": false
+    }
+  },
+  "AvatarImageProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLImageElement | null) => void)\n  | RefObject<HTMLImageElement>",
+      "isRequired": false
+    }
   }
 }
diff --git a/packages/react/src/carousel/docs/carousel.types.json b/packages/react/src/carousel/docs/carousel.types.json
@@ -41,6 +41,10 @@
       "isRequired": false,
       "description": "The orientation of the carousel."
     },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    },
     "slidesPerView": {
       "type": "number | 'auto'",
       "isRequired": false,
@@ -52,9 +56,37 @@
       "description": "The amount of space between slides."
     }
   },
+  "CarouselControlProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
   "CarouselIndicatorProps": {
     "index": { "type": "number", "isRequired": true },
-    "readOnly": { "type": "boolean", "isRequired": false }
+    "readOnly": { "type": "boolean", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLButtonElement | null) => void)\n  | RefObject<HTMLButtonElement>",
+      "isRequired": false
+    }
+  },
+  "CarouselSlideProps": {
+    "index": { "type": "number", "isRequired": true },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
   },
-  "CarouselSlideProps": { "index": { "type": "number", "isRequired": true } }
+  "CarouselSlideGroupProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "CarouselViewportProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  }
 }
diff --git a/packages/react/src/checkbox/docs/checkbox.types.json b/packages/react/src/checkbox/docs/checkbox.types.json
@@ -50,6 +50,10 @@
       "isRequired": false,
       "description": "The callback invoked when the checked state of the `Checkbox` changes."
     },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLLabelElement | null) => void)\n  | RefObject<HTMLLabelElement>",
+      "isRequired": false
+    },
     "required": {
       "type": "boolean",
       "isRequired": false,
@@ -60,5 +64,23 @@
       "isRequired": false,
       "description": "The value of checkbox input. Useful for form submission."
     }
+  },
+  "CheckboxControlProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "CheckboxInputProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLInputElement | null) => void)\n  | RefObject<HTMLInputElement>",
+      "isRequired": false
+    }
+  },
+  "CheckboxLabelProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLSpanElement | null) => void)\n  | RefObject<HTMLSpanElement>",
+      "isRequired": false
+    }
   }
 }
diff --git a/packages/react/src/color-picker/docs/color-picker.types.json b/packages/react/src/color-picker/docs/color-picker.types.json
@@ -45,10 +45,30 @@
   },
   "ColorPickerAreaProps": {
     "xChannel": { "type": "ColorChannel", "isRequired": true },
-    "yChannel": { "type": "ColorChannel", "isRequired": true }
+    "yChannel": { "type": "ColorChannel", "isRequired": true },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "ColorPickerAreaThumbProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "ColorPickerContentProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
   },
   "ColorPickerSwatchProps": {
     "value": { "type": "string | Color", "isRequired": true },
-    "readOnly": { "type": "boolean", "isRequired": false }
+    "readOnly": { "type": "boolean", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLButtonElement | null) => void)\n  | RefObject<HTMLButtonElement>",
+      "isRequired": false
+    }
   }
 }
diff --git a/packages/react/src/combobox/docs/combobox.types.json b/packages/react/src/combobox/docs/combobox.types.json
@@ -135,6 +135,10 @@
       "isRequired": false,
       "description": "Whether the combobox is readonly. This puts the combobox in a \"non-editable\" mode\nbut the user can still interact with it"
     },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    },
     "selectInputOnFocus": {
       "type": "boolean",
       "isRequired": false,
@@ -169,12 +173,34 @@
     },
     "onExitComplete": { "type": "() => void", "isRequired": false },
     "present": { "type": "boolean", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLUListElement | null) => void)\n  | RefObject<HTMLUListElement>",
+      "isRequired": false
+    },
     "unmountOnExit": {
       "type": "boolean",
       "isRequired": false,
       "description": "Whether to unmount on exit. Defaults to `false`."
     }
   },
+  "ComboboxControlProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "ComboboxInputProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLInputElement | null) => void)\n  | RefObject<HTMLInputElement>",
+      "isRequired": false
+    }
+  },
+  "ComboboxLabelProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLLabelElement | null) => void)\n  | RefObject<HTMLLabelElement>",
+      "isRequired": false
+    }
+  },
   "ComboboxOptionProps": {
     "label": {
       "type": "string",
@@ -200,6 +226,22 @@
       "type": "number",
       "isRequired": false,
       "description": "The index of the option. Used to set the `aria-posinset` attribute\nand allow options with same value"
+    },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLLIElement | null) => void)\n  | RefObject<HTMLLIElement>",
+      "isRequired": false
+    }
+  },
+  "ComboboxPositionerProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "ComboboxTriggerProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLButtonElement | null) => void)\n  | RefObject<HTMLButtonElement>",
+      "isRequired": false
     }
   }
 }
diff --git a/packages/react/src/date-picker/docs/date-picker.types.json b/packages/react/src/date-picker/docs/date-picker.types.json
@@ -124,24 +124,112 @@
     "value": { "type": "DateValue[]", "isRequired": false, "description": "The selected date(s)." },
     "view": { "type": "DateView", "isRequired": false, "description": "The view of the calendar" }
   },
+  "DatePickerContentProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "DatePickerControlProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
   "DatePickerDayCellProps": {
     "value": { "type": "DateValue", "isRequired": true },
     "disabled": { "type": "boolean", "isRequired": false },
-    "offset": { "type": "Offset", "isRequired": false }
+    "offset": { "type": "Offset", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
   },
   "DatePickerGridProps": {
     "columns": { "type": "number", "isRequired": false },
     "id": { "type": "string", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    },
     "view": { "type": "DateView", "isRequired": false }
   },
+  "DatePickerInputProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLInputElement | null) => void)\n  | RefObject<HTMLInputElement>",
+      "isRequired": false
+    }
+  },
   "DatePickerMonthCellProps": {
     "value": { "type": "number", "isRequired": true },
-    "disabled": { "type": "boolean", "isRequired": false }
+    "disabled": { "type": "boolean", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "DatePickerMonthSelectProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLSelectElement | null) => void)\n  | RefObject<HTMLSelectElement>",
+      "isRequired": false
+    }
+  },
+  "DatePickerNextTriggerProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLButtonElement | null) => void)\n  | RefObject<HTMLButtonElement>",
+      "isRequired": false
+    }
+  },
+  "DatePickerPrevTriggerProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLButtonElement | null) => void)\n  | RefObject<HTMLButtonElement>",
+      "isRequired": false
+    },
+    "view": { "type": "DateView", "isRequired": false }
+  },
+  "DatePickerRowProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "DatePickerRowGroupProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "DatePickerRowHeaderProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "DatePickerTriggerProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLButtonElement | null) => void)\n  | RefObject<HTMLButtonElement>",
+      "isRequired": false
+    }
+  },
+  "DatePickerViewTriggerProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLButtonElement | null) => void)\n  | RefObject<HTMLButtonElement>",
+      "isRequired": false
+    },
+    "view": { "type": "DateView", "isRequired": false }
   },
-  "DatePickerPrevTriggerProps": { "view": { "type": "DateView", "isRequired": false } },
-  "DatePickerViewTriggerProps": { "view": { "type": "DateView", "isRequired": false } },
   "DatePickerYearCellProps": {
     "value": { "type": "number", "isRequired": true },
-    "disabled": { "type": "boolean", "isRequired": false }
+    "disabled": { "type": "boolean", "isRequired": false },
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLDivElement | null) => void)\n  | RefObject<HTMLDivElement>",
+      "isRequired": false
+    }
+  },
+  "DatePickerYearSelectProps": {
+    "ref": {
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ((instance: HTMLSelectElement | null) => void)\n  | RefObject<HTMLSelectElement>",
+      "isRequired": false
+    }
   }
 }