@lilydesignsystem/html-picker-bar 0.3.0 → 0.5.0

package/LICENSE.md

@@ -0,0 +1,64 @@
+<!-- Synced from the canonical repository by bin/sync-special-files.
+     Do not edit here; edit the root copy and re-run the script.
+     Canonical: https://github.com/LilyDesignSystem/lily-design-system/blob/main/LICENSE.md -->
+
+# License
+
+Lily Design System™ is free open source software.
+
+License is any of these, at your option, or contact us for custom license options.
+
+* [MIT](https://opensource.org/license/mit) ([SPDX: MIT](https://spdx.org/licenses/MIT.html))
+
+* [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) ([SPDX: Apache-2.0](https://spdx.org/licenses/Apache-2.0.html))
+
+* [GNU General Public License v2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html) ([SPDX: GPL-2.0-only](https://spdx.org/licenses/GPL-2.0-only.html))
+
+* [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) ([SPDX: GPL-3.0-only](https://spdx.org/licenses/GPL-3.0-only.html))
+
+* [BSD 3-Clause License](https://opensource.org/license/bsd-3-clause) ([SPDX: BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html))
+
+## SPDX
+
+The machine-readable expression for the choice above is:
+
+```
+SPDX-License-Identifier: MIT OR Apache-2.0 OR GPL-2.0-only OR GPL-3.0-only OR BSD-3-Clause
+```
+
+Every package manifest in this repository should carry that expression, or a
+single identifier from the list where the packaging format does not accept a
+disjunction. You do not need permission to pick one: choose whichever member of
+the list suits your project and comply with that one.
+
+This applies to the whole repository — the component catalog, the seven headless
+libraries, the seven example applications, the seven helper catalogs, the
+`themes/` stylesheets, the `bin/` tooling, and the documentation.
+
+## Scope note
+
+This file supersedes an earlier `CC BY-NC-SA` notice. That notice was a content
+license with a non-commercial clause, it was not an open-source license, and it
+contradicted both the specification and the published packages. It should not be
+relied on. If you obtained Lily under it and that raises a question for you,
+contact <joel@joelparkerhenderson.com>.
+
+## Trademarks
+
+Lily™ and Lily Design System™ are trademarks. The trademarks are distinct from
+the software license: a trademark claim (™) asserts use of the marks and is
+independent of the licenses above. A license to the software is not a license to
+the marks.
+
+You may say your project uses Lily, is built with Lily, or is compatible with
+Lily. Please do not use the marks as the name of your fork or product, or in a
+way that suggests affiliation or endorsement. For any use beyond that, contact
+<joel@joelparkerhenderson.com>.
+
+## Third-party references
+
+Lily's example applications and `themes/` stylesheets take visual reference from
+public-sector design systems including NHS UK, GOV.UK, and USWDS. Lily is not
+affiliated with, endorsed by, or connected to any of those organisations. Their
+names and marks belong to them, and this license grants nothing in respect of
+them.

package/README.md

@@ -0,0 +1,167 @@
+# Lily Design System™ — HTML PickerBar
+
+> **Link picker (0.3.0).** Pass `links` (and `labels.link`) to add a `link-picker` — a home icon opening the page links your app defines — as the leftmost icon. It renders only when both are given.
+
+> **Time zone picker (0.5.0).** Set `labels.timeZone` and `timeZoneProps = { locale: "fr" }` (plus any `<time-zone-picker>` property, e.g. `names`) to add a `time-zone-picker` — time zones by UTC offset with their full names — right after the locale picker. It renders only when both the label and the locale are given. To name the text sizes in the reader's language pass `sizeLabels` through the text-size props (`textSizeLabels(pack)` / `LocaleTranslations.TextSizeLabels(locale)` from the locale-translations package).
+
+A single page-header custom element, `<picker-bar>`, that composes five
+of the Lily [`*-picker` helpers](../index.md) — search, theme, locale,
+text size, and share, in that order — with two catalog-wide defaults
+pre-wired, so you can drop one element into a header instead of
+assembling and configuring five.
+
+`motion-picker` and `date-time-picker` are not part of the bar: motion
+has no natural spot next to the other three header preferences, and
+`date-time-picker` is a form control, not a header control.
+
+## Install
+
+```sh
+npm install @lilydesignsystem/html-picker-bar
+```
+
+`@lilydesignsystem/html-search-picker`, `-theme-picker`,
+`-locale-picker`, `-text-size-picker`, and `-share-picker` install automatically as
+regular dependencies — `<picker-bar>` is a thin wrapper around them,
+not a reimplementation.
+
+## Usage
+
+```js
+import "@lilydesignsystem/html-picker-bar";
+
+const bar = document.createElement("picker-bar");
+bar.labels = {
+  search: "Search this site",
+  searchInput: "Search terms",
+  searchSubmit: "Search",
+  theme: "Theme",
+  locale: "Language",
+  textSize: "Text size",
+  share: "Share",
+};
+bar.themesUrl = "/assets/themes/";
+bar.locales = ["en", "cy", "gd", "ga"];
+bar.shareTargets = [
+  {
+    id: "email",
+    label: "Email",
+    href: (url, title) => `mailto:?subject=${title}&body=${url}`,
+  },
+];
+document.querySelector("header").appendChild(bar);
+```
+
+Or in markup, for the parts that fit plain attributes:
+
+```html
+<script type="module" src="/node_modules/lily-design-system-html-picker-bar/dist/index.js"></script>
+<picker-bar themes-url="/assets/themes/" locales="en,cy,gd,ga"></picker-bar>
+<script type="module">
+  document.querySelector("picker-bar").labels = {
+    search: "Search this site",
+    searchInput: "Search terms",
+    searchSubmit: "Search",
+    theme: "Theme",
+    locale: "Language",
+    textSize: "Text size",
+    share: "Share",
+  };
+</script>
+```
+
+Search sends a query for `foo` to `/?foo` by default. `labels` carries
+seven names: three for search (`search` names its button and search
+landmark, `searchInput` the field, `searchSubmit` the `⏎` button) and
+one for each other picker.
+
+`labels` has to be set as a JS property (no honest attribute encoding
+exists for an object), same as `shareTargets` — see
+`<date-time-picker>`'s `labels` and `<share-picker>`'s `targets` for the
+same pattern elsewhere in this catalog.
+
+## Defaults
+
+- **`themes`** defaults to `DEFAULT_THEMES` — all 45 Lily reference
+  theme slugs, alphabetical, with the 8 United Kingdom / United States
+  government themes moved to their own alphabetical group at the
+  bottom. Set your own `themes` attribute (comma-separated) or
+  `.themes` property (array) to override.
+- **`sizes`** defaults to `DEFAULT_SIZES` — the seven-step scale
+  `largest`, `larger`, `large`, `normal`, `small`, `smaller`,
+  `smallest` — and the text-size picker starts on `normal`. Set your
+  own `sizes` to override (and `textSizeProps = { defaultValue: "…" }`
+  for a different starting point).
+
+Both are exported as named constants:
+
+```js
+import { DEFAULT_THEMES, DEFAULT_SIZES } from "@lilydesignsystem/html-picker-bar";
+```
+
+## Passing extra configuration to one picker
+
+Each wrapped picker takes a `*Props` bag — a property, not an
+attribute — for anything beyond what `<picker-bar>` lifts to the top
+level: persistence, initial value, detection, a `*Labels` override map.
+
+```js
+bar.searchProps = { action: "/search", placeholder: "Search…", navigate: (href) => router.push(href) };
+bar.themeProps = { storageKey: "lily-theme", detectFromSystem: true };
+bar.localeProps = { storageKey: "lily-locale", detectFromNavigator: true };
+bar.textSizeProps = { storageKey: "lily-text-size" };
+bar.shareProps = { copyLabel: "Copy link", copiedLabel: "Copied" };
+```
+
+Set these **before** appending `bar` to the document — they apply to
+the wrapped picker's element instance before it connects, so
+persistence and initial-value resolution see them on first mount, the
+same as if you had configured that picker directly.
+
+## Reading a wrapped picker directly
+
+After `<picker-bar>` has rendered (i.e. once it's connected to the
+document), each wrapped element is available as a read-only property:
+
+```js
+bar.searchPicker; // the <search-picker> instance
+bar.themePicker; // the <theme-picker> instance
+bar.localePicker; // the <locale-picker> instance
+bar.textSizePicker; // the <text-size-picker> instance
+bar.sharePicker; // the <share-picker> instance
+```
+
+Useful for attaching a `themechange` listener, reading `.value`, or any
+other post-mount interaction — the elements are real, unmodified
+instances of their own packages.
+
+## Styling
+
+`<picker-bar>` renders no CSS of its own beyond the `picker-bar` root
+wrapper class — style each child through its own package's class hooks
+(`search-picker`, `theme-picker`, `locale-picker`, `text-size-picker`,
+`share-picker`;
+see each package's own `index.md`). A typical header layout:
+
+```css
+.picker-bar {
+  display: flex;
+  gap: var(--theme-space-sm, 0.5rem);
+  align-items: center;
+}
+```
+
+## Accessibility
+
+Every accessible name comes from `labels` — there is no English
+default, because a set of names this catalog invented is exactly the
+case the rest of Lily's i18n rule exists for. Each wrapped picker keeps
+its own WAI-ARIA APG contract unchanged; see that picker's own `index.md`.
+
+## Full contract
+
+See [`spec/index.md`](./spec/index.md).
+
+---
+
+Lily™ and Lily Design System™ are trademarks.

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { LinkItem, LinkPickerProps, LinkPicker } from '@lilydesignsystem/html-li
 import { SearchPickerProps, SearchPicker } from '@lilydesignsystem/html-search-picker';
 import { ThemePickerProps, ThemePicker } from '@lilydesignsystem/html-theme-picker';
 import { LocalePickerProps, LocalePicker } from '@lilydesignsystem/html-locale-picker';
+import { TimeZonePickerProps, TimeZonePicker } from '@lilydesignsystem/html-time-zone-picker';
 import { TextSizePickerProps, TextSizePicker } from '@lilydesignsystem/html-text-size-picker';
 import { ShareTarget, SharePickerProps, SharePicker } from '@lilydesignsystem/html-share-picker';
 export { ShareTarget } from '@lilydesignsystem/html-share-picker';
@@ -22,7 +23,7 @@ export { ShareTarget } from '@lilydesignsystem/html-share-picker';
  */
 
 /**
- * All 45 Lily reference theme slugs (see `themes/` at the repo root),
+ * All 57 Lily reference theme slugs (see `themes/` at the repo root),
  * sorted alphabetically except the United Kingdom and United States
  * government/public-sector themes, which sort last as one alphabetical
  * group of their own. Mirrors `theme-picker`'s own title-casing of each
@@ -55,6 +56,11 @@ type PickerBarLabels = {
     locale: string;
     /** Accessible name for the text-size picker's button and listbox. */
     textSize: string;
+    /**
+     * Accessible name for the time-zone picker's button and listbox. Needed only when
+     * `timeZoneProps.locale` is supplied; the time-zone picker renders only when both are present.
+     */
+    timeZone?: string;
     /** Accessible name for the share picker's button and list. */
     share: string;
 };
@@ -71,6 +77,7 @@ type LinkPickerExtra = Partial<Omit<LinkPickerProps, "label" | "links">>;
 type SearchPickerExtra = Partial<Omit<SearchPickerProps, "label" | "inputLabel" | "submitLabel">>;
 type ThemePickerExtra = Partial<Omit<ThemePickerProps, "label" | "themesUrl" | "themes">>;
 type LocalePickerExtra = Partial<Omit<LocalePickerProps, "label" | "locales">>;
+type TimeZonePickerExtra = Partial<Omit<TimeZonePickerProps, "label">>;
 type TextSizePickerExtra = Partial<Omit<TextSizePickerProps, "label" | "sizes">>;
 type SharePickerExtra = Partial<Omit<SharePickerProps, "label" | "targets">>;
 /** Mirrors the observed attributes / properties for typing convenience. */
@@ -85,6 +92,8 @@ type PickerBarProps = {
     themeProps?: ThemePickerExtra;
     locales: string[];
     localeProps?: LocalePickerExtra;
+    /** `locale` (the language that names and sorts the zones) is required for the time-zone picker, after the locale picker, to render. */
+    timeZoneProps?: TimeZonePickerExtra;
     sizes?: string[];
     textSizeProps?: TextSizePickerExtra;
     shareTargets?: ShareTarget[];
@@ -117,6 +126,8 @@ declare class PickerBar extends HTMLElement {
     set themeProps(v: ThemePickerExtra);
     get localeProps(): LocalePickerExtra;
     set localeProps(v: LocalePickerExtra);
+    get timeZoneProps(): TimeZonePickerExtra;
+    set timeZoneProps(v: TimeZonePickerExtra);
     get textSizeProps(): TextSizePickerExtra;
     set textSizeProps(v: TextSizePickerExtra);
     get shareProps(): SharePickerExtra;
@@ -129,6 +140,8 @@ declare class PickerBar extends HTMLElement {
     get themePicker(): ThemePicker | null;
     /** The rendered `<locale-picker>` instance, once connected. */
     get localePicker(): LocalePicker | null;
+    /** The rendered `<time-zone-picker>` instance, once connected (null without a label and locale). */
+    get timeZonePicker(): TimeZonePicker | null;
     /** The rendered `<text-size-picker>` instance, once connected. */
     get textSizePicker(): TextSizePicker | null;
     /** The rendered `<share-picker>` instance, once connected. */
@@ -137,4 +150,5 @@ declare class PickerBar extends HTMLElement {
     attributeChangedCallback(name: string, _old: string | null, value: string | null): void;
 }
 
-export { DEFAULT_SIZES, DEFAULT_THEMES, type LocalePickerExtra, PickerBar, type PickerBarLabels, type PickerBarProps, type SearchPickerExtra, type SharePickerExtra, type TextSizePickerExtra, type ThemePickerExtra };
+export { DEFAULT_SIZES, DEFAULT_THEMES, PickerBar };
+export type { LocalePickerExtra, PickerBarLabels, PickerBarProps, SearchPickerExtra, SharePickerExtra, TextSizePickerExtra, ThemePickerExtra, TimeZonePickerExtra };

package/dist/index.js

@@ -1,19 +1,23 @@
-// lily-design-system-html-picker-bar/picker-bar.ts
+// picker-bar.ts
 import "@lilydesignsystem/html-link-picker";
 import "@lilydesignsystem/html-search-picker";
 import "@lilydesignsystem/html-theme-picker";
 import "@lilydesignsystem/html-locale-picker";
+import "@lilydesignsystem/html-time-zone-picker";
 import "@lilydesignsystem/html-text-size-picker";
 import "@lilydesignsystem/html-share-picker";
 var DEFAULT_THEMES = [
   "abyss",
   "acid",
   "adobe-spectrum",
+  "ant-design",
   "aqua",
+  "atlassian",
   "autumn",
   "black",
   "bumblebee",
   "business",
+  "cappuccino",
   "caramellatte",
   "cmyk",
   "coffee",
@@ -24,23 +28,32 @@ var DEFAULT_THEMES = [
   "dim",
   "dracula",
   "emerald",
+  "excel",
   "fantasy",
+  "fluent",
   "forest",
   "garden",
+  "github-primer",
   "halloween",
+  "ibm-carbon",
   "lemonade",
   "light",
+  "linear",
   "lofi",
   "luxury",
   "mozilla-protocol",
   "night",
   "nord",
+  "notion",
   "pastel",
   "retro",
+  "salesforce",
+  "sap-fiori",
   "silk",
   "sunset",
   "synthwave",
   "valentine",
+  "vercel",
   "winter",
   "wireframe",
   "united-kingdom-government-digital-service",
@@ -88,6 +101,7 @@ var PickerBar = class extends HTMLElement {
   #searchProps = {};
   #themeProps = {};
   #localeProps = {};
+  #timeZoneProps = {};
   #textSizeProps = {};
   #shareProps = {};
   // Rendered-DOM references. Null until #render() has run.
@@ -96,6 +110,7 @@ var PickerBar = class extends HTMLElement {
   #searchPickerEl = null;
   #themePickerEl = null;
   #localePickerEl = null;
+  #timeZonePickerEl = null;
   #textSizePickerEl = null;
   #sharePickerEl = null;
   // ---- Property accessors ----
@@ -190,6 +205,13 @@ var PickerBar = class extends HTMLElement {
     this.#localeProps = v ?? {};
     this.#render();
   }
+  get timeZoneProps() {
+    return this.#timeZoneProps;
+  }
+  set timeZoneProps(v) {
+    this.#timeZoneProps = v ?? {};
+    this.#render();
+  }
   get textSizeProps() {
     return this.#textSizeProps;
   }
@@ -220,6 +242,10 @@ var PickerBar = class extends HTMLElement {
   get localePicker() {
     return this.#localePickerEl;
   }
+  /** The rendered `<time-zone-picker>` instance, once connected (null without a label and locale). */
+  get timeZonePicker() {
+    return this.#timeZonePickerEl;
+  }
   /** The rendered `<text-size-picker>` instance, once connected. */
   get textSizePicker() {
     return this.#textSizePickerEl;
@@ -292,6 +318,14 @@ var PickerBar = class extends HTMLElement {
     localeEl.locales = this.#locales;
     Object.assign(localeEl, this.#localeProps);
     root.appendChild(localeEl);
+    let timeZoneEl = null;
+    if (this.#labels.timeZone && this.#timeZoneProps.locale) {
+      timeZoneEl = document.createElement("time-zone-picker");
+      timeZoneEl.locale = this.#timeZoneProps.locale;
+      Object.assign(timeZoneEl, this.#timeZoneProps);
+      timeZoneEl.label = this.#labels.timeZone;
+      root.appendChild(timeZoneEl);
+    }
     const textSizeEl = document.createElement(
       "text-size-picker"
     );
@@ -310,6 +344,7 @@ var PickerBar = class extends HTMLElement {
     this.#searchPickerEl = searchEl;
     this.#themePickerEl = themeEl;
     this.#localePickerEl = localeEl;
+    this.#timeZonePickerEl = timeZoneEl;
     this.#textSizePickerEl = textSizeEl;
     this.#sharePickerEl = shareEl;
   }
@@ -318,7 +353,7 @@ function parseCsv(s) {
   return s.split(",").map((p) => p.trim()).filter((p) => p.length > 0);
 }
 
-// lily-design-system-html-picker-bar/index.ts
+// index.ts
 if (typeof customElements !== "undefined" && !customElements.get("picker-bar")) {
   customElements.define("picker-bar", PickerBar);
 }

package/index.md

@@ -2,6 +2,8 @@
 
 > **Link picker (0.3.0).** Pass `links` (and `labels.link`) to add a `link-picker` — a home icon opening the page links your app defines — as the leftmost icon. It renders only when both are given.
 
+> **Time zone picker (0.5.0).** Set `labels.timeZone` and `timeZoneProps = { locale: "fr" }` (plus any `<time-zone-picker>` property, e.g. `names`) to add a `time-zone-picker` — time zones by UTC offset with their full names — right after the locale picker. It renders only when both the label and the locale are given. To name the text sizes in the reader's language pass `sizeLabels` through the text-size props (`textSizeLabels(pack)` / `LocaleTranslations.TextSizeLabels(locale)` from the locale-translations package).
+
 A single page-header custom element, `<picker-bar>`, that composes five
 of the Lily [`*-picker` helpers](../index.md) — search, theme, locale,
 text size, and share, in that order — with two catalog-wide defaults

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@lilydesignsystem/html-picker-bar",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "engines": {
-    "node": "=26"
+    "node": ">=26"
   },
-  "description": "Lily Design System HTML picker bar: composes link-picker (optional), search-picker, theme-picker, locale-picker, text-size-picker, and share-picker into one page-header row. Headless, SSR-safe, no CSS.",
+  "description": "Lily Design System HTML picker bar: composes link-picker (optional), search-picker, theme-picker, locale-picker, time-zone-picker (optional), text-size-picker, and share-picker into one page-header row. Headless, SSR-safe, no CSS.",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -21,7 +21,10 @@
     "README.md"
   ],
   "scripts": {
-    "prepublishOnly": "cd .. && npm run build"
+    "build": "node build.js",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
     "@lilydesignsystem/html-link-picker": "^0.1.0",
@@ -29,8 +32,15 @@
     "@lilydesignsystem/html-theme-picker": "^0.2.0",
     "@lilydesignsystem/html-locale-picker": "^0.2.0",
     "@lilydesignsystem/html-text-size-picker": "^0.2.0",
+    "@lilydesignsystem/html-time-zone-picker": "^0.1.0",
     "@lilydesignsystem/html-share-picker": "^0.2.0"
   },
+  "devDependencies": {
+    "jsdom": "^30.1.1",
+    "tsup": "^9.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^5.0.4"
+  },
   "keywords": [
     "lily",
     "design",
@@ -48,7 +58,7 @@
   "license": "MIT OR Apache-2.0 OR GPL-2.0-only OR GPL-3.0-only OR BSD-3-Clause",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/LilyDesignSystem/lily-design-system-html-helpers.git",
+    "url": "git+https://github.com/LilyDesignSystem/lily-design-system.git",
     "directory": "lily-design-system-html-picker-bar"
   },
   "homepage": "https://lilydesignsystem.com/",