create-kolibri

Welcome to KoliBri

"The accessible HTML standard"

KoliBri is not a design system in the traditional sense. Rather, we extend the HTML5 standard with self-contained, accessible Web Components — new HTML elements that work independently from any design or branding. These atomic components form a foundation that any design library, framework, or style guide can reuse and theme according to their needs.

KoliBri stands for "component library for accessibility" and was released as open source by the Informationstechnikzentrum Bund (ITZBund) for reuse and continued development.

Vision

Together we make HTML accessible using reusable web components to ensure usability and accessibility.

Mission

The HTML web standard is itself very “openly” specified in order to be as long-lasting and robust as possible. It therefore often happens that HTML compositions are not easily accessible, semantic and valid.

KoliBri is based directly on the Web standards of the W3C (framework-agnostic), and is generic Reference implementation of the WCAG standard and the BITV for accessibility and implemented as a multi-theming capable presentation layer. There is no technical reference and no data transfer functionality. This means that KoliBri is equally reusable for the realization of static websites as well as dynamic web applications with different corporate designs and style guides and is therefore very interesting for open source.

Roadmap

KoliBri is always actively working on improvements, new features and future-oriented innovations for the latest major release. In parallel, a selected LTS release is maintained with regard to bug fixes.

gantt
    title LTS & STS
    dateFormat YYYY-MM-DD

    0.x Initial implementation :, 2020-07-01, 17M
    1.x (LTS)                  :, 2021-12-01, 3y
    2.x (LTS)                  :,  2023-12-01, 3y
    3.x (STS)                  :crit , 2024-12-01, 15M
    4.x (LTS)                  :, 2025-12-01, 3y
    5.x (STS)                  :crit , 2026-12-01, 15M
    6.x (LTS)                  :, 2027-12-01, 3y

Installation

Install the packages with pnpm:

pnpm install

Run the build once to generate the components:

pnpm -r build

For working on the monorepo itself, see the daily workflow.

Quick start

Install the default theme and register the components:

pnpm add @public-ui/components @public-ui/theme-default

import { register } from '@public-ui/components';
import { defineCustomElements } from '@public-ui/components/loader';
import { DEFAULT } from '@public-ui/theme-default';

register(DEFAULT, defineCustomElements);

Avoid CSS Custom Property Collisions

KoliBri themes expose a few CSS custom properties so consumers can adapt the look and feel. Because these properties remain global—even inside a Shadow DOM—using too many of them can clash with variables defined on the host page.

Use namespaced custom properties only for values that must be overridden from the outside. For internal calculations rely on SASS variables instead of additional CSS properties. This keeps components robust and prevents unexpected style leaks.

Collaboration and cooperation

The focus of KoliBri is on small (atomic), very flexible and highly reusable HTML compositions (e.g. buttons). We offer an accessible, semantic and valid standard implementation of such components that can be reused for any higher-level HTML structure or component (molecule, organism or template). These atomic components are where we should collaborate and cooperate to combine our skills and knowledge. The synergy effects on the basic components allow you to focus more on subject-specific content.

Let's make KoliBri better and more colorful together!

Continue to Documentation…

Contributing

Bug reports and pull requests are welcome. Please read our contribution guide before getting started.

SLSA/Provenance

We aim for SLSA Build Level 3 for the npm packages published from this repository. Releases are built in GitHub Actions with OIDC-based identity and published with npm provenance (--provenance), producing verifiable attestations for the published artifacts. See the publish workflow for the release steps and npm provenance configuration.

Verification example

# Inspect provenance metadata for a published package
pnpm view @public-ui/components dist.provenance

# (Optional) Verify signatures/provenance if your npm client supports it
pnpm audit signatures --package=@public-ui/components@<version>

Resources

• Get Started
• Contributing
• Code of Conduct
• Known Issues
• Security