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
This commit is contained in:
Shahed Nasser
2025-08-20 11:42:25 +03:00
committed by GitHub
parent 5b7a041246
commit d1a1135328
748 changed files with 13079 additions and 7319 deletions
@@ -0,0 +1,6 @@
{
"description": "",
"methods": [],
"displayName": "Table.Body",
"props": {}
}
@@ -0,0 +1,6 @@
{
"description": "",
"methods": [],
"displayName": "Table.Cell",
"props": {}
}
@@ -0,0 +1,6 @@
{
"description": "",
"methods": [],
"displayName": "Table.Header",
"props": {}
}
@@ -0,0 +1,6 @@
{
"description": "",
"methods": [],
"displayName": "Table.HeaderCell",
"props": {}
}
@@ -0,0 +1,131 @@
{
"description": "This component is based on the `div` element and supports all of its props",
"methods": [],
"displayName": "Table.Pagination",
"props": {
"count": {
"required": true,
"tsType": {
"name": "number"
},
"description": "The total number of items."
},
"pageSize": {
"required": true,
"tsType": {
"name": "number"
},
"description": "The number of items per page."
},
"pageIndex": {
"required": true,
"tsType": {
"name": "number"
},
"description": "The current page index."
},
"pageCount": {
"required": true,
"tsType": {
"name": "number"
},
"description": "The total number of pages."
},
"canPreviousPage": {
"required": true,
"tsType": {
"name": "boolean"
},
"description": "Whether there's a previous page that can be navigated to."
},
"canNextPage": {
"required": true,
"tsType": {
"name": "boolean"
},
"description": "Whether there's a next page that can be navigated to."
},
"translations": {
"required": false,
"tsType": {
"name": "signature",
"type": "object",
"raw": "{\n of?: string\n results?: string\n pages?: string\n prev?: string\n next?: string\n}",
"signature": {
"properties": [
{
"key": "of",
"value": {
"name": "string",
"required": false
}
},
{
"key": "results",
"value": {
"name": "string",
"required": false
}
},
{
"key": "pages",
"value": {
"name": "string",
"required": false
}
},
{
"key": "prev",
"value": {
"name": "string",
"required": false
}
},
{
"key": "next",
"value": {
"name": "string",
"required": false
}
}
]
}
},
"description": "An optional object of words to use in the pagination component.\nUse this to override the default words, or translate them into another language.",
"defaultValue": {
"value": "{\n of: \"of\",\n results: \"results\",\n pages: \"pages\",\n prev: \"Prev\",\n next: \"Next\",\n}",
"computed": false
}
},
"previousPage": {
"required": true,
"tsType": {
"name": "signature",
"type": "function",
"raw": "() => void",
"signature": {
"arguments": [],
"return": {
"name": "void"
}
}
},
"description": "A function that handles navigating to the previous page.\nThis function should handle retrieving data for the previous page."
},
"nextPage": {
"required": true,
"tsType": {
"name": "signature",
"type": "function",
"raw": "() => void",
"signature": {
"arguments": [],
"return": {
"name": "void"
}
}
},
"description": "A function that handles navigating to the next page.\nThis function should handle retrieving data for the next page."
}
}
}
@@ -0,0 +1,6 @@
{
"description": "",
"methods": [],
"displayName": "Table.Row",
"props": {}
}
@@ -0,0 +1,6 @@
{
"description": "This component is based on the table element and its various children:\n\n- `Table`: `table`\n- `Table.Header`: `thead`\n- `Table.Row`: `tr`\n- `Table.HeaderCell`: `th`\n- `Table.Body`: `tbody`\n- `Table.Cell`: `td`\n\nEach component supports the props or attributes of its equivalent HTML element.",
"methods": [],
"displayName": "Table",
"props": {}
}