asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generate documentation for UI components (#5849)

Browse Source 
* 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>
This commit is contained in:
Shahed Nasser
2023-12-13 16:02:41 +02:00
committed by GitHub
parent edc49bfe1d
commit 245e5c9a69
288 changed files with 6029 additions and 1447 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.CheckboxItem.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu CheckboxItem](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#checkboxitem) primitive.",
"methods": [],
"displayName": "DropdownMenu.CheckboxItem",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.Content.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu Content](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#content) primitive.",
"methods": [],
"displayName": "DropdownMenu.Content",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.Group.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu Group](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#group) primitive.",
"methods": [],
"displayName": "DropdownMenu.Group",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.Hint.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the `span` element and supports all of its props",
"methods": [],
"displayName": "DropdownMenu.Hint",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.Item.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu Item](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#item) primitive.",
"methods": [],
"displayName": "DropdownMenu.Item",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.Label.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu Label](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#label) primitive.",
"methods": [],
"displayName": "DropdownMenu.Label",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.RadioGroup.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu RadioGroup](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#radiogroup) primitive.",
"methods": [],
"displayName": "DropdownMenu.RadioGroup",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.RadioItem.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu RadioItem](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#radioitem) primitive.",
"methods": [],
"displayName": "DropdownMenu.RadioItem",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.Separator.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu Separator](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#separator) primitive.",
"methods": [],
"displayName": "DropdownMenu.Separator",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.Shortcut.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the `span` element and supports all of its props",
"methods": [],
"displayName": "DropdownMenu.Shortcut",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.SubMenu.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu Sub](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#sub) primitive.",
"methods": [],
"displayName": "DropdownMenu.SubMenu",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.SubMenuContent.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu SubContent](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#subcontent) primitive.",
"methods": [],
"displayName": "DropdownMenu.SubMenuContent",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.SubMenuTrigger.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu SubTrigger](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#subtrigger) primitive.",
"methods": [],
"displayName": "DropdownMenu.SubMenuTrigger",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.Trigger.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu Trigger](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#trigger) primitive.",
"methods": [],
"displayName": "DropdownMenu.Trigger",
"props": {}
}

6
www/apps/ui/src/specs/DropdownMenu/DropdownMenu.json Normal file
View File

@@ -0,0 +1,6 @@
{
"description": "This component is based on the [Radix UI Dropdown Menu](https://www.radix-ui.com/primitives/docs/components/dropdown-menu) primitive.",
"methods": [],
"displayName": "DropdownMenu",
"props": {}
}