Instrument readouts and controls

Touch Keyboard `<smart-touch-keyboard>`

TouchKeyboard is the on-screen keyboard for a panel PC that has none, or a kiosk browser whose system keyboard covers the field it types into.

Getting Started with Vue TouchKeyboard 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-touch-keyboard 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-touch-keyboard>, sets the properties the demo sets and handles the accept 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.touchkeyboard.js';

// Raised by Enter in a one-line field.
function onAccept(event) {
  const { value } = event.detail;
  console.log('accept', value);
}
</script>

<template>
  <smart-touch-keyboard
    target="#batchForm"
    @accept="onAccept"
  ></smart-touch-keyboard>
</template>

The minimum of Vue 3.2.38 comes from events with an uppercase letter in their name, such as @setpointChange on the faceplate. Vue 3.2.38 and later listen for such an event under its own name. Earlier versions listen for the kebab-case name, which the components never raise.

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