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": "",
+  "methods": [],
+  "displayName": "Select.Content",
+  "props": {}
+}
@@ -0,0 +1,6 @@
+{
+  "description": "Groups multiple items together.",
+  "methods": [],
+  "displayName": "Select.Group",
+  "props": {}
+}
@@ -0,0 +1,6 @@
+{
+  "description": "An item in the select. It's based on [Radix UI Select Item](https://www.radix-ui.com/primitives/docs/components/select#item)\nand accepts its props.",
+  "methods": [],
+  "displayName": "Select.Item",
+  "props": {}
+}
@@ -0,0 +1,6 @@
+{
+  "description": "Used to label a group of items.",
+  "methods": [],
+  "displayName": "Select.Label",
+  "props": {}
+}
@@ -0,0 +1,6 @@
+{
+  "description": "",
+  "methods": [],
+  "displayName": "Select.Separator",
+  "props": {}
+}
@@ -0,0 +1,6 @@
+{
+  "description": "The trigger that toggles the select.",
+  "methods": [],
+  "displayName": "Select.Trigger",
+  "props": {}
+}
@@ -0,0 +1,6 @@
+{
+  "description": "Displays the selected value, or a placeholder if no value is selected.\nIt's based on [Radix UI Select Value](https://www.radix-ui.com/primitives/docs/components/select#value).",
+  "methods": [],
+  "displayName": "Select.Value",
+  "props": {}
+}
@@ -0,0 +1,29 @@
+{
+  "description": "This component is based on [Radix UI Select](https://www.radix-ui.com/primitives/docs/components/select).\nIt also accepts all props of the HTML `select` component.",
+  "methods": [],
+  "displayName": "Select",
+  "props": {
+    "size": {
+      "required": false,
+      "tsType": {
+        "name": "union",
+        "raw": "\"base\" | \"small\"",
+        "elements": [
+          {
+            "name": "literal",
+            "value": "\"base\""
+          },
+          {
+            "name": "literal",
+            "value": "\"small\""
+          }
+        ]
+      },
+      "description": "The select's size.",
+      "defaultValue": {
+        "value": "\"base\"",
+        "computed": false
+      }
+    }
+  }
+}