@oicl/openbridge-webcomponents-react

0.0.15 • Public • Published

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

Watch the video

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-react

See also the react demo

Setup

  1. Add the css file to your project:

    import '@oicl/openbridge-webcomponents/src/palettes/variables.css'
  2. Select the pallet by setting the data-obc-theme attribute on the html tag:

    <html lang="en" data-obc-theme="day">
  3. Install the Noto Sans font by using the attached NotoSans.ttf file. Add the following to your css:

    @font-face {
    font-family: 'Noto Sans';
    src: url('path/to/NotoSans.ttf');
    }
    
    * {
       font-family: Noto Sans;
    }
  4. Import the desired components in your project, for instance:

    import {ObcTopBar} from '@oicl/openbridge-webcomponents-react/components/top-bar/top-bar'
  5. Use the components in your project:

    <ObcTopBar></ObcTopBar>

Contributing

Contributions are welcome!

Dependents (0)

Package Sidebar

Install

npm i @oicl/openbridge-webcomponents-react

Weekly Downloads

237

Version

0.0.15

License

Apache-2.0

Unpacked Size

1.14 MB

Total Files

2446

Last publish

Collaborators

  • tibnor