Kolibri Design System

Note that the Kolibri Design System is not intended to be used as a dependency outside of Kolibri products.

If you are building a Kolibri plugin you should not add the design system as a dependency because it will be made available as a dependency of Kolibri itself.

What is Kolibri Design System?

design-system.learningequality.org is a resource for designers and developers who are building Kolibri products. It includes the design system patterns and the library of UI components.

How can I use it?

Documentation

Refer to design-system.learningequality.org to learn about the design system patterns and components, as well as the detailed technical documentation and guidance for the library components that are available for usage in Kolibri products.

For the latest (not yet released) version, visit the design system website built from the main branch at main--kolibri-design-system.netlify.app/.

Component library

The component library is a npm package. It contains front-end components, utilities, and style definitions supporting the Kolibri Design System and used in Kolibri products.

Components and utilities will be accessible under the lib path. For example:

import KButton from 'kolibri-design-system/lib/KButton';

The library is provided as source code, rather than a pre-built distribution. A project using it needs to supply both build and runtime dependencies.

How do I get help or give feedback?

Contact us at the Kolibri Design System GitHub Discussions.

If you have found a bug, you can create a Github issue following the instructions in the issue template.

How can I contribute?

We welcome contributors!

To find out how to contribute, visit Contributing to our open code base.