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:
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "This component is used to wrap the body content of the modal.\nThis component is based on the `div` element and supports all of its props",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Body",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "This component is used to create the close button for the modal.\nIt accepts props from the [Radix UI Dialog Close](https://www.radix-ui.com/primitives/docs/components/dialog#close) component.",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Close",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "This component wraps the content of the modal.\nIt accepts props from the [Radix UI Dialog Content](https://www.radix-ui.com/primitives/docs/components/dialog#content) component.",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Content",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "This component adds accessible description to the modal.\nIt accepts props from the [Radix UI Dialog Description](https://www.radix-ui.com/primitives/docs/components/dialog#description) component.",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Description",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "This component is used to wrap the footer content of the modal.\nThis component is based on the `div` element and supports all of its props",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Footer",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "This component is used to wrap the header content of the modal.\nThis component is based on the `div` element and supports all of its props",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Header",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "This component is used to create the overlay for the modal.\nIt accepts props from the [Radix UI Dialog Overlay](https://www.radix-ui.com/primitives/docs/components/dialog#overlay) component.",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Overlay",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "The `FocusModal.Content` component uses this component to wrap the modal content.\nIt accepts props from the [Radix UI Dialog Portal](https://www.radix-ui.com/primitives/docs/components/dialog#portal) component.",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Portal",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "This component adds an accessible title to the modal.\nIt accepts props from the [Radix UI Dialog Title](https://www.radix-ui.com/primitives/docs/components/dialog#title) component.",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Title",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"description": "This component is used to create the trigger button that opens the modal.\nIt accepts props from the [Radix UI Dialog Trigger](https://www.radix-ui.com/primitives/docs/components/dialog#trigger) component.",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal.Trigger",
|
||||
"props": {}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
{
|
||||
"description": "This component is based on the [Radix UI Dialog](https://www.radix-ui.com/primitives/docs/components/dialog) primitives.",
|
||||
"methods": [],
|
||||
"displayName": "FocusModal",
|
||||
"props": {
|
||||
"defaultOpen": {
|
||||
"description": "Whether the modal is opened by default.",
|
||||
"required": false,
|
||||
"tsType": {
|
||||
"name": "boolean"
|
||||
}
|
||||
},
|
||||
"open": {
|
||||
"description": "Whether the modal is opened.",
|
||||
"required": false,
|
||||
"tsType": {
|
||||
"name": "boolean"
|
||||
}
|
||||
},
|
||||
"onOpenChange": {
|
||||
"description": "A function to handle when the modal is opened or closed.",
|
||||
"required": false,
|
||||
"tsType": {
|
||||
"name": "signature",
|
||||
"type": "function",
|
||||
"raw": "(open: boolean) => void",
|
||||
"signature": {
|
||||
"arguments": [
|
||||
{
|
||||
"name": "open",
|
||||
"type": {
|
||||
"name": "boolean"
|
||||
},
|
||||
"rest": false
|
||||
}
|
||||
],
|
||||
"return": {
|
||||
"name": "void"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user