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,69 @@
+{
+  "description": "This component is based on the [Radix UI Avatar](https://www.radix-ui.com/primitives/docs/components/avatar) primitive.",
+  "methods": [],
+  "displayName": "Avatar",
+  "props": {
+    "src": {
+      "required": false,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "The URL of the image used in the Avatar."
+    },
+    "fallback": {
+      "required": true,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "Text to show in the avatar if the URL provided in `src` can't be opened."
+    },
+    "variant": {
+      "defaultValue": {
+        "value": "\"rounded\"",
+        "computed": false
+      },
+      "description": "The style of the avatar.",
+      "tsType": {
+        "name": "union",
+        "raw": "\"squared\" \\| \"rounded\"",
+        "elements": [
+          {
+            "name": "literal",
+            "value": "\"squared\""
+          },
+          {
+            "name": "literal",
+            "value": "\"rounded\""
+          }
+        ]
+      },
+      "required": false
+    },
+    "size": {
+      "defaultValue": {
+        "value": "\"base\"",
+        "computed": false
+      },
+      "description": "The size of the avatar's border radius.",
+      "tsType": {
+        "name": "union",
+        "raw": "\"base\" \\| \"large\"",
+        "elements": [
+          {
+            "name": "literal",
+            "value": "\"base\""
+          },
+          {
+            "name": "literal",
+            "value": "\"large\""
+          }
+        ]
+      },
+      "required": false
+    }
+  },
+  "composes": [
+    "Omit",
+    "VariantProps"
+  ]
+}