@incoresoft/incoresoft-icons

@incoresoft/incoresoft-icons

SVG icon components of Incoresoft VMS for Vue 3: the icons used across the VMS interface, for building VMS plugins that match it. Required by @incoresoft/incoresoft-ui.

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, so at runtime the plugin uses the icons of the VMS it runs in; the npm package is what you build and type-check against:

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

Installation

npm install @incoresoft/incoresoft-icons

Peer dependency: vue 3.

Usage

Every icon is a Vue component named ISIcon<Name>:

<template>
  <ISIconClose class="close-icon" @click="close" />
</template>

<script setup lang="ts">
import { ISIconClose } from '@incoresoft/incoresoft-icons'
</script>

• Monochrome icons (ISIconClose, ISIconPencil, …) are drawn in the neutral VMS grey. Colour them from CSS through their fill, for example .close-icon [fill] { fill: currentColor; }.
• Coloured icons (ISIconColored<Name>) keep their own palette; use them where VMS shows a coloured glyph, such as a plugin or section icon.

Type declarations are included (dist/index.d.ts); your editor lists every available icon.

Compatibility and support

The public API is the set of ISIcon* exports. Versions follow the VMS release line: 25.1.x is compatible with VMS 25.1.

Licence

See the LICENSE file in this package.