Skip to content

About

No description, website, or topics provided.

Resources

Accessibility

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

400 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@keenmate/web-components-core

The shared foundation of the Keenmate web components: a reactive input model, the BlissElement base class and the page-wide helpers every component builds on.

What is it

A library, not a component. It defines no element of its own; it consolidates the custom-element plumbing that the shipping components (web-multiselect, web-daterangepicker, web-treeview, web-dropzone, web-grid, …) each used to re-implement — one input table with converters for attributes, properties and callbacks, the BlissElement lifecycle, typed events, categorized logging and the window.components global — into one package, so correctness lives in a single place and can't drift.

Around that core sit the helpers several components need on the same page: device / viewport classification and presentation (floating panel vs fullscreen sheet), page-wide responsive rules, theme context, motion level, a shared scroll lock and overlay tree, container scroll, and the /positioning, /menu, /search, /actions, /testing and /cem subpaths.

docs/SPEC.md is the source of truth for design intent. This README is the landing page; read the relevant SPEC section before changing behavior.

What's New in v1.0.0-rc24

Upgrade guide: the 1.0.0-rc24 release notes; full list: the CHANGELOG 1.0.0-rc24 section. Also carries 1.0.0-rc23, which was never published.

Phone sheets finished, and one rule for animations. No code change needed unless you style the menu sheet's header padding / title weight.

  • One sheet header — SHEET_CHROME_CSS + createSheetHeader() — /menu, web-grid, web-multiselect, web-daterangepicker and web-dropzone each drew the top bar of their phone sheet on their own. Core now builds it: a title and a round 44px ✕ whose tap area reaches the corner, themed with --km-sheet-* page-wide and --<prefix>-sheet-* per component (19 shared suffixes).
  • claimBackEntry() — one phone Back gesture, and the page keeps its scroll — Four copies of "push a history entry so Back closes the sheet" become one helper: one entry for the page, Back runs the newest onBack, the next sheet takes the entry over. Closing a sheet no longer scrolls the page to the top: the browser had recorded scroll 0 while the page was locked.
  • /menu — side drawer, per-device presentation, animations — presentation: 'drawer' + side, a presentationMap per device class ({ tablet: 'drawer' }), an open menu that follows a device-class change, the standard menu-presentation / menu-side inputs via menuPresentationInputs(), and a slide + fade on the motion tokens. Menus now stack at 9001 (was 10000).
  • animateOut() and one motion switch — Something that disappears has to wait for its closing animation; animateOut(elements, { className, onDone }) adds the class, waits for each element's own animationend (with a timeout for hidden tabs), runs onDone at once when motion is off, and can be cancelled mid-close. motion is the only animation switch — no is…AnimationEnabled inputs; one animation is turned off with its own --<prefix>-<what>-animation-duration: 0s token.
  • Follow-cursor tooltip scrolls with its trigger — On a phone a tapped card kept its tooltip floating over the page after the card scrolled away; the cursor point is now kept relative to the trigger.

What's New in v1.0.0-rc22

Upgrade guide: the 1.0.0-rc22 release notes; full list: the CHANGELOG 1.0.0-rc22 section.

Phone menus, custom CSS for the elements a component mounts, and four fixes found while moving web-grid and web-dropzone onto core's popups. No code change needed.

  • /menu — a bottom sheet on phones — On a phone a context or column menu opened as a small floating panel next to the press, while web-multiselect, web-dropzone and web-grid's cell editors already used a full-width sheet. openMenu() now takes presentation: 'auto' | 'floating' | 'sheet'; the default 'auto' uses the same resolvePresentation() switch as those components, so every component's menus become a bottom sheet on phones with no component change: a backdrop, safe areas, 44px rows from --base-touch-target-min, a header from the new title option, a close button, submenus that drill in with a Back row, and the phone Back button going up one level or closing. New onClose reasons 'back' and 'close-button'; tablet and desktop are unchanged, and 'floating' opts out.
  • Custom CSS — a managed child takes its owner's styles — web-dropzone's bulk mode mounts its own picker, list and progress elements, each with its own shadow root, so CSS a page gave the dropzone never reached most of what the user sees. createCustomStyles() takes getOwner: the child then also gets the owner's page and instance layers, ordered child page → owner page → owner instance → child instance, and refreshes when either changes. Without an owner nothing changes.
  • Theme — no mixed scheme on a panel moved to <body> — inheritThemeFrom copied each theme attribute from its own nearest carrier, so a section's data-theme="dark" above a light component reached the panel next to the component's data-context-theme="light", and the panel turned dark. Above the component host core has resolved, data-theme / data-bs-theme are no longer copied; the host's own data-theme still is.
  • Scroll lock — no phantom padding on a wide phone page — lockBodyScroll() computed the scrollbar width as innerWidth - clientWidth, which on a zoomed-out phone page measured the horizontal overflow (651px in web-grid's phone fixture) and shoved the page sideways when a sheet opened. It now measures the root's width before and after pinning, so only a vertical scrollbar that actually disappears is compensated: 0 on touch devices and with overlay scrollbars.
  • /cem — renamed imports are found — registerComponent('web-grid', _GridElement) with an aliased import produced "No components found", because the plugin matched the class by its written name, and a registration analyzed before its class module could be missed. Aliases, default imports and relative re-exports now resolve to the declaration, linking no longer depends on module order, and an unresolvable registration is a build warning naming the tag.
  • SPEC — readonly text surfaces and store / satellite components — §6.4: a readonly editor or code view needs focus, select and copy; a moving caret is optional. §6.4 / §11.4: only a satellite that is itself a data-input surface gets isDisabled + isReadonly, satellite events go through emit() (so the on* callback and the manifest entry come free), and satellites take their owner's custom CSS.

Earlier releases: 1.0.0-rc21 · 1.0.0-rc20 · 1.0.0-rc19 · 1.0.0-rc18 · 1.0.0-rc17 · 1.0.0-rc16 · 1.0.0-rc15 · 1.0.0-rc14

Demos & docs

  • Demo site — npm run dev (http://localhost:15000): one page per area, every chapter live on small demo elements. The pages are listed in docs/examples.md.
  • Usage / API reference — inputs and converters, BlissElement, environment, responsive rules, motion, registration, logging, every subpath, the API index.
  • Theming — the theme context and the menu's --km-menu-* / --base-* contract.
  • Examples — worked patterns beyond the quick start.
  • Accessibility — the menu keyboard, ARIA, focus return, overlays, motion.
  • Reactivity and batching — how the pipeline coalesces bursts, reinit() vs update(), mass updates.
  • SPEC — full design intent and the decisions log.

Install

npm install @keenmate/web-components-core

One runtime dependency, @floating-ui/dom, used only by the /positioning subpath, so it stays out of the base import graph unless you position. The logging engine is vendored.

Quick start

import { BlissElement, define, toInt, toText, type InputDef } from '@keenmate/web-components-core';

class HelloCounter extends BlissElement {
  protected static override inputs: readonly InputDef[] = [
    { configKey: 'label', attribute: 'label', converter: toText({ default: 'Clicks' }), on: 'update' },
    { configKey: 'count', attribute: 'count', converter: toInt({ min: 0, default: 0 }), on: 'update', shouldReflect: true },
  ];

  #output?: HTMLElement;

  protected override reinit(): void {
    const root = this.shadowRoot ?? this.attachShadow({ mode: 'open' });
    root.innerHTML = '<button part="button"></button>';
    this.#output = root.querySelector('button')!;
    this.#render();
  }

  protected override update(): void {
    this.#render();
  }

  #render(): void {
    this.#output!.textContent = `${this.config.label}: ${this.config.count}`;
  }
}

define('hello-counter', HelloCounter);

Each input is one row: its converter parses the attribute (<hello-counter count="3">) and validates the property (el.count = 3), so both entry points share one pipeline. A burst of changes coalesces into one update(); an invalid value warns, keeps the previous one and fires input-rejected. See usage.md for the lifecycle, events and the rest of the API.

Browser support

Modern evergreen browsers (Chrome, Edge, Firefox, Safari) with native custom elements, shadow DOM, adoptedStyleSheets (a <style> fallback is built in) and CSS @layer. SSR-safe: every entry point imports without a DOM. No polyfills shipped.

About

Authored and maintained by Keenmate s.r.o.. The library ships standalone with sensible light/dark defaults for what it renders (the shared menu); when mounted inside Pure Admin — or any host that publishes the --base-* taxonomy via @keenmate/theme-designer — it adopts the host's colors, typography, and sizing automatically. There is no runtime dependency on Pure Admin; the integration is opt-in via CSS variables.

Built with BlissFramework

Follows the BlissFramework component guidelines for structure, naming, theming and documentation.

License

MIT — see LICENSE.

About

No description, website, or topics provided.

Resources

Accessibility

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages