@nexim/snackbar/README.md

Snackbar component with signal capability.

# @nexim/snackbar

Snackbar component with signal capability.

![NPM Version](https://img.shields.io/npm/v/@nexim/snackbar)
![npm bundle size](https://img.shields.io/bundlephobia/min/@nexim/snackbar)
![Build & Lint & Test](https://github.com/the-nexim/design-system/actions/workflows/build-lint-test.yaml/badge.svg)
![NPM Downloads](https://img.shields.io/npm/dm/@nexim/snackbar)
![NPM License](https://img.shields.io/npm/l/@nexim/snackbar)

## Overview

Snackbar component. It includes utilities for managing the snackbar's state and animations.

## Installation

Install the package using npm or yarn:

```sh
npm install @nexim/snackbar

# Or using yarn
yarn add @nexim/snackbar
```

## API

### snackbarSignal

To display a snackbar, emit the snackbarSignal with the desired options. Note that `snackbarSignal` is debounced by 50ms, meaning rapid successive calls will only trigger the last one.

```ts
import { snackbarSignal } from '@nexim/snackbar';

snackbarSignal.notify({
  content: 'This is a snackbar message',
  action: {
    label: 'Undo',
    handler: () => {
      console.log('Action button clicked');
    },
  },
  duration: '5s',
  addCloseButton: true,
});
```