Skip to content

vollowx/seele

Repository files navigation

Standard Extensible Elements

SEELE is a modern, lightweight and accessible Web Components library. It provides a set of highly customizable UI components that follow the Material Design 3 guidelines out of the box, while being designed for easy extension and restyling.

Visit the website of SEELE for documentation and demos.

Installation

SEELE is published on npm, install with your preferred package manager:

npm install @vollowx/seele

yarn add @vollowx/seele

bun add @vollowx/seele

Usage

Importing

You can import the entire library or individual components to keep your bundle size small.

// Import all components
import '@vollowx/seele';

// Or import specific components (recommended)
// They all follow such path :@/catagory/group/component.js
import '@vollowx/seele/m3/button/common-button.js';
import '@vollowx/seele/m3/checkbox/checkbox.js';

Using

Once imported, the components can be used just like standard HTML elements.

<md-button variant="filled">Filled Button</md-button>
<md-button variant="outlined">Outlined Button</md-button>

<label>
  <md-checkbox checked></md-checkbox>
  Labelled Checkbox
</label>

Theming

SEELE components use CSS variables for styling.

Currently, Material Design 3 token variables are not yet included in the source code.

To style the components correctly, you need to define the necessary CSS variables in your project. You can find reference implementations in vollowx/seele-docs or the dev folder of this repository.

Browser Supporty

SEELE relies on modern web standards like ElementInternals.

  • Chromium: >= 125.0
  • Firefox: >= 126.0

Resources

About

A web components library that can be styled and extended freely, pre-providing components in Material Design 3.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors