@typed/ui 1.0.0-beta.1 → 1.0.0-beta.10

package/dist/Combobox.js

@@ -0,0 +1,300 @@
+/**
+ * Combobox keeps focus on its native input and exposes the active option through
+ * aria-activedescendant. Input, a manual native popover, and options share explicit value, open,
+ * and active state.
+ *
+ * @remarks
+ * The module keeps policy, state transitions, and DOM rendering separable so applications can use
+ * the state and pure operations without mounting UI, or supply custom hosts without replacing native
+ * events and browser-owned focus.
+ *
+ * Learn the interaction in the [Combobox guide](/explore/ui-combobox).
+ *
+ * @since 1.0.0
+ * @category modules
+ * @packageDocumentation
+ */
+import * as Effect from "effect/Effect";
+import * as Schema from "effect/Schema";
+import { RefSubject } from "@typed/fx";
+import { EventHandler, html, } from "@typed/template";
+import * as Collection from "./Collection.js";
+import * as Composite from "./Composite.js";
+import * as Dom from "./Dom.js";
+import * as NativePopover from "./NativePopover.js";
+/**
+ * Effect Schema used by makeState to encode, decode, and hydrate Combobox state.
+ *
+ * @remarks
+ * @example
+ * ```ts
+ * import * as Schema from "effect/Schema";
+ * import * as Combobox from "@typed/ui/Combobox";
+ *
+ * const decodeState = Schema.decodeUnknownEffect(Combobox.StateSchema);
+ * ```
+ * @since 1.0.0
+ * @category Query and popup state
+ */
+export const StateSchema = Schema.Struct({
+    id: Schema.String,
+    value: Schema.String,
+    open: Schema.Boolean,
+    activeId: Schema.NullOr(Schema.String),
+    orientation: Schema.Literals(["vertical"]),
+    loop: Schema.Boolean,
+    rtl: Schema.Boolean,
+    virtualFocus: Schema.Boolean,
+});
+/**
+ * Creates hydrated Combobox state. value defaults to an empty string, open to false, activeId to
+ * null, loop to true, and virtual focus is enabled.
+ *
+ * @remarks
+ * The returned Effect creates the RefSubject when run. That state is renderer-independent;
+ * collection registrations belong to the separate Scope that runs register or ref, not to state
+ * creation.
+ *
+ * @example
+ * ```ts
+ * import * as Effect from "effect/Effect";
+ * import * as Combobox from "@typed/ui/Combobox";
+ *
+ * const program = Effect.scoped(
+ *   Effect.gen(function* () {
+ *     const state = yield* Combobox.makeState({ id: "city" });
+ *     const collection = yield* Combobox.makeCollection();
+ *     return { state: yield* state, collection: yield* collection };
+ *   }),
+ * );
+ * ```
+ * @since 1.0.0
+ * @category Query and popup state
+ */
+export function makeState(initial) {
+    return RefSubject.hydrate(StateSchema, {
+        id: initial.id,
+        value: initial.value ?? "",
+        open: initial.open ?? false,
+        activeId: initial.activeId ?? null,
+        orientation: "vertical",
+        loop: initial.loop ?? true,
+        rtl: false,
+        virtualFocus: true,
+    });
+}
+/**
+ * Creates a scoped Collection for Combobox items.
+ *
+ * @remarks
+ * The returned Effect allocates the RefSubject in the caller's Scope. Each later registration is
+ * owned by the Scope that runs register, independently of this construction Effect.
+ *
+ * @example
+ * ```ts
+ * import * as Effect from "effect/Effect";
+ * import * as Combobox from "@typed/ui/Combobox";
+ *
+ * const program = Effect.scoped(
+ *   Effect.gen(function* () {
+ *     const collection = yield* Combobox.makeCollection();
+ *     return yield* collection;
+ *   }),
+ * );
+ * ```
+ * @since 1.0.0
+ * @category Suggestion registration
+ */
+export const makeCollection = Collection.makeState;
+/**
+ * Stores the input value, clears activeId, and opens the popup in one state update.
+ *
+ * @remarks
+ * The operation exposes Combobox's transition directly so callers can compose it in Effect
+ * programs and native event handlers.
+ *
+ * @since 1.0.0
+ * @category Query and popup state
+ */
+export function setValue(state, value) {
+    return RefSubject.update(state, (current) => ({ ...current, value, activeId: null, open: true }));
+}
+function openPopover(state, collection) {
+    return Effect.gen(function* () {
+        const current = yield* state;
+        const item = collection === undefined
+            ? undefined
+            : visibleItems(yield* collection).find((item) => item.value === current.value);
+        const next = yield* RefSubject.update(state, (value) => ({
+            ...value,
+            activeId: item?.id ?? value.activeId,
+            open: true,
+        }));
+        if (item !== undefined && collection !== undefined) {
+            yield* Composite.scrollActive({ state, collection });
+        }
+        return next;
+    });
+}
+function move(state, collection, direction) {
+    return Effect.gen(function* () {
+        const next = Composite.moveActiveId(visibleItems(yield* collection), yield* state, direction);
+        if (next === null)
+            return yield* state;
+        return yield* RefSubject.update(state, (current) => ({ ...current, activeId: next }));
+    });
+}
+function select(state, id, value) {
+    return RefSubject.update(state, (current) => ({ ...current, activeId: id, value, open: false }));
+}
+function selectActive(state, collection) {
+    return Effect.gen(function* () {
+        const activeId = (yield* state).activeId;
+        const item = activeId === null ? undefined : (yield* collection).find((item) => item.id === activeId);
+        return item?.value === undefined ? yield* state : yield* select(state, item.id, item.value);
+    });
+}
+function inputProps(options) {
+    const id = RefSubject.map(options.state, (state) => state.id);
+    const inputId = RefSubject.map(options.state, (state) => `${state.id}-input`);
+    const open = RefSubject.map(options.state, (state) => state.open);
+    const onkeydown = options.collection === undefined
+        ? undefined
+        : EventHandler.make(Effect.fn(function* (event) {
+            const direction = event.key === "ArrowDown" ? "next" : event.key === "ArrowUp" ? "previous" : undefined;
+            if (direction !== undefined) {
+                event.preventDefault();
+                if (!(yield* options.state).open) {
+                    yield* openPopover(options.state, options.collection);
+                }
+                yield* move(options.state, options.collection, direction);
+                yield* Composite.scrollActive({
+                    state: options.state,
+                    collection: options.collection,
+                });
+                return;
+            }
+            if (event.key === "Enter") {
+                if ((yield* options.state).activeId === null)
+                    return;
+                event.preventDefault();
+                yield* selectActive(options.state, options.collection);
+                return;
+            }
+            if (event.key === "Escape") {
+                yield* RefSubject.update(options.state, (state) => ({ ...state, open: false }));
+            }
+        }));
+    return () => ({
+        id: inputId,
+        role: "combobox",
+        "aria-autocomplete": "list",
+        "aria-controls": id,
+        "aria-expanded": open,
+        "aria-activedescendant": Composite.activeDescendant(options.state),
+        placeholder: options.placeholder,
+        ".value": RefSubject.map(options.state, (state) => state.value),
+        oninput: EventHandler.make(Effect.fn((event) => setValue(options.state, Dom.currentTarget(event).value))),
+        onfocus: openPopover(options.state, options.collection),
+        onkeydown,
+    });
+}
+function visibleItems(collection) {
+    return Collection.byDomOrder(collection).filter((item) => item.element === undefined || item.element.closest("[hidden]") === null);
+}
+/**
+ * Renders the native combobox input, keeps its value property synchronized, opens on focus, and
+ * handles Arrow, Enter, and Escape when a collection is supplied.
+ *
+ * @remarks
+ * The returned Fx installs DOM refs, native listeners, state subscriptions, and optional
+ * collection registrations only when rendered. The rendering Scope removes those resources;
+ * unrelated nodes and attributes remain caller-owned.
+ *
+ * @since 1.0.0
+ * @category Editable input
+ */
+export function Input(options, host) {
+    return Dom.renderHost()(options, host, inputProps(options), "", (props) => html `<input ...${props} />`);
+}
+function popoverProps(options) {
+    const id = RefSubject.map(options.state, (state) => state.id);
+    const inputId = RefSubject.map(options.state, (state) => `${state.id}-input`);
+    return () => ({
+        id,
+        role: "listbox",
+        "aria-labelledby": inputId,
+        popover: "manual",
+        ontoggle: EventHandler.make(Effect.fn(function* (event) {
+            const open = Dom.toggleState(event) === "open";
+            const current = yield* options.state;
+            if (current.open === open)
+                return current;
+            const next = yield* RefSubject.update(options.state, (state) => ({ ...state, open }));
+            if (!open || options.collection === undefined)
+                return next;
+            const item = (yield* options.collection).find((item) => item.value === next.value);
+            if (item === undefined)
+                return next;
+            const selected = yield* RefSubject.update(options.state, (state) => ({
+                ...state,
+                activeId: item.id,
+            }));
+            yield* Composite.scrollActive({ state: options.state, collection: options.collection });
+            return selected;
+        })),
+        ref: Dom.composeRefs(options.state, NativePopover.ref(options.state)),
+    });
+}
+/**
+ * Renders manual-popover listbox content, mirrors native toggle events into open state, and
+ * scrolls the selected option when opened.
+ *
+ * @remarks
+ * The returned Fx installs DOM refs, native listeners, state subscriptions, and optional
+ * collection registrations only when rendered. The rendering Scope removes those resources;
+ * unrelated nodes and attributes remain caller-owned.
+ *
+ * @since 1.0.0
+ * @category Suggestion popup
+ */
+export function Popover(options, host) {
+    return Dom.renderHost()(options, host, popoverProps(options), options.content, (props, content) => {
+        return html `<div ...${props}>${content}</div>`;
+    });
+}
+function itemProps(options) {
+    const selected = RefSubject.map(options.state, (state) => state.value === options.value);
+    const register = options.collection === undefined
+        ? undefined
+        : Collection.ref(options.collection, {
+            id: options.id,
+            value: options.value,
+            textValue: options.textValue ?? options.value,
+            disabled: options.disabled,
+        });
+    return () => ({
+        id: options.id,
+        role: "option",
+        "aria-selected": selected,
+        "aria-disabled": options.disabled ?? false,
+        tabindex: Composite.tabIndex(options.state, options.id),
+        onclick: options.disabled === true ? Effect.void : select(options.state, options.id, options.value),
+        ref: Dom.composeRefs(register, options.ref),
+    });
+}
+/**
+ * Renders and optionally registers one option; disabled options expose aria-disabled and do not
+ * select on click.
+ *
+ * @remarks
+ * The returned Fx installs DOM refs, native listeners, state subscriptions, and optional
+ * collection registrations only when rendered. The rendering Scope removes those resources;
+ * unrelated nodes and attributes remain caller-owned.
+ *
+ * @since 1.0.0
+ * @category Suggestions
+ */
+export function Item(options, host) {
+    return Dom.renderHost()(options, host, itemProps(options), options.content, (props, content) => html `<div ...${props}>${content}</div>`);
+}