mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 19:35:06 +03:00
Jonathan Summers-MuirandIvan Vasilov
f912536db8
* fix toast examples * add sonner stuff * new sonner examples added * updated * add upload POC * add * Update sonner-upload.tsx * move statusicons * Minor fix. --------- Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
98 lines
1.6 KiB
Plaintext
98 lines
1.6 KiB
Plaintext
---
|
|
title: Sonner
|
|
description: An opinionated toast component for React.
|
|
component: true
|
|
links:
|
|
doc: https://sonner.emilkowal.ski
|
|
source:
|
|
shadcn: true
|
|
---
|
|
|
|
<ComponentPreview name="sonner-demo" peekCode wide />
|
|
|
|
## About
|
|
|
|
Sonner is built and maintained by [emilkowalski\_](https://twitter.com/emilkowalski_).
|
|
|
|
## Installation
|
|
|
|
<Steps>
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install sonner next-themes
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource name="sonner" />
|
|
|
|
<Step>Add the Toaster component</Step>
|
|
|
|
```tsx title="app/layout.tsx" {1,9}
|
|
import { Toaster } from '@/components/ui/sonner'
|
|
|
|
export default function RootLayout({ children }) {
|
|
return (
|
|
<html lang="en">
|
|
<head />
|
|
<body>
|
|
<main>{children}</main>
|
|
<Toaster />
|
|
</body>
|
|
</html>
|
|
)
|
|
}
|
|
```
|
|
|
|
</Steps>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { toast } from 'sonner'
|
|
```
|
|
|
|
```tsx
|
|
toast('Event has been created.')
|
|
```
|
|
|
|
## Expand
|
|
|
|
You can change the amount of toasts visible through the visibleToasts prop.
|
|
|
|
```tsx
|
|
<Toaster expand={true | false} />
|
|
```
|
|
|
|
You can use the Input below to try it out.
|
|
|
|
<SonnerExpandConfig />
|
|
|
|
## Position
|
|
|
|
You can change the amount of toasts visible through the visibleToasts prop.
|
|
|
|
```tsx
|
|
<Toaster
|
|
position={
|
|
'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'top-center' | 'bottom-center'
|
|
}
|
|
/>
|
|
```
|
|
|
|
You can use the Input below to try it out.
|
|
|
|
<SonnerPositionConfig />
|
|
|
|
## Types
|
|
|
|
You can customize the type of toast you want to render, and pass an options object as the second argument.
|
|
|
|
<ComponentPreview name="sonner-types" />
|
|
|
|
## Upload example
|
|
|
|
<ComponentPreview name="sonner-upload" />
|