refactor(docs/Dialog): update prop section following latest version
This commit is contained in:
parent
bc6533bf01
commit
24260fe375
@ -1,181 +1,133 @@
|
|||||||
import { TabProvider, TabTrigger, TabContent, TabList } from "@pswui/Tabs";
|
import { TabProvider, TabTrigger, TabContent, TabList } from "@pswui/Tabs";
|
||||||
import { Story } from "@/components/Story";
|
import { Story } from "@/components/Story";
|
||||||
import { LoadedCode, GITHUB_DIR_COMP, GITHUB_COMP_PREVIEW, GITHUB_STORY } from "@/components/LoadedCode";
|
import {
|
||||||
import { DialogDemo } from "./DialogBlocks/Preview";
|
LoadedCode,
|
||||||
import Examples from "./DialogBlocks/Examples";
|
GITHUB_DIR_COMP,
|
||||||
|
GITHUB_COMP_PREVIEW,
|
||||||
# Dialog
|
GITHUB_STORY,
|
||||||
A modal window that prompts the user to take an action or provides critical information.
|
} from "@/components/LoadedCode";
|
||||||
|
import { DialogDemo } from "./DialogBlocks/Preview";
|
||||||
<TabProvider defaultName="preview">
|
import Examples from "./DialogBlocks/Examples";
|
||||||
<TabList>
|
|
||||||
<TabTrigger name="preview">Preview</TabTrigger>
|
# Dialog
|
||||||
<TabTrigger name="code">Code</TabTrigger>
|
|
||||||
</TabList>
|
A modal window that prompts the user to take an action or provides critical information.
|
||||||
<TabContent name="preview">
|
|
||||||
<Story layout="centered">
|
<TabProvider defaultName="preview">
|
||||||
<DialogDemo />
|
<TabList>
|
||||||
</Story>
|
<TabTrigger name="preview">Preview</TabTrigger>
|
||||||
</TabContent>
|
<TabTrigger name="code">Code</TabTrigger>
|
||||||
<TabContent name="code">
|
</TabList>
|
||||||
<LoadedCode from={GITHUB_COMP_PREVIEW("Dialog")} />
|
<TabContent name="preview">
|
||||||
</TabContent>
|
<Story layout="centered">
|
||||||
</TabProvider>
|
<DialogDemo />
|
||||||
|
</Story>
|
||||||
## Installation
|
</TabContent>
|
||||||
|
<TabContent name="code">
|
||||||
1. Create a new directory named `Dialog` in your component folder.
|
<LoadedCode from={GITHUB_COMP_PREVIEW("Dialog")} />
|
||||||
2. Create following files in the folder, and paste the code into the file.
|
</TabContent>
|
||||||
* `index.ts`
|
</TabProvider>
|
||||||
<LoadedCode from={GITHUB_DIR_COMP("Dialog", "index.ts")} />
|
|
||||||
* `Context.ts`
|
## Installation
|
||||||
<LoadedCode from={GITHUB_DIR_COMP("Dialog", "Context.ts")} />
|
|
||||||
* `Component.tsx`
|
1. Create a new directory named `Dialog` in your component folder.
|
||||||
<LoadedCode from={GITHUB_DIR_COMP("Dialog", "Component.tsx")} />
|
2. Create following files in the folder, and paste the code into the file.
|
||||||
|
|
||||||
## Usage
|
- `index.ts`
|
||||||
|
<LoadedCode from={GITHUB_DIR_COMP("Dialog", "index.ts")} />
|
||||||
```tsx
|
- `Context.ts`
|
||||||
import {
|
<LoadedCode from={GITHUB_DIR_COMP("Dialog", "Context.ts")} />
|
||||||
DialogRoot,
|
- `Component.tsx`
|
||||||
DialogTrigger,
|
<LoadedCode from={GITHUB_DIR_COMP("Dialog", "Component.tsx")} />
|
||||||
DialogOverlay,
|
|
||||||
DialogContent,
|
## Usage
|
||||||
DialogHeader,
|
|
||||||
DialogTitle,
|
```tsx
|
||||||
DialogSubtitle,
|
import {
|
||||||
DialogFooter,
|
DialogRoot,
|
||||||
DialogClose,
|
DialogTrigger,
|
||||||
} from "@components/Dialog";
|
DialogOverlay,
|
||||||
```
|
DialogContent,
|
||||||
|
DialogHeader,
|
||||||
```html
|
DialogTitle,
|
||||||
<DialogRoot>
|
DialogSubtitle,
|
||||||
<DialogTrigger>
|
DialogFooter,
|
||||||
<Button>Open Dialog</Button>
|
DialogClose,
|
||||||
</DialogTrigger>
|
} from "@components/Dialog";
|
||||||
<DialogOverlay>
|
```
|
||||||
<DialogContent>
|
|
||||||
<DialogHeader>
|
```html
|
||||||
<DialogTitle>Dialog Title</DialogTitle>
|
<DialogRoot>
|
||||||
<DialogSubtitle>Dialog Subtitle</DialogSubtitle>
|
<DialogTrigger>
|
||||||
</DialogHeader>
|
<button>Open Dialog</button>
|
||||||
{/* Main Contents */}
|
</DialogTrigger>
|
||||||
<DialogFooter>
|
<DialogOverlay>
|
||||||
<DialogClose>
|
<DialogContent>
|
||||||
<Button>Close</Button>
|
<DialogHeader>
|
||||||
</DialogClose>
|
<DialogTitle>Dialog Title</DialogTitle>
|
||||||
</DialogFooter>
|
<DialogSubtitle>Dialog Subtitle</DialogSubtitle>
|
||||||
</DialogContent>
|
</DialogHeader>
|
||||||
</DialogOverlay>
|
{/* Main Contents */}
|
||||||
</DialogRoot>
|
<DialogFooter>
|
||||||
```
|
<DialogClose>
|
||||||
|
<button>Close</button>
|
||||||
> Note:
|
</DialogClose>
|
||||||
>
|
</DialogFooter>
|
||||||
> DialogTrigger and DialogClose will merge its onClick event handler to its children.
|
</DialogContent>
|
||||||
> Also, there is no default element for those.
|
</DialogOverlay>
|
||||||
> So you always have to provide the clickable children for DialogTrigger and DialogClose.
|
</DialogRoot>
|
||||||
>
|
```
|
||||||
> It is easier to understand if you think of this component as always having the `asChild` prop applied to it.
|
|
||||||
|
> Note:
|
||||||
## Props
|
>
|
||||||
|
> DialogTrigger and DialogClose will merge its onClick event handler to its children.
|
||||||
### DialogOverlay
|
> Also, there is no default element for those.
|
||||||
|
> So you always have to provide the clickable children for DialogTrigger and DialogClose.
|
||||||
#### Variants
|
>
|
||||||
|
> It is easier to understand if you think of this component as always having the `asChild` prop applied to it.
|
||||||
| Prop | Type | Default | Description |
|
|
||||||
|:----------|:-----------------------|:--------|:---------------------------------------------|
|
## Props
|
||||||
| `blur` | `"sm" \| "md" \| "lg"` | `md` | Whether the background of dialog is blurred |
|
|
||||||
| `darken` | `"sm" \| "md" \| "lg"` | `md` | Whether the background of dialog is darkened |
|
### DialogOverlay
|
||||||
| `padding` | `"sm" \| "md" \| "lg"` | `md` | Minimum margin of the dialog |
|
|
||||||
|
#### Special
|
||||||
#### Special
|
|
||||||
|
| Prop | Type | Default | Description |
|
||||||
| Prop | Type | Default | Description |
|
| :------------- | :-------- | :------ | :--------------------------------------------- |
|
||||||
|:---------------|:----------|:--------|:-----------------------------------------------|
|
| `closeOnClick` | `boolean` | `false` | Whether the dialog will be closed when clicked |
|
||||||
| `closeOnClick` | `boolean` | `false` | Whether the dialog will be closed when clicked |
|
|
||||||
|
## Examples
|
||||||
### DialogContent
|
|
||||||
|
### Basic Informational Dialog
|
||||||
#### Variants
|
|
||||||
|
<TabProvider defaultName="preview">
|
||||||
| Prop | Type | Default | Description |
|
<TabList>
|
||||||
|:----------|:---------------------------------------------------------------------|:--------|:-----------------------------------------------|
|
<TabTrigger name="preview">Preview</TabTrigger>
|
||||||
| `size` | `"fit" \| "fullSm" \| "fullMd" \| "fullLg" \| "fullXl" \| "full2xl"` | `fit` | Size of the dialog - width and max width |
|
<TabTrigger name="code">Code</TabTrigger>
|
||||||
| `rounded` | `"sm" \| "md" \| "lg" \| "xl"` | `md` | Roundness of the dialog |
|
</TabList>
|
||||||
| `padding` | `"sm" \| "md" \| "lg"` | `md` | Padding of the dialog |
|
<TabContent name="preview">
|
||||||
| `gap` | `"sm" \| "md" \| "lg"` | `md` | Works like flex's gap - space between children |
|
<Story layout="centered">
|
||||||
|
<Examples.BasicInformationalDialog />
|
||||||
### DialogHeader
|
</Story>
|
||||||
|
</TabContent>
|
||||||
#### Variants
|
<TabContent name="code">
|
||||||
|
<LoadedCode from={GITHUB_STORY("Dialog", "BasicInformationalDialog")} />
|
||||||
| Prop | Type | Default | Description |
|
</TabContent>
|
||||||
|:------|:-----------------------|:--------|:----------------------------------------------|
|
</TabProvider>
|
||||||
| `gap` | `"sm" \| "md" \| "lg"` | `sm` | Gap between the children - title and subtitle |
|
|
||||||
|
### Deleting Item
|
||||||
### DialogTitle
|
|
||||||
|
<TabProvider defaultName="preview">
|
||||||
#### Variants
|
<TabList>
|
||||||
|
<TabTrigger name="preview">Preview</TabTrigger>
|
||||||
| Prop | Type | Default | Description |
|
<TabTrigger name="code">Code</TabTrigger>
|
||||||
|:---------|:-----------------------|:--------|:--------------------|
|
</TabList>
|
||||||
| `size` | `"sm" \| "md" \| "lg"` | `md` | Size of the title |
|
<TabContent name="preview">
|
||||||
| `weight` | `"sm" \| "md" \| "lg"` | `lg` | Weight of the title |
|
<Story layout="centered">
|
||||||
|
<Examples.DeletingItem />
|
||||||
### DialogSubtitle
|
</Story>
|
||||||
|
</TabContent>
|
||||||
#### Variants
|
<TabContent name="code">
|
||||||
|
<LoadedCode from={GITHUB_STORY("Dialog", "DeletingItem")} />
|
||||||
| Prop | Type | Default | Description |
|
</TabContent>
|
||||||
|:----------|:-----------------------|:--------|:------------------------|
|
</TabProvider>
|
||||||
| `size` | `"sm" \| "md" \| "lg"` | `sm` | Size of the subtitle |
|
|
||||||
| `weight` | `"sm" \| "md" \| "lg"` | `md` | Weight of the subtitle |
|
|
||||||
| `opacity` | `"sm" \| "md" \| "lg"` | `sm` | Opacity of the subtitle |
|
|
||||||
|
|
||||||
### DialogFooter
|
|
||||||
|
|
||||||
#### Variants
|
|
||||||
|
|
||||||
| Prop | Type | Default | Description |
|
|
||||||
|:------|:-----------------------|:--------|:-------------------------|
|
|
||||||
| `gap` | `"sm" \| "md" \| "lg"` | `sm` | Gap between the children |
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### Basic Informational Dialog
|
|
||||||
|
|
||||||
<TabProvider defaultName="preview">
|
|
||||||
<TabList>
|
|
||||||
<TabTrigger name="preview">Preview</TabTrigger>
|
|
||||||
<TabTrigger name="code">Code</TabTrigger>
|
|
||||||
</TabList>
|
|
||||||
<TabContent name="preview">
|
|
||||||
<Story layout="centered">
|
|
||||||
<Examples.BasicInformationalDialog />
|
|
||||||
</Story>
|
|
||||||
</TabContent>
|
|
||||||
<TabContent name="code">
|
|
||||||
<LoadedCode from={GITHUB_STORY("Dialog", "BasicInformationalDialog")} />
|
|
||||||
</TabContent>
|
|
||||||
</TabProvider>
|
|
||||||
|
|
||||||
### Deleting Item
|
|
||||||
|
|
||||||
<TabProvider defaultName="preview">
|
|
||||||
<TabList>
|
|
||||||
<TabTrigger name="preview">Preview</TabTrigger>
|
|
||||||
<TabTrigger name="code">Code</TabTrigger>
|
|
||||||
</TabList>
|
|
||||||
<TabContent name="preview">
|
|
||||||
<Story layout="centered">
|
|
||||||
<Examples.DeletingItem />
|
|
||||||
</Story>
|
|
||||||
</TabContent>
|
|
||||||
<TabContent name="code">
|
|
||||||
<LoadedCode from={GITHUB_STORY("Dialog", "DeletingItem")} />
|
|
||||||
</TabContent>
|
|
||||||
</TabProvider>
|
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user