@escape-game-over/atlas 0.1.18 → 0.1.20

package/src/astro/filters-view.ts

@@ -1,120 +1,63 @@
 /**
- * The DOM writes every filtered list turns out to make, and only those.
+ * The two DOM writes every filtered list turned out to share.
  *
- * `filters` decides which items match and what the address bar says, and hands
- * both to `onChange`. Everything a page does about that answer is its own — and
- * mostly stays that way: three lists in one repository draw their results three
- * different ways, with tabs and a blurb on one, an exclusive `<details>`
- * accordion on another, a two-level country roll-up on the third.
+ * `filters` decides which items match; what a page does about that is its own.
+ * These are the parts three lists wrote identically, and getting wrong was
+ * silent. Both take elements, never selectors, so no attribute name in this
+ * package has to be matched by a consumer.
  *
- * These two helpers are what all three, or two of three, wrote identically. That
- * is the whole bar for being here: not "a list might want this" but "every list
- * we have written already did, character for character, and getting it wrong was
- * silent". Anything the three disagreed about is still theirs.
+ * They write only what is binary and derived — an input's `value`, and `hidden`
+ * on a clear button, an empty message or a section with nothing left. No class,
+ * style or `aria`: that is where the choices live.
  *
- * **Both take elements, never selectors.** A project decides what its markup is
- * called and hands over what it found, so no attribute name in this package has
- * to be matched by any consumer — the reason `filters` itself has no markup
- * contract, kept intact one layer up.
+ * Two notes for the markup:
  *
- * These write to elements, which the rest of `astro/` refuses to do, and the
- * line is worth being exact about. `carousel` will not write a transform because
- * a transform is a design decision with no single right answer. Everything
- * written here is the opposite: an input's `value` is the control's own state,
- * and `hidden` on a clear button, an empty message or a section with nothing
- * left in it is binary and derived. Nothing here sets a class, a style or an
- * `aria` attribute, which is where the choices live.
+ * - **`hidden` needs help in a grid.** Any author rule setting `display` beats
+ *   it. Tailwind v4's preflight ships `[hidden] { display: none !important }`;
+ *   without something like it these writes are inert and nothing filters.
+ * - **A result count wants `aria-live="polite"`**, in the template.
  *
- * Two notes for the markup on the other side of that boundary:
- *
- * - **`hidden` needs help in a grid.** It is a `display: none` from the user
- *   agent, and any author rule setting `display: flex` or `grid` beats it. A
- *   project on Tailwind v4 gets `[hidden] { display: none !important }` from
- *   preflight and needs nothing; anything else should ship that rule itself, or
- *   every one of these writes is inert and the list simply never filters.
- * - **A result count wants `aria-live="polite"`.** Filtering as you type changes
- *   the page silently for anyone not looking at it. The attribute belongs on the
- *   element in the template, not here — this package is handed elements and does
- *   not decide what they are.
+ * See docs/client-scripts.md.
  */
 
 import type { FieldMap, Filters } from "./filters.ts";
 
-/**
- * The fields of `F` that hold text, so a search box cannot be pointed at a flag.
- *
- * `list.set(field, input.value)` hands over a string; aimed at a `flag` that is
- * a type error worth getting at the call site rather than a filter that silently
- * never matches.
- */
+/** The `text` fields of `F`, so a search box cannot be pointed at a flag. */
 export type TextFieldOf<F extends FieldMap> = {
     [K in keyof F]: F[K] extends { kind: "text" } ? K : never;
 }[keyof F];
 
 /**
- * What a search box is made of, as much of it as exists.
- *
- * Every part is optional and `null` is accepted, because `within(root).one(…)`
- * returns `null` and a page is allowed to have a search field with no clear
- * button, or a list with no empty state. Handing over what a lookup returned,
- * without checking it first, is the point.
+ * What a search box is made of, as much of it as exists. Every part is
+ * optional and `null` is accepted, so what a lookup returned can be handed over
+ * without checking it first.
  */
 export interface SearchBoxElements {
     readonly input?: HTMLInputElement | null;
     /** Clears the field. Hidden while the field is already empty. */
     readonly clear?: HTMLElement | null;
-    /**
-     * The "nothing matched" message.
-     *
-     * Tracks the whole result set rather than this field alone — a list emptied
-     * by a category is as empty as one emptied by a query, and there is one
-     * message either way. It lives here because it is the same line in every
-     * consumer, not because it belongs to the search box.
-     */
+    /** The "nothing matched" message. Tracks the whole result set. */
     readonly empty?: HTMLElement | null;
     /**
-     * How many matched, written as digits and nothing else.
-     *
-     * Two of the three write this, and the same way. Digits only, because the
-     * sentence around them is not ours to build: a list that reads "6 of 42" in
-     * one language reads "6 din 42" in another, and a translated string is not
-     * something to take apart in a browser to get at one number. Give the count
-     * an element of its own and let the copy sit beside it — which is what the
-     * consumer doing this already had to do.
-     *
-     * Same rule as the rest of this file, one field further: derived, and with
-     * no choice in it. Where the number *goes* is still the template's.
-     *
-     * Give it `aria-live="polite"` there. Filtering as you type changes the
-     * page silently for anyone not watching it, and this package is handed
-     * elements rather than deciding what they are.
+     * How many matched, as digits and nothing else: the sentence around them is
+     * translated, and not something to take apart in a browser. Give the count
+     * its own element and let the copy sit beside it.
      */
     readonly count?: HTMLElement | null;
 }
 
 export interface SearchBox {
     /**
-     * Brings the box into line with the state, from inside `onChange`.
-     *
-     * Takes two scalars rather than the change object, so this stays independent
-     * of what the field was named and of which other fields the list has.
-     *
-     * Safe before `bind` and after the undo it returns: this only writes to the
-     * elements it was given, so a box that is no longer wired renders the last
-     * thing it was told rather than throwing.
+     * Brings the box into line with the state, from inside `onChange`. Two
+     * scalars rather than the change object, so this does not care what the
+     * field was named.
      */
     render(query: string, matchCount: number): void;
     /**
-     * Points the input and the clear button at one `text` field of a list, and
-     * returns the undo.
-     *
-     * Separate from construction because of an ordering knot rather than a
-     * preference: `render` is called from the list's own `onChange`, so the box
-     * has to exist before the list, and this needs the list. Two calls and a
-     * `const` each way is the honest version of that; the alternative is a `let`
-     * the reader has to hold in their head.
-     *
-     * One `AbortController`, as everywhere else here — see `carousel.attach`.
+     * Points the input and the clear button at one `text` field, and returns
+     * the undo. Separate from construction because `render` is called from the
+     * list's `onChange`: the box has to exist before the list, and this needs
+     * the list.
      */
     bind<F extends FieldMap>(
         list: Filters<F>,
@@ -123,45 +66,26 @@ export interface SearchBox {
 }
 
 /**
- * The search input beside a `filters` list, and the two things every one of them
- * has to remember.
+ * The search input beside a `filters` list.
  *
  * ```ts
- * const search = searchBox({
- *     input: one<HTMLInputElement>("[data-filter-search]"),
- *     clear: one("[data-filter-clear]"),
- *     empty: one("[data-filter-empty]"),
- *     count: one("[data-filter-count]"),
- * });
- *
+ * const search = searchBox({ input, clear, empty, count });
  * const list = filters({
- *     fields, items,
- *     onChange({ state, matched }) {
- *         search.render(state.q, matched.size);
- *         // …everything this list draws for itself
- *     },
+ *     fields,
+ *     items,
+ *     onChange: ({ state, matched }) => search.render(state.q, matched.size),
  * });
- *
  * const unbind = search.bind(list, "q");
- * const detach = list.attach();
  * ```
- *
- * It writes rather than calling back, and that is the only reason it exists.
- * `filters.onChange` is already the callback that hands a consumer the value and
- * gets out of the way; a second one here would hand back `query` and `count` and
- * leave the same three writes to be spelled out at every call site, which is the
- * duplication this was extracted from.
  */
 export function searchBox(elements: SearchBoxElements): SearchBox {
     const { input, clear, empty, count } = elements;
 
     return {
         render(query, matchCount) {
-            // Guarded by inequality, not written unconditionally. Assigning
-            // `value` while someone is typing in the field moves the caret to
-            // the end, so the one case this exists for — state that moved
-            // without the keyboard, from the back button or a `reset` — must not
-            // cost a caret jump on every other keystroke.
+            // Guarded by inequality: assigning `value` while someone types
+            // moves the caret to the end, and this exists for state that moved
+            // without the keyboard — the back button, or a `reset`.
             if (input != null && input.value !== query) input.value = query;
             if (clear != null) clear.hidden = query === "";
             if (empty != null) empty.hidden = matchCount > 0;
@@ -171,9 +95,8 @@ export function searchBox(elements: SearchBoxElements): SearchBox {
         bind(list, field) {
             const listeners = new AbortController();
             const { signal } = listeners;
-            // The narrowing `TextFieldOf` already did, restated for the
-            // implementation: inside a generic function TypeScript cannot see
-            // that this field's value type is `string`, though every caller can.
+            // The narrowing `TextFieldOf` already did: inside a generic
+            // function TypeScript cannot see that this field holds a string.
             const name = field as Parameters<typeof list.set>[0];
 
             input?.addEventListener(
@@ -186,10 +109,7 @@ export function searchBox(elements: SearchBoxElements): SearchBox {
                 "click",
                 () => {
                     list.reset(name);
-                    // Focus follows the click, because the button the pointer
-                    // was on has just hidden itself — leaving focus on a
-                    // `hidden` element strands a keyboard reader at a control
-                    // that is no longer there.
+                    // The button just hid itself; focus must not stay on it.
                     input?.focus();
                 },
                 { signal }
@@ -201,40 +121,19 @@ export function searchBox(elements: SearchBoxElements): SearchBox {
 }
 
 /**
- * Hides each group that has nothing visible left inside it.
- *
- * ```ts
- * onChange({ matched }) {
- *     for (const item of items) item.hidden = !matched.has(keyOf(item));
- *     hideEmpty(groups, (group) => within(group).all("[data-faq-key]"));
- * }
- * ```
- *
- * A filtered list that renders its results under headings has this problem and
- * nothing else does: hide the items and the headings stay, so a search for one
- * word leaves a page of section titles with nothing under them. It reads as a
- * broken template rather than as a result, which is what makes forgetting it
- * expensive — nothing errors, and the page looks wrong in a way that does not
- * point at the filter.
+ * Hides each group that has nothing visible left inside it — the heading
+ * problem a list with sections has and nothing else does.
  *
- * **Reads `hidden`, rather than taking the matched set.** The items were just
- * hidden by the caller, so their state is the shortest true description of what
- * survived — and reading it is what lets this nest. A country is empty when
- * every city in it is hidden; a region is empty when every country in it is
- * hidden, *including the ones this call just hid*.
+ * **Reads `hidden` rather than the matched set**, which is what lets it nest: a
+ * country is empty when every city is hidden, a region when every country is,
+ * *including the ones the previous call just hid*.
  *
- * **Which makes the order load-bearing: innermost first.**
+ * **So the order is load-bearing: innermost first.**
  *
  * ```ts
  * hideEmpty(countries, (c) => within(c).all("[data-city]"));
  * hideEmpty(regions, (r) => within(r).all("[data-country]"));
  * ```
- *
- * Run the other way round, the regions are judged against countries that have
- * not been hidden yet, and a region with nothing in it survives.
- *
- * A group with no children at all is hidden, which is the same answer by the
- * same rule — there is nothing visible in it.
  */
 export function hideEmpty<T extends HTMLElement>(
     groups: Iterable<T>,