@imtf/dashboard-widget
v5.0.2
Published
Readme
@imtf/dashboard-widget - Dashboard Chart Widgets
Part of the Panaché ecosystem. Provides configurable chart-based dashboard widgets for IMTF front-end projects developed with React.
Pre-requisites
The following peer dependencies must be installed:
@mui/material7.1.0 or higher@mui/x-charts8.29.3 or higherreactandreact-dom18.0.0 or 19.0.0 or higher
@mui/material and @mui/x-charts must be kept on the same major line: either @mui/material 7.x with @mui/x-charts 8.x, or @mui/material 9.x with @mui/x-charts 9.x. Mixing majors across the two isn't supported, since @mui/x-charts 8.x itself doesn't support @mui/material 9.
Installation
just run within your project:
# with npm
npm install @imtf/dashboard-widget
# with yarn
yarn add @imtf/dashboard-widgetDevelopment
Prior to development, make sure you have installed the dependencies from the repository root:
pnpm installThen you can start storybook in order to develop and test the components:
# Start storybook (run from repository root)
pnpm run devTesting
To run the tests, just run:
pnpm run testCoverage report can be generated with:
pnpm run test:coverageTests (and coverage) can be run as well with a UI in browser with:
pnpm run test:ui