Skip to content
OmniSci UI components
Branch: master
Clone or download

README.md

Omnisci-ui

The next generation of UI components for Immerse. The project is in early-beta. The documentation is available at https://omnisci.github.io/omnisci-ui/styleguide/

The goal is to simply provide a theme for RMWC, a React wrapper using the official Material css. In that case, you can simply use the compiled css with your own Material markup or using RMWC directly. But we also wrap some components to simplify them, write custom ones and style external components with a Material theme, available in the compiled js. We don't have an npm package yet, so the best way to use it in your project is to point your package.json to latest on master.

The master branch is using RMWC 4.0.6, an earlier version compatible with IE11. A version using latest RMWC is maintained on this branch while we figure out how to drop IE11 support.

For the curious, here's an example of using omnisci-ui in the browser (IE11 compatible).

How to contribute

Styleguidist needs this hack for their react version to work with scss:

export SASS_PATH=./node_modules

Then run:

npm run styleguide
npm run styleguide:build
npm run dev
npm run test
You can’t perform that action at this time.