@oicl/openbridge-webcomponents-react

0.0.16 • Public • Published

Openbridge Web Components React

discord, join chat

Welcome to the react wrapper of Openbridge Web Components!

🎉 We are preparing to release OpenBridge 6.0 in March 2026 🎉

We are currently developing the code in a joint industry project, with funding from industry partners. The code is only available for the partners until the release in March 2026. It is possible to get access to the code in active development by joining the project.

👉 Click here to read more about the project.

👉 Click here to register your interest in the form. (Note: Registering is not a commitment but will enroll you in our process.)

❗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

Discord server

Join our discord server to get the latest updates and to ask questions. Join here.

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"></html>
  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!

Readme

Keywords

none

Package Sidebar

Install

npm i @oicl/openbridge-webcomponents-react

Weekly Downloads

215

Version

0.0.16

License

Apache-2.0

Unpacked Size

2.99 MB

Total Files

6142

Last publish

Collaborators

  • tibnor