@oicl/openbridge-webcomponents-react v0.0.13
Openbridge Web Components React
Welcome to the react wrapper of Openbridge Web Components!
❗Caution❗ This repository is currently in early development and may not be stable. Please use with caution.
Introduction video
We have made an short introduction to the library. You can watch it here
Slack Channel
Join our slack channel to get the latest updates and to ask questions. Click here to join the slack workspace, and join the #openbridge-webcomponents channel.
Table of Contents
Storybook
Storybook is a development environment for UI components. It allows you to browse a component library, view the different states of each component, and interactively develop and test components in isolation.
To access the Storybook for this project, click here.
Demo
The demo showcases the project's functionality using react. It provides a live demonstration of the project's features and allows you to interact with the application.
To access the demo, click here.
Installation
To use the components in your project, you can install the package from npm:
npm install @oicl/openbridge-webcomponents-reactSee also the react demo
Setup
- Add the css file to your project:
import '@oicl/openbridge-webcomponents/src/palettes/variables.css' - Select the pallet by setting the
data-obc-themeattribute on thehtmltag:<html lang="en" data-obc-theme="day"> Install the Noto Sans font by using the attached
NotoSans.ttffile. Add the following to your css:@font-face { font-family: 'Noto Sans'; src: url('path/to/NotoSans.ttf'); } * { font-family: Noto Sans; }Import the desired components in your project, for instance:
import {ObcTopBar} from '@oicl/openbridge-webcomponents-react/components/top-bar/top-bar'Use the components in your project:
<ObcTopBar></ObcTopBar>
Contributing
Contributions are welcome!