# Sonner

An opinionated toast component for React.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).





<ComponentPreview name="sonner-demo">
  <SonnerDemo />
</ComponentPreview>

## Installation [#installation]

<Tabs defaultValue="cli">
  <TabsList>
    <TabsTrigger value="cli">
      CLI
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add https://shadcn-cssinjs.com/r/sonner.json
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      pnpm add sonner
      ```

      <Step>
        Make sure [StyleX is configured](/docs/installation) and the design tokens are
        installed.
      </Step>

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource name="sonner" title="sonner.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</Tabs>

## Usage [#usage]

```tsx
import { Toaster } from "@/components/ui/sonner/sonner";
import { toast } from "sonner";
```

```tsx
// Add <Toaster /> to your root layout, then:
toast("Event has been created");
```

## Examples [#examples]



### Types [#types]

<ComponentPreview name="sonner-types">
  <SonnerTypes />
</ComponentPreview>

### Description [#description]

<ComponentPreview name="sonner-description">
  <SonnerDescription />
</ComponentPreview>

### Position [#position]

<ComponentPreview name="sonner-position">
  <SonnerPosition />
</ComponentPreview>



## RTL [#rtl]

To enable right-to-left support, see the [RTL guide](/docs/rtl).

<ComponentPreview name="sonner-rtl" direction="rtl">
  <SonnerRtl />
</ComponentPreview>

## API Reference [#api-reference]

See the [Sonner](https://sonner.emilkowal.ski/) documentation for the full API reference.