Trends and signals
Scope <smart-scope>
Scope is an oscilloscope display for time-domain signals.
Getting Started with React Scope 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 Scope component, sets the properties the demo sets and handles the channelVisibilityChange 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 { Scope } from 'smart-industrial/react/scope';
function App() {
// Raised when a channel is shown or hidden from the legend or through
// toggleChannel.
const handleChannelVisibilityChange = (event: CustomEvent) => {
const { index, field, visible } = event.detail;
console.log('channelVisibilityChange', index, field, visible);
};
return (
<Scope
theme="industrial"
sampleRate={1000000}
timePerDivision={0.0001}
triggerLevel={6}
triggerHysteresis={0.5}
label="Gate drive"
onChannelVisibilityChange={handleChannelVisibilityChange}
/>
);
}
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 { Scope, ScopeProps } from 'smart-industrial/react/scope';
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.