docs: add API reference for Toaster component

pheralb · Aug 1, 2024 · 77ddb5e · 77ddb5e
1 parent 40018fa
commit 77ddb5e
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/website/app/routes/toaster.mdx b/website/app/routes/toaster.mdx
@@ -50,3 +50,14 @@ You can change this value using the `toastFont` prop. In this case, we are using
 ```jsx
 <Toaster toastFont="font-sans" />
 ```
+
+## API Reference
+
+The `<Toaster />` component accepts the following options:
+
+| Property    | Description                           | Type                                                                                                                                      | Required |
+| ----------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------- |
+| `theme`     | Theme of the all toasts               | `Theme` (default: `system`): `'light'`, `'dark'`, or `'system'`                                                                           | -        |
+| `maxToasts` | Maximum number of toasts to display   | `number`                                                                                                                                  | -        |
+| `position`  | Position of the toaster on the screen | `Position` (default: `bottom-right`): `'top-left'`, `'top-right'`, `'top-center'`, `'bottom-left'`, `'bottom-right'` or `'bottom-center'` | -        |
+| `toastFont` | Font style for the all toasts         | `string`                                                                                                                                  | -        |