Skip to content
Projects

Ocean-Industries-Concept-Lab/openbridge-webcomponents has 109 GitHub stars and 20 forks. GitHot measured +1 stars in 24 hours and +2 in 7 days. Last checked 2026-11-17 02:43 UTC. Last push 2026-11-12.

How these counts are measured

Measured star growth

in 24h
+1
in 7 days
+2
in 15 days
Collecting history
in 1 month
Collecting history

Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.

About

OpenBridge design system implemented as Lit-based web components with support for all major frontend frameworks.

Web & Apps

README.md

Original

Openbridge Web Components

This monorepo contains the OpenBridge design system implemented as web components.

🚀 Project Status

v2.0.0 is out. It adds close to 60 components, among them motion and depth instruments, propulsion and hydraulic automation symbols, tree navigation and a new readout family, together with about 100 fixes. Keyboard navigation and accessibility are now tested on every change, next to the visual snapshots, so what works in your application keeps working. Coming from 1.x? The migration guide shows what to update.

v1.0.0 closed an incredibly productive first year, with more than 200 components implemented. The code was officially opened by Prince Sverre Magnus of Norway and is publicly available, marking our first stable milestone.

🌿 Branching Strategy

We use two long-lived branches to manage our development:

  • develop: This is the active development branch. It contains the latest changes and features. Note that this branch may include breaking changes and is intended for contributors and early adopters. Releases based on this branch are tagged as next on npm.
  • stable: This branch contains the stable, production-ready version of the library. It is updated from the develop branch approximately once every quarter. Releases based on this branch are tagged as latest on npm.

🤝 Support the Project

We are thrilled if you would like to support the OpenBridge Web Components project. Your contribution plays a vital role in maintaining an open, high-quality design system.

We invite industry partners to join our Joint Industry Project. By becoming a donor, you help secure the future of the project and gain influence over the roadmap.

Donor Benefits

By becoming a donor, you aren’t just supporting code—you’re joining a collaborative movement. To show our appreciation, donors receive a specialized benefits package valid for 12 months upon receipt of payment:

  • Proudly Show Your Support: You are authorized to use the official "OpenBridge Member" logo in your marketing materials and corporate communications.
  • Commercial License: You can use every new release under a commercial license before its Apache 2.0 change date, without the AGPL obligations (see LICENSE.txt).

How to Support

If you are interested in supporting the project, please fill out this Support Form.

For more information, please contact Torstein A. Bø at [email protected] or contact us on Slack.

📜 Licensing Model

We will always remain open source, but we have evolved our model to ensure continued development. With the 1.0.0 release, we have transitioned to a new licensing system.

How it works:

Under the new model, each version and each commit in the repository follows a "delayed" permissive license cycle, set out in LICENSE.txt:

  1. Initial Release: Each new version, and each commit in the repository, is licensed under AGPL-3.0-only for the first 180 days after it is first made public.
  2. Transition: After 180 days (the "Change Date"), that version or commit also becomes available under Apache 2.0, irrevocably.
  3. JIP Members: Members of the Joint Industry Project can obtain a commercial license that permits use before the Change Date without the AGPL obligations. Membership is granted by the project: you register through the support form and pay the membership fee; contributing code does not make you a member. A commercial license does not include redistribution under Apache 2.0 before the Change Date.

Example: If version 1.2.2 is released on August 14, 2026:

  • open-source projects and internal users can use it immediately under AGPL-3.0-only.
  • JIP members can use it immediately under a commercial license.
  • From February 10, 2027, version 1.2.2 becomes available to everyone under the Apache 2.0 license (e.g., for commercial use without AGPL restrictions).

💬 Slack

Slack, join chat

Join our Slack to get the latest updates and to ask questions.

🎬 Introduction video

We have made a short introduction to the library.

Watch the video: Intro to OpenBridge Web Components

📂 Monorepo Structure

This repository uses npm workspaces and is organized as follows:

Package Description
packages/openbridge-webcomponents Core Lit-based web components (Source of truth).
packages/openbridge-webcomponents-vue Auto-generated Vue.js wrappers.
packages/openbridge-webcomponents-react Auto-generated React wrappers.
packages/openbridge-webcomponents-ng Auto-generated Angular wrappers.
packages/openbridge-webcomponents-svelte Auto-generated Svelte wrappers.
packages/vue-demo Demo application using Vue.js.
packages/react-demo Demo application using React.
packages/connector-diagram Canvas renderer for pipe and connector diagrams.

📚 Storybook & Demo

Storybook is the component reference: it shows each component in isolation with interactive controls, states, and variants. The Live Demo is an application showcase: it shows how components work together in realistic page flows.

Channel Storybook Live Demo
Stable (stable branch, npm latest) openbridge-storybook.web.app openbridge-demo.web.app
Develop (develop branch, npm next) openbridge-next-storybook.web.app openbridge-next-demo.web.app

🚩 Getting Started Development

To get started with developing the components:

With VS Code Dev Container (Recommended ✅)

  1. Clone the repository.
  2. Open in VS Code.
  3. Run Dev Container: Open Workspace in Container and select openbridge-webcomponents.code-workspace.
  4. Once running, go to packages/openbridge-webcomponents and run npm run storybook.

Manual Setup (Not Recommended ⚠️)

  1. Clone the repository.
  2. Install Node.js (v20+).
  3. Run npm install in the root folder.
  4. Run npm run build -w packages/openbridge-webcomponents to build the core library.

For more detailed development instructions, see IMPLEMENTATION_GUIDELINES.md, AGENTS.md and CONTRIBUTING.md.

👫 Contributing

We welcome contributions! Please see CONTRIBUTING.md for branch naming, commit conventions, and PR guidelines.

📄 Documentation Index

Document Description
AGENTS.md Crucial for AI agents and developers: coding standards, JSDoc, and build rules.
docs/agents/ Path-scoped rules per component family — the canonical, tool-neutral source for every AI agent.
IMPLEMENTATION_GUIDELINES.md Architecture, PostCSS mixins, SVG practices.
CONTRIBUTING.md Contribution workflow and standards.
Getting Started: HTML Tutorial: one HTML file, no build tools — the quickest way to see components running.
Getting Started: React Tutorial: build a multi-view React app with the React wrapper.
Getting Started: Angular Tutorial: build a multi-view Angular app with the Angular wrapper.
Charts and Graphs Custom Chart.js plots with OpenBridge theming.
CORE_README Usage and installation for the core package.
Vue Wrapper Usage and installation for Vue.js.
React Wrapper Usage and installation for React.
Angular Wrapper Usage and installation for Angular.
Svelte Wrapper Usage and installation for Svelte.
CODE_OF_CONDUCT.md Contributor Covenant Code of Conduct.
LICENSE.txt The license terms: AGPL-3.0-only, with the Apache-2.0 change date and the commercial option.
LICENSE-AGPL.txt Full text of the GNU Affero General Public License v3.0.
LICENSE-APACHE.txt Full text of the Apache License 2.0.