mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-26 06:05:56 +00:00
47c47eaed2
* feat: add base and radix docs * feat: transform code for display * fix * fix * fix * fix * fix * chore: remove claude files * fix * fix * fix * chore: run format:write * fix * feat: add more examples * fix * feat: add aspect-ratio * feat: add avatar * feat: add badge * feat: add breadcrumb * fix * feat: add button * fix * fix * fix * feat: add calendar and card * feat: add carousel * fix: chart * feat: add checkbox * feat: add collapsible * feat: add combobox * feat: add command * feat: add context menu * feat: add data-table dialog and drawer * feat: dropdown-menu * feat: add date-picker * feat: add empty * feat: add field and hover-card * fix: input * feat: add input * feat: add input-group * feat: add input-otp * feat: add item * feat: add kbd and label * feat: add menubar * feat: add native-select * feat: add more components * feat: more components * feat: more components * feat: add skeleton, slider and sonner * feat: add spinner and switch * feat: add more components * fix: tabs * fix: tabs * feat: add docs for sidebar * fix * fix * fi * docs: update * fix: create page * fix * fix * chore: add changelog * fix
127 lines
2.1 KiB
Plaintext
127 lines
2.1 KiB
Plaintext
---
|
|
title: Sonner
|
|
description: An opinionated toast component for React.
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://sonner.emilkowal.ski
|
|
---
|
|
|
|
<ComponentPreview styleName="base-nova" name="sonner-demo" />
|
|
|
|
## About
|
|
|
|
Sonner is built and maintained by [emilkowalski](https://twitter.com/emilkowalski).
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Run the following command:</Step>
|
|
|
|
```bash
|
|
npx shadcn@latest add sonner
|
|
```
|
|
|
|
<Step>Add the Toaster component</Step>
|
|
|
|
```tsx title="app/layout.tsx" {1,9} showLineNumbers
|
|
import { Toaster } from "@/components/ui/sonner"
|
|
|
|
export default function RootLayout({ children }) {
|
|
return (
|
|
<html lang="en">
|
|
<head />
|
|
<body>
|
|
<main>{children}</main>
|
|
<Toaster />
|
|
</body>
|
|
</html>
|
|
)
|
|
}
|
|
```
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<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"
|
|
title="components/ui/sonner.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Add the Toaster component</Step>
|
|
|
|
```tsx showLineNumbers title="app/layout.tsx" {1,8}
|
|
import { Toaster } from "@/components/ui/sonner"
|
|
|
|
export default function RootLayout({ children }) {
|
|
return (
|
|
<html lang="en">
|
|
<head />
|
|
<body>
|
|
<Toaster />
|
|
<main>{children}</main>
|
|
</body>
|
|
</html>
|
|
)
|
|
}
|
|
```
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import { toast } from "sonner"
|
|
```
|
|
|
|
```tsx
|
|
toast("Event has been created.")
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Types
|
|
|
|
<ComponentPreview styleName="base-nova" name="sonner-types" />
|
|
|
|
### Description
|
|
|
|
<ComponentPreview styleName="base-nova" name="sonner-description" />
|
|
|
|
### Position
|
|
|
|
Use the `position` prop to change the position of the toast.
|
|
|
|
<ComponentPreview styleName="base-nova" name="sonner-position" />
|
|
|
|
## API Reference
|
|
|
|
See the [Sonner API Reference](https://sonner.emilkowal.ski/api) for more information.
|