docs: migrate UI docs (#13245)

* docs: create a new UI docs project (#13233) * docs: create a new UI docs project * fix installation errors * docs: migrate UI docs content to new project (#13241) * Fix content * added examples for some components * finish adding examples * lint fix * fix build errors * delete empty files * path fixes + refactor * fix build error
2025-08-20 11:42:25 +03:00
parent 5b7a041246
commit d1a1135328
748 changed files with 13079 additions and 7319 deletions
@@ -0,0 +1,6 @@
+{
+  "description": "The bar component of the command bar. This component is used to display the commands.",
+  "methods": [],
+  "displayName": "CommandBar.Bar",
+  "props": {}
+}
@@ -0,0 +1,54 @@
+{
+  "description": "The command component of the command bar. This component is used to display a command, as well as registering the keyboad shortcut.",
+  "methods": [],
+  "displayName": "CommandBar.Command",
+  "props": {
+    "action": {
+      "required": true,
+      "tsType": {
+        "name": "signature",
+        "type": "function",
+        "raw": "() => void | Promise<void>",
+        "signature": {
+          "arguments": [],
+          "return": {
+            "name": "union",
+            "raw": "void | Promise<void>",
+            "elements": [
+              {
+                "name": "void"
+              },
+              {
+                "name": "Promise",
+                "elements": [
+                  {
+                    "name": "void"
+                  }
+                ],
+                "raw": "Promise<void>"
+              }
+            ]
+          }
+        }
+      },
+      "description": "The function to execute when the command is triggered."
+    },
+    "label": {
+      "required": true,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "The command's label."
+    },
+    "shortcut": {
+      "required": true,
+      "tsType": {
+        "name": "string"
+      },
+      "description": "The command's shortcut"
+    }
+  },
+  "composes": [
+    "Omit"
+  ]
+}
@@ -0,0 +1,6 @@
+{
+  "description": "The seperator component of the command bar. This component is used to display a seperator between commands.",
+  "methods": [],
+  "displayName": "CommandBar.Seperator",
+  "props": {}
+}
@@ -0,0 +1,6 @@
+{
+  "description": "The value component of the command bar. This component is used to display a value,\nsuch as the number of selected items which the commands will act on.",
+  "methods": [],
+  "displayName": "CommandBar.Value",
+  "props": {}
+}
@@ -0,0 +1,62 @@
+{
+  "description": "The root component of the command bar. This component manages the state of the command bar.",
+  "methods": [],
+  "displayName": "CommandBar",
+  "props": {
+    "open": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": "Whether to open (show) the command bar.",
+      "defaultValue": {
+        "value": "false",
+        "computed": false
+      }
+    },
+    "onOpenChange": {
+      "required": false,
+      "tsType": {
+        "name": "signature",
+        "type": "function",
+        "raw": "(open: boolean) => void",
+        "signature": {
+          "arguments": [
+            {
+              "type": {
+                "name": "boolean"
+              },
+              "name": "open"
+            }
+          ],
+          "return": {
+            "name": "void"
+          }
+        }
+      },
+      "description": "Specify a function to handle the change of `open`'s value."
+    },
+    "defaultOpen": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": "Whether the command bar is open by default.",
+      "defaultValue": {
+        "value": "false",
+        "computed": false
+      }
+    },
+    "disableAutoFocus": {
+      "required": false,
+      "tsType": {
+        "name": "boolean"
+      },
+      "description": "Whether to disable focusing automatically on the command bar when it's opened.",
+      "defaultValue": {
+        "value": "true",
+        "computed": false
+      }
+    }
+  }
+}