> For the complete documentation index, see [llms.txt](https://smwb-tech.gitbook.io/vue-flash-message/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://smwb-tech.gitbook.io/vue-flash-message/master.md).

# Getting Started

The Vue.js component to display single flash message or multiple flash messages to user. It has styles presets, but can be easily customized by passing style object as argument.

### Installation

Use your package manager to install the package

```bash
## Install via npm
npm i @smartweb/vue-flash-message

## Install via yarn
yarn add @smartweb/vue-flash-message
```

### Setup and Configuration in Vue project

Register the component in your app entry point (main.js or as you called it)

```javascript
import Vue from 'vue';
import FlashMessage from '@smartweb/vue-flash-message';
Vue.use(FlashMessage);
```

 You can pass [configuration object](/vue-flash-message/configuration.md) as second argument

```javascript
Vue.use(FlashMessage, config);
```

### Setup and Configuration in Nuxt project

Create vue-flash-message.js file in plugins directory and put the following code

```javascript
import Vue from 'vue';
import VueFlashMessage from '@smartweb/vue-flash-message';
 
Vue.use(VueFlashMessage);
```

In your nuxt.config.js file register your plugin

```javascript
 {
     /*  Since Nuxt.js 2.4, mode has been introduced as option of plugins to specify plugin type, possible value are: client or server. ssr: false will be adapted to mode: 'client' and deprecated in next major release.
     More info: https://nuxtjs.org/guide/plugins#client-side-only */
     plugins: [{ src: '~/plugins/flash-message.js', mode: 'client' }]
 },
```

###