@it-enterprise/forcebpm-ui-kit

ForceBPM UI Kit

A Vue 3 component library for ForceBPM applications, built on top of Vuetify 3.

Installation

npm install @it-enterprise/forcebpm-ui-kit

Requirements

The package ships raw Vue SFC and SCSS sources, so the host application must use a bundler that can process .vue and .scss files (Vite, Webpack with vue-loader, etc.).

Usage

1. As a plugin

// main.js
import { createApp } from 'vue'
import App from './App.vue'

import vuetify from './plugins/vuetify'
import i18n from './plugins/i18n'
import emitter, { eventBusPlugin } from './plugins/eventBus'
import events from './plugins/eventBus/events'

import ForceBPMUiKit from '@it-enterprise/forcebpm-ui-kit'

const app = createApp(App)

app.use(vuetify)
app.use(i18n)
app.use(eventBusPlugin)

app.use(ForceBPMUiKit, { i18n, emitter, events })

app.mount('#app')

2. Event bus

Some components can be triggered programmatically through an external event bus. Pass a mitt (or compatible) instance as emitter and an events map that the components use to subscribe to the correct event names.

// plugins/eventBus/events.js
export default {
  modal: {
    sharingAccess: 'sharing-access'
  },
  confirm: 'confirm-dialog'
}

// trigger a modal from anywhere in the app
emitter.emit(events.modal.sharingAccess, payload)
emitter.emit(events.confirm, payload)

Plugin options

Components

Layout & overlays

Inputs & pickers

Feedback & state

Display

Utilities

import { hexToRGBA, createRadialGradient, colorCollection } from '@it-enterprise/forcebpm-ui-kit'

Localization

Built-in locales:

• en — English
• uk — Українська
• ru — Русский

Add more or override existing keys via the messages plugin option.

Development

npm install
npm run test         # run vitest in watch mode
npm run test:run     # single test run
npm run test:coverage
npm run lint
npm run format

License

ISC — see LICENSE.