@incoresoft/incoresoft-toasts

@incoresoft/incoresoft-toasts

Toast notifications of Incoresoft VMS for Vue 3: the success, warning and error messages shown in the corner of the VMS interface.

This package targets VMS release 25.1. Use the 25.1.x versions with a 25.1 VMS.

How it is used in a VMS plugin

A VMS frontend plugin shares this package as a singleton provided by the VMS host. A toast raised by the plugin therefore appears in the same place, with the same look, as the VMS's own toasts; the host already renders the toast container. The npm package is what you build and type-check against:

// webpack.config.js of the plugin (ModuleFederationPlugin → shared)
'@incoresoft/incoresoft-toasts': { singleton: true, requiredVersion: false, import: false }

Installation

npm install @incoresoft/incoresoft-toasts

Peer dependencies: vue 3 and pinia 2.

Usage

import { ToastsService } from '@incoresoft/incoresoft-toasts'

ToastsService.success('SAVED')
ToastsService.error('CONNECTION_FAILED')

const toast = ToastsService.warning('SYNC_IN_PROGRESS', { autoClose: 0 })
ToastsService.hide(toast.uuid)

A text content is a locale key, translated through the application's vue-i18n instance; inside VMS that is the host's, which also holds the plugin's own locales, so pass keys rather than ready text. The title line defaults to the translated type (success, error, warning). Options (IToastOptions):

The content may also be a Vue component, rendered inside the toast with props.

For a standalone page outside VMS: install vue-i18n and pinia in the app, register the plugin with app.use(IncoresoftToasts) (default export), and render <ISToastsManager /> once in the root component.

Type declarations are included (dist/index.d.ts).

Compatibility and support

The public API is ToastsService, ISToastsManager, the default export and the TToastContent and IToastOptions types. Versions follow the VMS release line: 25.1.x is compatible with VMS 25.1.

Licence

See the LICENSE file in this package.