Skip to content

Commit

Permalink
added API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
@choeqq
choeqq committed Nov 13, 2023
1 parent c6e26a1 commit 6968ccd
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions website/src/pages/toaster.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,19 @@ Changes the directionality of the toast's text.

## API Reference

| Property | Description | Default |
| :------------ | :------------------------------------------------------------------------------------------------: | -------------: |
| theme | Toast's theme, either `light`, `dark`, or `system` | `light` |
| richColors | Makes error and success state more colorful | `false` |
| expand | Toasts will be expanded by default | `false` |
| visibleToasts | Amount of visible toasts | `3` |
| position | Place where the toasts will be rendered | `bottom-right` |
| closeButton | Adds a close button to all toasts, shows on hover | `false` |
| offset | Offset from the edges of the screen. | `32px` |
| dir | Directionality of toast's text | `ltr` |
| hotkey | Keyboard shortcut that will move focus to the toaster area. | `⌥/alt + T` |
| invert | Dark toasts in light mode and vice versa. | `false` |
| toastOptions | These will act as default options for all toasts. See [toast()](/toast) for all available options. | `4000` |
| gap | Gap between toasts when expanded | `14` |
| Property | Description | Default |
| :----------------- | :------------------------------------------------------------------------------------------------: | -------------: |
| theme | Toast's theme, either `light`, `dark`, or `system` | `light` |
| richColors | Makes error and success state more colorful | `false` |
| expand | Toasts will be expanded by default | `false` |
| visibleToasts | Amount of visible toasts | `3` |
| position | Place where the toasts will be rendered | `bottom-right` |
| closeButton | Adds a close button to all toasts, shows on hover | `false` |
| closeAllButton | Adds a close all toasts button, shows on the last visible toast | `false` |
| closeAllButtonText | Makes close all button text customizable | `Close All` |
| offset | Offset from the edges of the screen. | `32px` |
| dir | Directionality of toast's text | `ltr` |
| hotkey | Keyboard shortcut that will move focus to the toaster area. | `⌥/alt + T` |
| invert | Dark toasts in light mode and vice versa. | `false` |
| toastOptions | These will act as default options for all toasts. See [toast()](/toast) for all available options. | `4000` |
| gap | Gap between toasts when expanded | `14` |

0 comments on commit 6968ccd

Please sign in to comment.