0.0.1 • Published 4 months ago
sdmx-dashboard-react v0.0.1
SDMX Dashboard React Component
Embeddable React components to create a dashboard for SDMX data. The components are built using Vite.
Project generated thanks to this great article: Create a Component Library Fast🚀(using Vite's library mode)
Usage
This library provides a SDMXDashboard
component that generates a React dashboard from a JSON configuration file passed via dashUrl
.
More information on the syntax of the configuration file can be found here
npm install sdmx-dashboard-react
import { SDMXDashboard } from 'sdmx-dashboard-react';
const App = () => {
return (
<SDMXDashboard
dashUrl='path/to/dashboard.json'
/>
);
};
Development
npm install
npm run dev
The components are located in the lib
folder where as the src
folder hosts a demo application.
The vite preview mode can also be used to test the built library in the demo application.
npm run preview
Build
npm run build