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,50 @@
+{
+  "description": "",
+  "methods": [],
+  "displayName": "RenderPrompt",
+  "props": {
+    "title": {
+      "required": true,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "The prompt's title."
+    },
+    "description": {
+      "required": true,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "The prompt's description."
+    },
+    "verificationText": {
+      "required": false,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "The text the user has to input in order to confirm the action."
+    },
+    "cancelText": {
+      "required": false,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "The label for the Cancel button.",
+      "defaultValue": {
+        "value": "\"Cancel\"",
+        "computed": false
+      }
+    },
+    "confirmText": {
+      "required": false,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "Label for the Confirm button.",
+      "defaultValue": {
+        "value": "\"Confirm\"",
+        "computed": false
+      }
+    }
+  }
+}