ust-finx-snackbar/README.md

markdown # UST Finx Snackbar

markdown
# UST Finx Snackbar

A Vue 3 component for displaying notifications/snackbars, built with TypeScript. This component is designed to integrate seamlessly with Vue 3 applications and provides a customizable notification system.

## Features

- Built with Vue 3 and TypeScript.
- Supports Vuetify for styling.
- Customizable notification messages.
- Easy integration with Vue applications.
- Supports modern JavaScript and TypeScript features.

## Installation

Install the package using npm:

```bash
npm install ust-finx-snackbar
```

## Usage

### Basic Usage

Import and use the `UstSnackbar` component in your Vue application:

```typescript
import { createApp } from 'vue';
import App from './App.vue';
import UstSnackbar from 'ust-finx-snackbar';

const app = createApp(App);

app.use(UstSnackbar);
app.mount('#app');
```

### Example

```vue
<template>
  <UstSnackbar />
</template>
```

## Scripts

The following npm scripts are available:

- `dev`: Start the development server using Vite.
- `build`: Build the project using `vue-tsc` and Vite.
- `preview`: Preview the production build.
- `lint`: Run ESLint to check and fix code issues.
- `style:check`: Check code formatting with Prettier.
- `style:format`: Format code with Prettier.
- `type-check`: Perform TypeScript type checking.

Run a script using:

```bash
npm run <script-name>
```

## Development

### Prerequisites

- Node.js
- npm

### Setup

1. Clone the repository.
2. Install dependencies:

   ```bash
   npm install
   ```

3. Start the development server:

   ```bash
   npm run dev
   ```

### Build

To build the project for production:

```bash
npm run build
```

## Configuration

### TypeScript Configuration

The project uses the following TypeScript configurations:

- `tsconfig.node.json`: Configuration for Node.js-related builds.
- `tsconfig.app.json`: Configuration for the application.

### Linting and Formatting

- ESLint is used for linting.
- Prettier is used for code formatting.

## Dependencies

- `vue`: ^3.5.13
- `vuetify`: ^3.8.2
- `pinia`: ^3.0.2

## Author

**Satyam Dasari**  
Email: satyamd@fincuro.com

## License

This project is licensed under the MIT License.