@kuy472013/vue-notification

1.0.7 • Public • Published

npm version npm

Vue.js Notification

This allows settings that do not require individual settings, such as the size, location, and animation of the notification, to be set through props, and is designed to allow individual notification styles to be specified through API.

Setup

package install

npm install --save @kuy472013/vue-notification

main.js

import { createApp } from 'vue'
import App from './App.vue'
import Notifications from '@kuy472013/vue-notification'

const app = createApp(App)
app.use(Notifications)

App.vue

<Notification />

Usage

You can show notifications by calling the registered view plugin.

<template>
  <div id='app'>
    <button @click='test()'>test</button>
  </div>
</template>

<script>
export default {
  name: 'App',
  methods: {
    test: function () {
      this.$notification()
    }
  }
}
</script>

Props

Common notification settings can be changed using props.

<Notification
  position='left-bottom'
  :duration=5000
/>
Name Type Default Description
width Number 250 Option to set the width of the notification element.
(must be a numeric, unit: px)
height Number 50 Option to set the heigth of the notification element.
(must be a numeric, unit: px)
position String center-bottom Option to specify where the notification element will be shown.
Please enter a combination of the values below.
X: ['left', 'right', 'center']
Y: ['top', 'bottom']
speed Number 1000 Option to set the animation duration of the notification element.
(unit: ms)
duration Number 3000 Option to set how long the notification element stays on the screen.
(unit: ms)

API

API provided by notification plugin.

app.$notification({
  type: 'success',
  classes: 'customStyle',
  contents: message,
})
Name Type Default Description
type String info You can use the notification plugin to set among the types of notifications provided by default.
supported types : success, error, warning, info
classes String null You can set up a separate class using the notification plugin to specify custom styles.
contents String message You can configure the content of the notification using the notification plugin.
component Vue Component null By using the notification plugin, you can use a component created separately from the design provided by default.

Package Sidebar

Install

npm i @kuy472013/vue-notification

Weekly Downloads

1

Version

1.0.7

License

MIT

Unpacked Size

26.2 kB

Total Files

5

Last publish

Collaborators

  • kuy472013