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,206 @@
+{
+  "description": "",
+  "methods": [],
+  "displayName": "SingleDatePicker",
+  "props": {
+    "fromYear": {
+      "required": false,
+      "tsType": {
+        "name": "number"
+      },
+      "description": "The year to start showing the dates from."
+    },
+    "toYear": {
+      "required": false,
+      "tsType": {
+        "name": "number"
+      },
+      "description": "The year to show dates to."
+    },
+    "fromMonth": {
+      "required": false,
+      "tsType": {
+        "name": "Date"
+      },
+      "description": "The month to start showing dates from."
+    },
+    "toMonth": {
+      "required": false,
+      "tsType": {
+        "name": "Date"
+      },
+      "description": "The month to show dates to."
+    },
+    "fromDay": {
+      "required": false,
+      "tsType": {
+        "name": "Date"
+      },
+      "description": "The day to start showing dates from."
+    },
+    "toDay": {
+      "required": false,
+      "tsType": {
+        "name": "Date"
+      },
+      "description": "The day to show dates to."
+    },
+    "fromDate": {
+      "required": false,
+      "tsType": {
+        "name": "Date"
+      },
+      "description": "The date to show dates from."
+    },
+    "toDate": {
+      "required": false,
+      "tsType": {
+        "name": "Date"
+      },
+      "description": "The date to show dates to."
+    },
+    "className": {
+      "required": false,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "The class name to apply on the date picker."
+    },
+    "disabled": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": "Whether the date picker's input is disabled."
+    },
+    "required": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": "Whether the date picker's input is required."
+    },
+    "size": {
+      "required": false,
+      "tsType": {
+        "name": "union",
+        "raw": "\"small\" | \"base\"",
+        "elements": [
+          {
+            "name": "literal",
+            "value": "\"small\""
+          },
+          {
+            "name": "literal",
+            "value": "\"base\""
+          }
+        ]
+      },
+      "description": "The date picker's size.",
+      "defaultValue": {
+        "value": "\"base\"",
+        "computed": false
+      }
+    },
+    "showTimePicker": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": "Whether to show a time picker along with the date picker."
+    },
+    "id": {
+      "required": false,
+      "tsType": {
+        "name": "string"
+      },
+      "description": ""
+    },
+    "aria-invalid": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": ""
+    },
+    "aria-label": {
+      "required": false,
+      "tsType": {
+        "name": "string"
+      },
+      "description": ""
+    },
+    "aria-labelledby": {
+      "required": false,
+      "tsType": {
+        "name": "string"
+      },
+      "description": ""
+    },
+    "aria-required": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": ""
+    },
+    "presets": {
+      "required": false,
+      "tsType": {
+        "name": "Array",
+        "elements": [
+          {
+            "name": "DatePreset"
+          }
+        ],
+        "raw": "DatePreset[]"
+      },
+      "description": ""
+    },
+    "defaultValue": {
+      "required": false,
+      "tsType": {
+        "name": "Date"
+      },
+      "description": ""
+    },
+    "value": {
+      "required": false,
+      "tsType": {
+        "name": "Date"
+      },
+      "description": ""
+    },
+    "onChange": {
+      "required": false,
+      "tsType": {
+        "name": "signature",
+        "type": "function",
+        "raw": "(date: Date | undefined) => void",
+        "signature": {
+          "arguments": [
+            {
+              "type": {
+                "name": "union",
+                "raw": "Date | undefined",
+                "elements": [
+                  {
+                    "name": "Date"
+                  },
+                  {
+                    "name": "undefined"
+                  }
+                ]
+              },
+              "name": "date"
+            }
+          ],
+          "return": {
+            "name": "void"
+          }
+        }
+      },
+      "description": ""
+    }
+  }
+}