EOxUI

Collection of styles and snippets for the EOX Design System. Includes JS, CSS and SCSS variables necessary for the used tools.

General usage

The CSS & JS components are built on top of beercss. For documentation on how to use HTML structure, CSS helper classes & JS, refer to the docs on beercss.com. For usage with coding agents, please point them to https://github.com/beercss/beercss/blob/main/llms.md in order to get access to docs and usage examples.

Node package installation

npm i @eox/ui

Visual Benchmarks (Playgrounds)

You can verify the design system components in the following playgrounds:

• HTML/BeerCSS Playground: The primary Material 3 reference implementation.
• Vuetify/EOx Blueprint Playground: Implementation demonstrating look-and-feel consistency across frameworks.
• Slider Comparison Playground: Demonstration of style alignment between BeerCSS, Vuetify, and Toolcool Range Slider.

Specialized Components

Toolcool Range Slider

For advanced slider features (range, multi-thumb, vertical, etc.), EOxUI provides optimized styles for the Toolcool Range Slider web component.

• Usage: Install toolcool-range-slider and import @eox/ui/style/slider.css.
• Default Styles: EOxUI aligns the appearance of the Toolcool slider with BeerCSS and Vuetify sliders to ensure a consistent user experience.
• Reference: View sliders.html for an implementation example.

Stability & Release Strategy (v1.0.0+)

Semantic Versioning

EOxUI follows a strict stability strategy synchronized with upstream dependencies:

• Major: Breaking changes in EOxUI specific components or major BeerCSS migrations.
• Minor: Minor version updates or feature additions (e.g., BeerCSS 4.0.x -> 4.1.x).
• Patch: Maintenance, bug fixes, and pinned dependency updates (e.g., BeerCSS 4.0.3 -> 4.0.16).

All core dependencies are pinned to exact versions to ensure visual regressions are strictly controlled.

Running Tests

Automated tests verify that dependencies remain pinned and the public API (exports) remains intact.

npm test

// style.css
@import url("@eox/ui/style.css");

// script.js
import "@eox/ui";

The JS bundle is only needed for components that require JS.

CDN usage

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/@eox/ui/dist/style.css"
/>
<script type="module">
  import "https://cdn.jsdelivr.net/npm/@eox/ui/+esm";
</script>

The JS bundle is only needed for components that require JS.

Usage with Vuetify

This package also provides a Vuetify blueprint and style, which helps Vuetify apps to adapt the same look&feel.

npm i @eox/ui

// src/plugins/vuetify.js

import "vuetify/styles";
import "@eox/ui/vuetify/style.css";
import { eox } from "@eox/ui/vuetify/blueprint.js";

import { createVuetify } from "vuetify";

export default createVuetify({
  blueprint: eox,
});

Caveats

Flash of unstyled content (FOUC)

If you're experiencing FOUC, then you're probably having some static/non-bundling setup. This is somewhat expected, since the HTML will always load faster than JS/CSS bundles (and especially fonts), probably most noticeable on first page load (browser cache should help a bit).

Before all, make sure you're importing the CSS in the head as style, and not importing it into a JS module.

To mitigate e.g. the wrong font flashing, use something like:

<style>
  body {
    opacity: 0;
    transition: opacity 0.3s ease-in-out;
  }
</style>
<script>
  document.fonts.onloadingdone = () => {
    document.body.style.opacity = 1;
  };

  (async () => {
    await document.fonts.load("16px Inter");
  })();
</script>

Shadow DOM

Need to include @eox/ui/style.css also "outside" in the light DOM (for vars and fonts).

Development

git update-index --skip-worktree playground.html
npm install
npm start

This opens the playground at http://localhost:5173/playground.html with hot-reloading.

npm run format

Formats the code base.

npm run build

Builds the library and replaces absolute links in styles with relative ones.