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 React MimicSymbol Component

The Smart.Industrial React components need React 18 or later, because they render through react-dom/client. The steps use Vite with its react-ts template.

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

1 Create a Vite + React + TypeScript app

npm create vite@latest my-smart-app -- --template react-ts

```
cd my-smart-app
```
then
```
npm install
```

2 Install Smart.Industrial

npm install smart-industrial

3 Import styles and render the component

The sample replaces the content of src/App.tsx. It imports the stylesheets and the MimicSymbol component, sets the properties the demo sets and handles the symbolClick event. It compiles under the template's strict TypeScript settings.

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 { MimicSymbol } from 'smart-industrial/react/mimicsymbol';

function App() {
  // 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.
  const handleSymbolClick = (event: CustomEvent) => {
    const { label, symbol, state } = event.detail;
    console.log('symbolClick', label, symbol, state);
  };

  return (
    <MimicSymbol
      theme="industrial"
      symbol="pump"
      label="P-2101A"
      state="running"
      value="312 L/min"
      onSymbolClick={handleSymbolClick}
    />
  );
}

export default App;

The template's src/main.tsx renders App and needs no change.

Each component has an entry point of its own, and the sample imports from it. The entry point with all the components, smart-industrial/react, puts every component into the bundle, about 2.5 MB minified. Built with Vite, the Faceplate sample has 390 kB of JavaScript, React included, with smart-industrial/react/faceplate.

4 Run the dev server

npm run dev

Vite prints the URL of the application, usually http://localhost:5173/.

TypeScript Support

The types ship with smart-industrial. A type-only import of the component and its props uses import type, which the template's verbatimModuleSyntax requires:

import type { MimicSymbol, MimicSymbolProps } from 'smart-industrial/react/mimicsymbol';

Each on* callback receives a CustomEvent whose detail is typed for that event, so the editor lists its fields. A handler typed (event: CustomEvent) => void, as in the sample, accepts it as well.

The keyboard interaction, roles and announcements of the component are on its accessibility page; they are the same in React.