toastvibe/README.md

ToastVibe is a lightweight, customizable, and flexible toast notification library for React.

# React ToastVibe 🚀

ToastVibe is a lightweight and customizable toast notification library for React applications. It supports various toast types, customizable positions, rich colors, and auto-dismiss functionality.

## Features 🚀

- 🔥 Supports different toast types: `info`, `success`, `warning`, `error`, `pending`
- 🎨 Rich color gradients and animations
- 🎯 Customizable positioning (`top-left`, `top-right`, `bottom-left`, `bottom-right`, `top-center`, `bottom-center`)
- ⏳ Auto-dismiss feature with configurable duration
- 🚀 Easy-to-use API with React Context

---

## Installation 🚀

You can install ToastVibe via npm or yarn:

```sh
# Using npm
npm install toastvibe

# Using yarn
yarn add toastvibe
```

---

## Usage 🚀

---

#### Using `ToasterContainer` 🚀

You can use the `ToasterContainer` component to control the position and appearance of toasts.

```tsx
import { ToasterContainer } from 'toastvibe';
import 'toastvibe/dist/styles.css';

const MyComponent = () => {
  return (
    <ToasterContainer position="bottom-center" richColors closeButton>
      <button onClick={() => toast.success('Hello from ToastVibe!')}>Show Toast</button>
    </ToasterContainer>
  );
};

```



#### Displaying Toast Messages 🚀

You can trigger toast notifications using the `toast` object.

```tsx
import { toast } from 'toastvibe';

// Info Toast
toast.info('This is an info message!');

// Success Toast
toast.success('Operation successful!');

// Warning Toast
toast.warning('Warning: Check your inputs.');

// Error Toast
toast.error('Something went wrong!');

// Pending Toast (with status update)
const toastId = toast.pending('Processing your request...');
setTimeout(() => toast.updateStatus(toastId, 'completed'), 3000);
```

#### Customizing Toasts 🚀

You can customize each toast with additional options.

```tsx
toast.success('Custom success message', {
  position: 'bottom-left',
  richColors: true,
  duration: 5000,
  closeButton: false,
});
```



#### API Reference 🚀

#### `ToasterContainer` 🚀

| Prop          | Type      | Default       | Description |
|--------------|----------|--------------|-------------|
| `position`   | `ToastPosition` | `'top-right'` | Position of the toast container |
| `richColors` | `boolean` | `false` | Enables animated color gradients |
| `closeButton` | `boolean` | `true` | Shows a close button on toasts |
| `className`  | `string`  | `undefined` | Custom class name for styling |
| `duration`   | `number`  | `3000` | Auto-dismiss duration in milliseconds |

### `toast` Methods 🚀

| Method               | Description |
|----------------------|-------------|
| `toast.info(message, options?)` | Show an info toast |
| `toast.success(message, options?)` | Show a success toast |
| `toast.warning(message, options?)` | Show a warning toast |
| `toast.error(message, options?)` | Show an error toast |
| `toast.pending(message, options?)` | Show a pending toast (can be updated) |
| `toast.updateStatus(index, status)` | Update a pending toast status |



## License 🚀

### MIT License

##### Copyright (c) 2023 [Sahil Mallick ]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.