@xplortech/insights-elements
v0.0.3
Published
Web Components for Xplor Insights
Downloads
426
Keywords
Readme
@xplortech/insights-elements
Web Components for Xplor Insights. This package provides framework-agnostic web components that can be used in any web application.
<insights-wrapper api-url="http://localhost:3000/v1" token="YOUR_TOKEN">
<insights-donut-chart id="donutChart" report-name="memberships-by-type"></insights-donut-chart>
</insights-wrapper>Installation
npm install @xplortech/insights-elementsUsage
See the StoryBook for usage instructions and examples.
Local Development
Setup
- From the root project, run
nvm installandnvm useto use the proper Node version - From the root, run
npm cito install dependencies - From the root, run
npm run lerna-buildto build all packages
Development
- Run
npm startfrom this package to start the development server - Update
index.htmlfor testing changes locally
Storybook
- Run
npm run storybookto start the Storybook development server - Add new stories following the existing story patterns in the
stories/directory
Upgrade Apollo Data
In order to upgrade the version of apollo-data, run from the root:
npm i @xplortech/apollo-data@[version] -w packages/insights-elements