p-sw/pswui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: reformat table

Browse Source
This commit is contained in:
p-sw 2024-06-04 23:14:50 +09:00
parent b69f886e9e
commit 9c996f564a
8 changed files with 48 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
packages/react/src/docs/components/Button.mdx
View File

@ -1,4 +1,3 @@
import { Button } from "@components/Button";
import { TabProvider, TabTrigger, TabContent, TabList } from "@components/Tabs"; import { TabProvider, TabTrigger, TabContent, TabList } from "@components/Tabs";
import { Story } from "@/components/Story"; import { Story } from "@/components/Story";
import { LoadedCode, GITHUB } from "@/components/LoadedCode"; import { LoadedCode, GITHUB } from "@/components/LoadedCode";
@ -44,18 +43,18 @@ import { Button } from "@components/Button";
### Variants ### Variants
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:-------------|:------------------------------------------------------------------------------|:------------|:----------------------------------------|
| `size` | `"link" \| "sm" \| "md" \| "lg" \| "icon"` | `"md"` | The size of the button | | `size` | `"link" \| "sm" \| "md" \| "lg" \| "icon"` | `"md"` | The size of the button |
| `border` | `"none" \| "solid" \| "success" \| "warning" \| "danger"` | `"solid"` | The border color of the button | | `border` | `"none" \| "solid" \| "success" \| "warning" \| "danger"` | `"solid"` | The border color of the button |
| `background` | `"default" \| "ghost" \| "success" \| "warning" \| "danger" \| "transparent"` | `"default"` | The background color of the button | | `background` | `"default" \| "ghost" \| "success" \| "warning" \| "danger" \| "transparent"` | `"default"` | The background color of the button |
| `decoration` | `"none" \| "link"` | `"none"` | The inner text decoration of the button | | `decoration` | `"none" \| "link"` | `"none"` | The inner text decoration of the button |
| `presets` | `"default" \| "ghost" \| "link" \| "success" \| "warning" \| "danger"` | `"default"` | The preset of the variant props | | `presets` | `"default" \| "ghost" \| "link" \| "success" \| "warning" \| "danger"` | `"default"` | The preset of the variant props |
### Special ### Special
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:----------|:----------|:--------|:---------------------------------------------------------|
| `asChild` | `boolean` | `false` | Whether the button is rendered as a child of a component | | `asChild` | `boolean` | `false` | Whether the button is rendered as a child of a component |
## Examples ## Examples

9
packages/react/src/docs/components/Checkbox.mdx
View File

@ -1,6 +1,3 @@
import { Button } from "@components/Button";
import { Label } from "@components/Label";
import { Checkbox } from "@components/Checkbox";
import { TabProvider, TabTrigger, TabContent, TabList } from "@components/Tabs"; import { TabProvider, TabTrigger, TabContent, TabList } from "@components/Tabs";
import { Story } from "@/components/Story"; import { Story } from "@/components/Story";
import { LoadedCode, GITHUB } from "@/components/LoadedCode"; import { LoadedCode, GITHUB } from "@/components/LoadedCode";
@ -46,9 +43,9 @@ import { Checkbox } from "@components/Checkbox";
### Variants ### Variants
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :---- | :---- | :------- | :----------- | |:-------|:-------------------------|:--------|:-------------------------|
| `size` | `"base" \| "md" \| "lg"` | `"md"` | The size of the checkbox | | `size` | `"base" \| "md" \| "lg"` | `"md"` | The size of the checkbox |
## Examples ## Examples

33
packages/react/src/docs/components/Drawer.mdx
View File

@ -1,4 +1,3 @@
import { Button } from "@components/Button";
import { TabProvider, TabTrigger, TabContent, TabList } from "@components/Tabs"; import { TabProvider, TabTrigger, TabContent, TabList } from "@components/Tabs";
import { Story } from "@/components/Story"; import { Story } from "@/components/Story";
import { LoadedCode, GITHUB } from '@/components/LoadedCode'; import { LoadedCode, GITHUB } from '@/components/LoadedCode';
@ -82,55 +81,55 @@ import {
#### Special #### Special
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:-----------------|:----------|:---------------|:----------------------------------------------------------|
| `closeThreshold` | `number` | `0.3` | The threshold for the drawer to close with swipe or drag. | | `closeThreshold` | `number` | `0.3` | The threshold for the drawer to close with swipe or drag. |
| `opened` | `boolean` | - (Controlled) | Whether the drawer is opened. | | `opened` | `boolean` | - (Controlled) | Whether the drawer is opened. |
### DrawerOverlay ### DrawerOverlay
#### Special #### Special
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:----------|:----------|:--------|:------------------------------------------------------------|
| `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component | | `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component |
### DrawerContent ### DrawerContent
#### Variants #### Variants
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:-----------|:-----------------------------------------|:---------|:---------------------------|
| `position` | `"top" \| "bottom" \| "left" \| "right"` | `"left"` | The position of the drawer | | `position` | `"top" \| "bottom" \| "left" \| "right"` | `"left"` | The position of the drawer |
#### Special #### Special
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:----------|:----------|:--------|:------------------------------------------------------------|
| `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component | | `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component |
### DrawerHeader ### DrawerHeader
#### Special #### Special
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:----------|:----------|:--------|:------------------------------------------------------------|
| `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component | | `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component |
### DrawerBody ### DrawerBody
#### Special #### Special
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:----------|:----------|:--------|:------------------------------------------------------------|
| `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component | | `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component |
### DrawerFooter ### DrawerFooter
#### Special #### Special
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:----------|:----------|:--------|:------------------------------------------------------------|
| `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component | | `asChild` | `boolean` | `false` | Whether the component is rendered as a child of a component |
## Examples ## Examples

6
packages/react/src/docs/components/Input.mdx
View File

@ -44,10 +44,10 @@ import { Input } from "@components/Input";
### Variants ### Variants
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:-----------|:----------|:--------|:-----------------------------------------------------------------------------------------|
| `unstyled` | `boolean` | `false` | Remove style of input, so it can be real transparent input. Mostly used with InputFrame. | | `unstyled` | `boolean` | `false` | Remove style of input, so it can be real transparent input. Mostly used with InputFrame. |
| `full` | `boolean` | `false` | Make input take full width of its container. | | `full` | `boolean` | `false` | Make input take full width of its container. |
## Examples ## Examples

4
packages/react/src/docs/components/Label.mdx
View File

@ -50,8 +50,8 @@ import { Label } from "@components/Label"
### Variants ### Variants
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:------------|:-----------------------------|:-------------|:----------------------------|
| `direction` | `"vertical" \| "horizontal"` | `"vertical"` | The direction of the label. | | `direction` | `"vertical" \| "horizontal"` | `"vertical"` | The direction of the label. |
## Examples ## Examples

17
packages/react/src/docs/components/Tabs.mdx
View File

@ -1,4 +1,3 @@
import { Button } from "@components/Button";
import { TabProvider, TabTrigger, TabContent, TabList } from "@components/Tabs"; import { TabProvider, TabTrigger, TabContent, TabList } from "@components/Tabs";
import { Story } from "@/components/Story"; import { Story } from "@/components/Story";
import { LoadedCode, GITHUB } from "@/components/LoadedCode"; import { LoadedCode, GITHUB } from "@/components/LoadedCode";
@ -60,21 +59,21 @@ import { TabProvider, TabTrigger, TabContent, TabList } from "@components/Tabs";
### TabProvider ### TabProvider
#### Special #### Special
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:--------------|:---------|:-----------------|:---------------------------------------------|
| `defaultName` | `string` | - (**required**) | The name of the tab to be active by default. | | `defaultName` | `string` | - (**required**) | The name of the tab to be active by default. |
### TabTrigger ### TabTrigger
#### Special #### Special
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:----------|:----------|:-----------------|:----------------------------------------------------------|
| `name` | `string` | - (**required**) | The name of the tab. | | `name` | `string` | - (**required**) | The name of the tab. |
| `asChild` | `boolean` | `false` | Whether the element is rendered as a child of a component | | `asChild` | `boolean` | `false` | Whether the element is rendered as a child of a component |
### TabContent ### TabContent
#### Special #### Special
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | |:-------|:---------|:-----------------|:---------------------|
| `name` | `string` | - (**required**) | The name of the tab. | | `name` | `string` | - (**required**) | The name of the tab. |

4
packages/react/src/docs/components/Toast.mdx
View File

@ -61,8 +61,8 @@ function App() {
#### Special #### Special
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:----------------|:-----------------------|:---------------------|:--------------------------|
| `defaultOption` | `Partial<ToastOption>` | `defaultToastOption` | Global options for toast. | | `defaultOption` | `Partial<ToastOption>` | `defaultToastOption` | Global options for toast. |
```ts ```ts

10
packages/react/src/docs/components/Tooltip.mdx
View File

@ -50,17 +50,17 @@ import { Tooltip, TooltipContent } from "@components/Tooltip";
#### Variants #### Variants
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:-----------|:-----------------------------------------|:--------|:-----------------------------|
| `position` | `"bottom" \| "left" \| "right" \| "top"` | `"top"` | The position of the tooltip. | | `position` | `"bottom" \| "left" \| "right" \| "top"` | `"top"` | The position of the tooltip. |
### TooltipContent ### TooltipContent
#### Variants #### Variants
| Prop | Type | Default | Description | | Prop | Type | Default | Description |
| :--- | :--- | :------ | :---------- | |:---------|:-----------------------|:--------|:-----------------------------------------|
| `offset` | `"sm" \| "md" \| "lg"` | `"md"` | Gap between the tooltip and the trigger. | | `offset` | `"sm" \| "md" \| "lg"` | `"md"` | Gap between the tooltip and the trigger. |
## Examples ## Examples