Instrument readouts and controls
Bar Graph <smart-bar-graph>
BarGraph is a segmented level meter, such as the column of lit blocks on an audio console or a vibration monitor.
Getting Started with React BarGraph 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
thennpm 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 BarGraph component, sets the Industrial theme and handles the change 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 { BarGraph } from 'smart-industrial/react/bargraph';
function App() {
// Raised when the value changes through a click or the keyboard.
const handleChange = (event: CustomEvent) => {
const { value } = event.detail;
console.log('change', value);
};
return (
<BarGraph
theme="industrial"
interactive
onChange={handleChange}
/>
);
}
export default App;
The sample sets interactive because the component takes input from the operator only when it is interactive.
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 { BarGraph, BarGraphProps } from 'smart-industrial/react/bargraph';
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.
Accessibility
The keyboard interaction, roles and announcements of the component are on its accessibility page; they are the same in React.