@gridsuite/commons-ui
v0.70.0
Published
common react components for gridsuite applications
Downloads
2,088
Keywords
Readme
commons-ui
Library for sharing GridSuite apps commons components
For developers
The commons-ui library have a demo app in which you can call your components to test them.
The npm start
command install the library's dependencies then launches the demo app.
If you want to test your library integration with a consumer application my-app you have first to build commons-ui via
npm install
(if not already done to gettsc
)npm run build:pack
Then in the my-app project :
- Change the commons-ui dependency in my-app's package.json from
@gridsuite/commons-ui:"^x.x.x"
to@gridsuite/commons-ui:"file:{PATH_TO_LIBRARY}/gridsuite-commons-ui-{LIBRARY_VERSION}.tgz"
npm install
npm start
Warning : with Create React App, we realised the library was not updating correctly if you try to install the library multiple times. To fix this, run this command from the app after running "npm install"
- rm -Rf node_modules/.cache
For integrators
If you want to deploy a new version of commons-ui in the NPM package registry, you need to follow the steps below:
- Make a release action
- In the 'run workflow' combobox select, let the branch on main
- Enter the type of evolution (major | minor | patch)
- Click 'run workflow'
License Headers and dependencies checking
To check dependencies license compatibility with this project one locally, please run the following command :
npm run licenses-check
Notes :
- Check license-checker-config.json for license white list and exclusion. If you need to update this list, please inform organization's owners.