Operator screens and process graphics

Mimic Symbol `<smart-mimic-symbol>`

MimicSymbol displays one piece of equipment on a process diagram, such as a pump, a valve, a tank or a motor, with its tag, state and reading.

Getting Started with Vue MimicSymbol Component

Smart.Industrial supports Vue 3.2.38 and later, with Vite. Vue uses the custom elements directly, so there is no wrapper to install.

The complete demo in Vue is on the demo page, file by file.

Scaffold with Vite (Vue 3)

The official scaffolding tool creates the project:

npm create vue@latest

The tool asks about TypeScript, Router, Pinia and other options. The defaults are enough for the sample.

cd <your-project-name>
npm install
npm install smart-industrial
npm run dev

Vue + TypeScript

A TypeScript project has vite.config.ts in place of vite.config.js, with the same configuration.

Teach Vue about custom elements

The isCustomElement option of the Vue plugin passes smart-* tags to the browser as custom elements. Without it, Vue looks for a Vue component named smart-mimic-symbol and warns that it cannot resolve it. Other plugins that the scaffold added, such as vueDevTools(), stay in the list.

import { fileURLToPath, URL } from 'node:url'

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          isCustomElement: (tag) => tag.startsWith('smart-')
        }
      }
    })
  ],
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url))
    }
  }
})

App.vue example

The sample replaces src/App.vue. It imports the stylesheets and the module that defines <smart-mimic-symbol>, sets the properties the demo sets and handles the symbolClick event.

<script setup>
import 'smart-industrial/source/styles/smart.default.css';
import 'smart-industrial/source/styles/smart.industrial-elements.css';
import 'smart-industrial/source/styles/smart.industrial.css';
import 'smart-industrial/source/modules/smart.mimicsymbol.js';

// Raised when the symbol is chosen, by click or by pressing Enter or Space
// while it has focus, typically used to select the item and open its detail.
function onSymbolClick(event) {
  const { label, symbol, state } = event.detail;
  console.log('symbolClick', label, symbol, state);
}
</script>

<template>
  <smart-mimic-symbol
    theme="industrial"
    symbol="pump"
    label="P-2101A"
    state="running"
    value="312 L/min"
    @symbolClick="onSymbolClick"
  ></smart-mimic-symbol>
</template>

A listener for an event with an uppercase letter in its name, such as @symbolClick, needs Vue 3.2.38 or later. Earlier versions listen for symbol-click, which the component never raises.

With TypeScript, the script tag is <script setup lang="ts"> and the handler's parameter is typed as CustomEvent.

Run and build

The development server runs at http://localhost:5173/:

npm run dev

The production build goes to ./dist:

npm run build