Components

Introduction

This component library is a collection of commonly used components that are created to streamline the development of interactive widgets for VLE. Our primary focus is on accessibility, ensuring that all our components are usable by everyone. We have a dedicated UI/UX group continuously works to improve the design and usability of our components, making sure they meet the highest standards of user experience. Whether you're building a simple interactive element or a complex widget, our library provides the building blocks you need to create accessible and engaging user interfaces.

Features

The library is built using Vite in library mode, is fully tree shakeable 🌳, meaning that only the necessary code ends up in your final application. When you import a component, it includes only the essential JavaScript and CSS styles, ensuring that your widget remains lightweight and efficient.

Atomic design

We follow the principles of atomic design in our component library. Although we do not strictly structure our library but use mixed approaches by using web components, Lit.js and for more complex, organisms, templates VUE.js.

Installation

npm install @ou-imdt/components

Usage

import RangeSlider from '@ou-imdt/components/lib/lit/RangeSlider/RangeSlider.js';
import '@ou-imdt/components/lib/lit/RangeSlider/RangeSlider.css';

Examples

@todo link to docs site

@todo Examples of importing all library

@todo examples of single component usage, tree shaking

Changelog

❯ Read the changelog here

Issue reporting

• Use the issue tracker.
• Provide a clear and descriptive title.
• Describe the steps to reproduce the issue (for bugs).
• Explain the expected and actual behavior (for bugs).
• Describe why the feature is needed (for feature requests).

Licence

This project is licensed under the MIT License - see the LICENSE for details.

Contributing

See contributing for more details.

Contact

Alex, Charlotte, Edwin, Mustafa