fix(props-docs): clean output

chakra-ui · Jan 20, 2023 · 702e258 · 702e258
1 parent f9345ce
commit 702e258
Show file tree

Hide file tree

Showing 45 changed files with 2,826 additions and 2,883 deletions.
diff --git a/packages/components/accordion/docs.json b/packages/components/accordion/docs.json
@@ -1,113 +1,113 @@
 {
   "Accordion": {
     "allowMultiple": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, multiple accordion items can be expanded at once."
     },
     "allowToggle": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, any expanded accordion item can be collapsed again."
     },
     "defaultIndex": {
-      "type": "ExpandedIndex;",
+      "type": "ExpandedIndex",
       "required": false,
       "description": "The initial index(es) of the expanded accordion item"
     },
     "index": {
-      "type": "ExpandedIndex;",
+      "type": "ExpandedIndex",
       "required": false,
       "description": "The index(es) of the expanded accordion item"
     },
     "onChange": {
-      "type": "(expandedIndex: ExpandedIndex) => void;",
+      "type": "(expandedIndex: ExpandedIndex) => void",
       "required": false,
       "description": "The callback invoked when accordion items are expanded or collapsed."
     },
     "reduceMotion": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, height animation and transitions will be disabled."
     }
   },
   "AccordionButton": {},
   "AccordionIcon": {
-    "orientation": { "type": "Orientation;", "required": false }
+    "orientation": { "type": "Orientation", "required": false }
   },
   "AccordionItem": {
     "id": {
-      "type": "string;",
+      "type": "string",
       "required": false,
       "description": "A unique id for the accordion item."
     },
     "isDisabled": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, the accordion item will be disabled."
     },
     "isFocusable": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, the accordion item will be focusable."
     }
   },
   "AccordionPanel": {
     "motionProps": {
-      "type": "CollapseProps;",
+      "type": "CollapseProps",
       "required": false,
       "description": "The properties passed to the underlying `Collapse` component."
     }
   },
   "UseAccordionItem": {
     "id": {
-      "type": "string;",
+      "type": "string",
       "required": false,
       "description": "A unique id for the accordion item."
     },
     "isDisabled": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, the accordion item will be disabled."
     },
     "isFocusable": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, the accordion item will be focusable."
     }
   },
   "UseAccordion": {
     "allowMultiple": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, multiple accordion items can be expanded at once."
     },
     "allowToggle": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, any expanded accordion item can be collapsed again."
     },
     "defaultIndex": {
-      "type": "ExpandedIndex;",
+      "type": "ExpandedIndex",
       "required": false,
       "description": "The initial index(es) of the expanded accordion item"
     },
     "index": {
-      "type": "ExpandedIndex;",
+      "type": "ExpandedIndex",
       "required": false,
       "description": "The index(es) of the expanded accordion item"
     },
     "onChange": {
-      "type": "(expandedIndex: ExpandedIndex) => void;",
+      "type": "(expandedIndex: ExpandedIndex) => void",
       "required": false,
       "description": "The callback invoked when accordion items are expanded or collapsed."
     }

diff --git a/packages/components/alert/docs.json b/packages/components/alert/docs.json
@@ -1,6 +1,6 @@
 {
   "Alert": {
-    "addRole": { "type": "boolean;", "defaultValue": false, "required": false },
+    "addRole": { "type": "boolean", "defaultValue": false, "required": false },
     "colorScheme": {
       "defaultValue": "blue",
       "type": "\"whiteAlpha\" | \"blackAlpha\" | \"gray\" | \"red\" | \"orange\" | \"yellow\" | \"green\" | \"teal\" | \"blue\" | \"cyan\" | \"purple\" | \"pink\" | \"linkedin\" | \"facebook\" | \"messenger\" | \"whatsapp\" | \"twitter\" | \"telegram\"",
@@ -13,8 +13,8 @@
       "description": "The size of the Alert"
     },
     "status": {
-      "type": "\"info\" | \"warning\" | \"success\" | \"error\" | \"loading\";",
-      "defaultValue": "\"info\"",
+      "type": "\"info\" | \"warning\" | \"success\" | \"error\" | \"loading\"",
+      "defaultValue": "info",
       "required": false,
       "description": "The status of the alert"
     },

diff --git a/packages/components/avatar/docs.json b/packages/components/avatar/docs.json
@@ -6,44 +6,44 @@
       "description": "The visual color appearance of the component"
     },
     "getInitials": {
-      "type": "(name: string) => string;",
+      "type": "(name: string) => string",
       "required": false,
       "description": "Function to get the initials to display"
     },
     "icon": {
-      "type": "ReactElement<any, string | JSXElementConstructor<any>>;",
+      "type": "ReactElement<any, string | JSXElementConstructor<any>>",
       "required": false,
       "description": "The default avatar used as fallback when `name`, and `src`\nis not specified."
     },
-    "iconLabel": { "type": "string;", "required": false },
+    "iconLabel": { "type": "string", "required": false },
     "ignoreFallback": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, opt out of the avatar's `fallback` logic and\nrenders the `img` at all times."
     },
     "loading": {
-      "type": "\"eager\" | \"lazy\";",
+      "type": "\"eager\" | \"lazy\"",
       "required": false,
       "description": "Defines loading strategy"
     },
     "name": {
-      "type": "string;",
+      "type": "string",
       "required": false,
       "description": "The name of the person in the avatar.\n\n- if `src` has loaded, the name will be used as the `alt` attribute of the `img`\n- If `src` is not loaded, the name will be used to create the initials"
     },
     "onError": {
-      "type": "() => void;",
+      "type": "() => void",
       "required": false,
       "description": "Function called when image failed to load"
     },
     "referrerPolicy": {
-      "type": "HTMLAttributeReferrerPolicy;",
+      "type": "HTMLAttributeReferrerPolicy",
       "required": false,
       "description": "Defining which referrer is sent when fetching the resource."
     },
     "showBorder": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false,
       "description": "If `true`, the `Avatar` will show a border around it.\n\nBest for a group of avatars"
@@ -55,12 +55,12 @@
       "description": "The size of the Avatar"
     },
     "src": {
-      "type": "string;",
+      "type": "string",
       "required": false,
       "description": "The image url of the `Avatar`"
     },
     "srcSet": {
-      "type": "string;",
+      "type": "string",
       "required": false,
       "description": "List of sources to use for different screen resolutions"
     },
@@ -71,17 +71,17 @@
     }
   },
   "AvatarBadge": {
-    "placement": { "type": "BadgePlacement;", "required": false }
+    "placement": { "type": "BadgePlacement", "required": false }
   },
   "AvatarGroup": {
     "max": {
-      "type": "number;",
+      "type": "number",
       "required": false,
       "description": "The maximum number of visible avatars"
     },
     "spacing": {
-      "type": "ResponsiveValue<string | number | (string & {})>;",
-      "defaultValue": "\"-0.75rem\"",
+      "type": "ResponsiveValue<string | number | (string & {})>",
+      "defaultValue": "-0.75rem",
       "required": false,
       "description": "The space between the avatars in the group."
     }

diff --git a/packages/components/breadcrumb/docs.json b/packages/components/breadcrumb/docs.json
@@ -1,46 +1,46 @@
 {
   "Breadcrumb": {
-    "listProps": { "type": "HTMLChakraProps<\"ol\">;", "required": false },
+    "listProps": { "type": "HTMLChakraProps<\"ol\">", "required": false },
     "separator": {
-      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ReactElement<any, string | JSXElementConstructor<any>>;",
-      "defaultValue": "\"/\"",
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ReactElement<any, string | JSXElementConstructor<any>>",
+      "defaultValue": "/",
       "required": false,
       "description": "The visual separator between each breadcrumb item"
     },
     "spacing": {
       "type": "string | number | boolean | (string & {}) | ResponsiveArray<string | number | (string & {})> | Partial<Record<string, string | number | (string & {})>> | ResponsiveArray<...> | Partial<...> | ((theme: Record<...>) => ResponsiveValue<...>)",
-      "defaultValue": "\"0.5rem\"",
+      "defaultValue": "0.5rem",
       "required": false,
       "description": "The left and right margin applied to the separator"
     }
   },
   "BreadcrumbItem": {
     "isCurrentPage": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false
     },
     "isLastChild": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false
     },
     "separator": {
-      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ReactElement<any, string | JSXElementConstructor<any>>;",
-      "defaultValue": "\"/\"",
+      "type": "type ONLY_FOR_FORMAT =\n  | string\n  | ReactElement<any, string | JSXElementConstructor<any>>",
+      "defaultValue": "/",
       "required": false,
       "description": "The visual separator between each breadcrumb item"
     },
     "spacing": {
       "type": "string | number | boolean | (string & {}) | ResponsiveArray<string | number | (string & {})> | Partial<Record<string, string | number | (string & {})>> | ResponsiveArray<...> | Partial<...> | ((theme: Record<...>) => ResponsiveValue<...>)",
-      "defaultValue": "\"0.5rem\"",
+      "defaultValue": "0.5rem",
       "required": false,
       "description": "The left and right margin applied to the separator"
     }
   },
   "BreadcrumbLink": {
     "isCurrentPage": {
-      "type": "boolean;",
+      "type": "boolean",
       "defaultValue": false,
       "required": false
     }