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,147 @@
+{
+  "description": "This component is based on the `p` element and supports all of its props",
+  "methods": [],
+  "displayName": "Text",
+  "props": {
+    "asChild": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": "Whether to remove the wrapper `button` element and use the\npassed child element instead.",
+      "defaultValue": {
+        "value": "false",
+        "computed": false
+      }
+    },
+    "as": {
+      "required": false,
+      "tsType": {
+        "name": "union",
+        "raw": "\"p\" | \"span\" | \"div\"",
+        "elements": [
+          {
+            "name": "literal",
+            "value": "\"p\""
+          },
+          {
+            "name": "literal",
+            "value": "\"span\""
+          },
+          {
+            "name": "literal",
+            "value": "\"div\""
+          }
+        ]
+      },
+      "description": "The wrapper element to use when `asChild` is disabled.",
+      "defaultValue": {
+        "value": "\"p\"",
+        "computed": false
+      }
+    },
+    "size": {
+      "defaultValue": {
+        "value": "\"base\"",
+        "computed": false
+      },
+      "description": "The text's size.",
+      "tsType": {
+        "name": "union",
+        "raw": "\"base\" \\| \"large\" \\| \"small\" \\| \"xlarge\" \\| \"xsmall\"",
+        "elements": [
+          {
+            "name": "literal",
+            "value": "\"base\""
+          },
+          {
+            "name": "literal",
+            "value": "\"large\""
+          },
+          {
+            "name": "literal",
+            "value": "\"small\""
+          },
+          {
+            "name": "literal",
+            "value": "\"xlarge\""
+          },
+          {
+            "name": "literal",
+            "value": "\"xsmall\""
+          }
+        ]
+      },
+      "required": false
+    },
+    "weight": {
+      "defaultValue": {
+        "value": "\"regular\"",
+        "computed": false
+      },
+      "description": "The text's font weight.",
+      "tsType": {
+        "name": "union",
+        "raw": "\"regular\" \\| \"plus\"",
+        "elements": [
+          {
+            "name": "literal",
+            "value": "\"regular\""
+          },
+          {
+            "name": "literal",
+            "value": "\"plus\""
+          }
+        ]
+      },
+      "required": false
+    },
+    "family": {
+      "defaultValue": {
+        "value": "\"sans\"",
+        "computed": false
+      },
+      "description": "The text's font family.",
+      "tsType": {
+        "name": "union",
+        "raw": "\"sans\" \\| \"mono\"",
+        "elements": [
+          {
+            "name": "literal",
+            "value": "\"sans\""
+          },
+          {
+            "name": "literal",
+            "value": "\"mono\""
+          }
+        ]
+      },
+      "required": false
+    },
+    "leading": {
+      "defaultValue": {
+        "value": "\"normal\"",
+        "computed": false
+      },
+      "description": "The text's line height.",
+      "tsType": {
+        "name": "union",
+        "raw": "\"normal\" \\| \"compact\"",
+        "elements": [
+          {
+            "name": "literal",
+            "value": "\"normal\""
+          },
+          {
+            "name": "literal",
+            "value": "\"compact\""
+          }
+        ]
+      },
+      "required": false
+    }
+  },
+  "composes": [
+    "VariantProps"
+  ]
+}