docs: generate documentation for UI components (#5849)

* added tool to generate spec files for React components * use typedoc for missing descriptions and types * improvements and fixes * improvements * added doc comments for half of the components * add custom resolver + more doc comments * added all tsdocs * general improvements * add specs to UI docs * added github action * remove unnecessary api route * Added readme for react-docs-generator * remove comment * Update packages/design-system/ui/src/components/currency-input/currency-input.tsx Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com> * remove description of aria fields + add generate script --------- Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
2023-12-13 16:02:41 +02:00
parent edc49bfe1d
commit 245e5c9a69
288 changed files with 6029 additions and 1447 deletions
@@ -0,0 +1,6 @@
+{
+  "description": "This component is based on the `div` element and supports all of its props",
+  "methods": [],
+  "displayName": "CodeBlock.Body",
+  "props": {}
+}
@@ -0,0 +1,6 @@
+{
+  "description": "This component is based on the `div` element and supports all of its props",
+  "methods": [],
+  "displayName": "CodeBlock.Header.Meta",
+  "props": {}
+}
@@ -0,0 +1,18 @@
+{
+  "description": "This component is based on the `div` element and supports all of its props",
+  "methods": [],
+  "displayName": "CodeBlock.Header",
+  "props": {
+    "hideLabels": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": "Whether to hide the code snippets' labels.",
+      "defaultValue": {
+        "value": "false",
+        "computed": false
+      }
+    }
+  }
+}
@@ -0,0 +1,66 @@
+{
+  "description": "This component is based on the `div` element and supports all of its props",
+  "methods": [],
+  "displayName": "CodeBlock",
+  "props": {
+    "snippets": {
+      "required": true,
+      "tsType": {
+        "name": "Array",
+        "elements": [
+          {
+            "name": "signature",
+            "type": "object",
+            "raw": "{\n  /**\n   * The label of the code snippet's tab.\n   */\n  label: string\n  /**\n   * The language of the code snippet. For example, `tsx`.\n   */\n  language: string\n  /**\n   * The code snippet.\n   */\n  code: string\n  /**\n   * Whether to hide the line numbers shown as the side of the code snippet.\n   */\n  hideLineNumbers?: boolean\n  /**\n   * Whether to hide the copy button.\n   */\n  hideCopy?: boolean\n}",
+            "signature": {
+              "properties": [
+                {
+                  "key": "label",
+                  "value": {
+                    "name": "string",
+                    "required": true
+                  },
+                  "description": "The label of the code snippet's tab."
+                },
+                {
+                  "key": "language",
+                  "value": {
+                    "name": "string",
+                    "required": true
+                  },
+                  "description": "The language of the code snippet. For example, `tsx`."
+                },
+                {
+                  "key": "code",
+                  "value": {
+                    "name": "string",
+                    "required": true
+                  },
+                  "description": "The code snippet."
+                },
+                {
+                  "key": "hideLineNumbers",
+                  "value": {
+                    "name": "boolean",
+                    "required": false
+                  },
+                  "description": "Whether to hide the line numbers shown as the side of the code snippet."
+                },
+                {
+                  "key": "hideCopy",
+                  "value": {
+                    "name": "boolean",
+                    "required": false
+                  },
+                  "description": "Whether to hide the copy button."
+                }
+              ]
+            }
+          }
+        ],
+        "raw": "CodeSnippet[]"
+      },
+      "description": "The code snippets."
+    }
+  }
+}