@oicl/openbridge-webcomponents
v0.0.20260411072018
Published
The core library of the OpenBridge design system, implemented as Lit-based web components.
Readme
@oicl/openbridge-webcomponents
The core library of the OpenBridge design system, implemented as Lit-based web components.
🏗️ Project Status
This library is currently in active development. We are gearing up for our first stable release in Q2 2026.
👉 Click here to read more about the project and the JIP.
📚 Storybook & Demo
- Storybook: Browse components and view their different states.
- Live Demo: See the components in action.
💾 Installation
To use the components in your project, install the package from npm:
npm install @oicl/openbridge-webcomponentsNote: If you are using Vue, React, Angular, or Svelte, we recommend using our wrapper packages for a better developer experience.
🚀 Quick Setup
1. Include CSS Palettes
Import the global OpenBridge CSS file in your main entry point:
import '@oicl/openbridge-webcomponents/dist/openbridge.css';2. Set the Theme
Select the palette by setting the data-obc-theme attribute on the html tag (bright, day, dusk, or night):
<html lang="en" data-obc-theme="day"></html>3. Set Component Size
Select the global component size by setting a class on the body tag (obc-component-size-regular, medium, large, or xl):
<body class="obc-component-size-regular"></body>4. Font Setup
The library uses Noto Sans. You should ensure it is available in your project.
@font-face {
font-family: 'Noto Sans';
src: url('path/to/NotoSans.ttf');
}
* {
font-family: 'Noto Sans', sans-serif;
}🧩 Usage
Standard Web Components
Import the components you need:
import '@oicl/openbridge-webcomponents/dist/components/top-bar/top-bar.js';Use them in your HTML:
<obc-top-bar></obc-top-bar>Bundle Version (CDN / Prototyping)
For quick prototyping, you can use the bundled version:
<script
type="module"
src="node_modules/@oicl/openbridge-webcomponents/dist/openbridge-webcomponents.bundle.js"
></script>📦 Framework Wrappers
For the best experience in your framework of choice, use our auto-generated wrappers:
@oicl/openbridge-webcomponents-vue@oicl/openbridge-webcomponents-react@oicl/openbridge-webcomponents-ng@oicl/openbridge-webcomponents-svelte
👫 Contributing
Contributions are welcome! Please see the root README and CONTRIBUTING.md for development instructions.
