docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
This commit is contained in:
53
www/apps/ui/src/content/docs/hooks/use-prompt.mdx
Normal file
53
www/apps/ui/src/content/docs/hooks/use-prompt.mdx
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: "usePrompt"
|
||||
description: ""
|
||||
component: true
|
||||
---
|
||||
|
||||
This hook can be used to prompt the user for confirmation of an action.
|
||||
|
||||
## Usage
|
||||
|
||||
---
|
||||
|
||||
```tsx
|
||||
import { usePrompt } from "@medusajs/ui"
|
||||
```
|
||||
|
||||
```tsx
|
||||
const dialog = usePrompt()
|
||||
const actionFunction = async () => {
|
||||
const confirmed = await dialog({
|
||||
title: "Are you sure?",
|
||||
description: "Please confirm this action",
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
---
|
||||
|
||||
### Call Signature
|
||||
|
||||
`usePrompt()`
|
||||
|
||||
### usePrompt return
|
||||
|
||||
<HookValues hook="usePrompt" />
|
||||
|
||||
### PromptProps
|
||||
|
||||
<HookValues hook="PromptProps" />
|
||||
|
||||
## Examples
|
||||
|
||||
---
|
||||
|
||||
### Basic
|
||||
|
||||
<ComponentExample name="use-prompt-demo" />
|
||||
|
||||
### With Verification
|
||||
|
||||
<ComponentExample name="use-prompt-verification" />
|
||||
30
www/apps/ui/src/content/docs/hooks/use-toast.mdx
Normal file
30
www/apps/ui/src/content/docs/hooks/use-toast.mdx
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "useToast"
|
||||
description: ""
|
||||
component: true
|
||||
---
|
||||
|
||||
|
||||
This hook is used to display and manage toasts. To learn how to make it usable and to see some examples, please check the [Toast component page](/components/toast).
|
||||
|
||||
```tsx
|
||||
import { useToast } from "@medusajs/ui"
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
---
|
||||
|
||||
### Call Signature
|
||||
|
||||
`useToast()`
|
||||
|
||||
### useToast return
|
||||
|
||||
<HookValues hook="useToast" />
|
||||
|
||||
### ToasterToast
|
||||
|
||||
Important type used when pushing or retrieving toasts. This extends the [Radix UI Toast Root](https://www.radix-ui.com/primitives/docs/components/toast#root) primitive type.
|
||||
|
||||
<HookValues hook="ToasterToast" />
|
||||
39
www/apps/ui/src/content/docs/hooks/use-toggle-state.mdx
Normal file
39
www/apps/ui/src/content/docs/hooks/use-toggle-state.mdx
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "useToggleState"
|
||||
description: ""
|
||||
component: true
|
||||
---
|
||||
|
||||
|
||||
This is a simple hook that can be used to keep track of a boolean value and toggle between its two states.
|
||||
|
||||
It can be useful to, for example, display or hide the same `FocusModal` component
|
||||
via multiple triggers, for example, in a table.
|
||||
|
||||
## Usage
|
||||
|
||||
```tsx
|
||||
import { useToggleState } from "@medusajs/ui"
|
||||
```
|
||||
|
||||
```tsx
|
||||
const [state, open, close, toggle] = useToggleState()
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
---
|
||||
|
||||
### Call Signature
|
||||
|
||||
`useToggleState(initial: boolean = false)`
|
||||
|
||||
### Returns
|
||||
|
||||
<HookValues hook="useToggleState" />
|
||||
|
||||
## Examples
|
||||
|
||||
---
|
||||
|
||||
<ComponentExample name="use-toggle-state-demo" />
|
||||
Reference in New Issue
Block a user