solid-sonner - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #llm #go #machine-learning #rust #docker #windows #awesome #cli #kubernetes #vue #pytorch

solid-sonner

(★ 100)

An opinionated toast component for Solid.

파일 탐색기

최종 버전 다운로드 (.zip)

- config.json
- README.md
- - ci.yml
  - release.yml
- dependabot.yml
- pre-commit
- App.tsx
- index.html
- index.tsx
- logo.svg
- styles.css
- tsconfig.json
- vite.config.ts
- assets.tsx
- index.tsx
- primitives.ts
- shims.d.ts
- state.ts
- styles.css
- types.ts
- Basic.test.tsx
.editorconfig
.gitignore
.npmrc
CHANGELOG.md
env.d.ts
LICENSE
package.json
playwright.config.ts
pnpm-lock.yaml
README.md
tsconfig.json
vite.config.ts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/wobsoriano/solid-sonner

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd solid-sonner

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm i solid-sonner

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn add solid-sonner

이 명령어를 터미널에 그대로 입력해 실행하세요.

pnpm add solid-sonner

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p>
  <img width="100%" src="https://assets.solidjs.com/banner?type=solid-sonner&background=tiles&project=%20" alt="solid-sonner">
</p>

# solid-sonner

[![pnpm](https://img.shields.io/badge/maintained%20with-pnpm-cc00ff.svg?style=for-the-badge&logo=pnpm)](https://pnpm.io/)

An opinionated toast component for Solid.

This package tracks the React [Sonner](https://sonner.emilkowal.ski/) API as closely as possible while keeping the implementation Solid-friendly.

## Install

```bash
npm i solid-sonner
# or
yarn add solid-sonner
# or
pnpm add solid-sonner
```

## Quick start

```tsx
import { Toaster, toast } from 'solid-sonner';

export default function App() {
  return (
    <div>
      <Toaster />
      <button onClick={() => toast('My first toast')}>Give me a toast</button>
    </div>
  );
}
```

## API

Exports:

- `Toaster`
- `toast`
- `useSonner`
- types: `Action`, `ExternalToast`, `ToastClassnames`, `ToastT`, `ToastToDismiss`, `ToasterProps`

### Toast types

```tsx
toast('Event has been created');
toast.success('Event has been created');
toast.info('Event has new information');
toast.warning('Event has warning');
toast.error('Event has not been created');
toast.loading('Loading data');
```

With description, icon, and actions:

```tsx
toast('Event has been created', {
  description: 'Monday, January 3rd at 6:00pm',
  icon: <MyIcon />,
  action: {
    label: 'Undo',
    onClick: () => console.log('Undo'),
  },
  cancel: {
    label: 'Cancel',
  },
});
```

### Promise toasts

```tsx
toast.promise(fetchData(), {
  loading: 'Loading...',
  success: (data) => `${data.name} has been added!`,
  error: 'Error',
});
```

Extended results are supported too:

```tsx
toast.promise(saveProject(), {
  loading: 'Saving...',
  success: (result) => ({
    message: 'Project saved',
    description: result.id,
  }),
  error: (error) => ({
    message: 'Save failed',
    description: String(error),
  }),
});
```

### Updating and dismissing

```tsx
const id = toast('Uploading...', { duration: Number.POSITIVE_INFINITY });

toast.success('Done', { id });
toast.dismiss(id);
toast.dismiss();
```

### Headless custom toasts

```tsx
toast.custom((id) => (
  <div>
    Custom toast <button onClick={() => toast.dismiss(id)}>close</button>
  </div>
));
```

### Read current state

```tsx
const { toasts } = useSonner();

toast.getToasts();
toast.getHistory();
```

## Toaster props

```tsx
<Toaster
  theme="system"
  position="top-right"
  richColors
  closeButton
  expand
  visibleToasts={5}
  duration={5000}
  gap={14}
  offset={32}
  mobileOffset={{ bottom: 24, left: 16, right: 16 }}
  hotkey={['altKey', 'KeyT']}
  dir="auto"
  swipeDirections={['top', 'right']}
  containerAriaLabel="Notifications"
  toastOptions={{
    className: 'my-toast',
    descriptionClassName: 'my-toast-description',
    closeButtonAriaLabel: 'Close notification',
    classNames: {
      toast: 'toast',
      title: 'title',
      description: 'description',
    },
  }}
/>
```

Legacy aliases from older `solid-sonner` versions still work for compatibility:

- `class` -> `className`
- `classes` -> `classNames`
- `descriptionClass` -> `descriptionClassName`

## Multiple toasters

```tsx
<>
  <Toaster />
  <Toaster id="sidebar" position="top-left" />
</>;

toast('Global toast');
toast('Sidebar toast', { toasterId: 'sidebar' });
```

## Tailwind / unstyled mode

```tsx
<Toaster
  toastOptions={{
    unstyled: true,
    classNames: {
      toast: 'bg-blue-500 text-white',
      title: 'font-semibold',
      description: 'text-blue-100',
      actionButton: 'bg-white text-blue-700',
      cancelButton: 'bg-blue-700 text-white',
      closeButton: 'bg-white text-black',
    },
  }}
/>
```

## Notes

- `pauseWhenPageIsHidden` is available and defaults to Sonner-like hidden-page pausing behavior
- Per-toast `closeButton`, `dismissible`, `richColors`, `testId`, and `toasterId` are supported
- `action` respects `event.preventDefault()` and will keep the toast open

## License

MIT