@aceshooting/lyra-ui 1.2.0 → 2.1.0

package/dist/components/model-select/model-select.d.ts

@@ -0,0 +1,170 @@
+import { type TemplateResult, type PropertyValues } from 'lit';
+import { LyraElement } from '../../internal/lyra-element.js';
+/** A catalog row: a selectable model, keyed by `id` with a display `label`. */
+export interface LyraModelCatalogEntry {
+    id: string;
+    label: string;
+}
+/**
+ * The `catalog` shape: either every entry is a plain string (used as both id
+ * and label) or every entry is a full `{ id, label }` row — not a mix of both.
+ */
+export type LyraModelCatalog = string[] | LyraModelCatalogEntry[];
+/**
+ * `<lyra-model-select>` — a provider/model picker that renders as a closed
+ * dropdown when a fixed `catalog` is available, or as a filterable free-text
+ * combobox when it isn't (or when `allow-custom` explicitly permits typing
+ * something outside the catalog). Built directly on the shared
+ * trigger-button/aria-activedescendant listbox technique `<lyra-select>` uses
+ * and the filter-as-you-type suggestion-popup technique `<lyra-combobox>`
+ * uses — not by composing either element, since the mode switch and the
+ * stale-value handling below are specific to this control.
+ *
+ * A `value` that isn't present in `catalog` (e.g. a model id saved from a
+ * provider whose live catalog has since changed) is never silently dropped:
+ * `effectiveEntries` appends it to the rendered option list as a synthetic,
+ * visually-distinct row (dashed border, italic label, "not in catalog"
+ * badge — see `model-select.styles.ts`) computed fresh from `catalog` +
+ * `value` on every render, without ever mutating the `catalog` property
+ * itself.
+ *
+ * @customElement lyra-model-select
+ * @event lyra-change - The selected/typed value changed. `detail: { value: string; inCatalog: boolean }`.
+ * @csspart form-control-label - The `<label>` element (only rendered — and only contributes to the
+ *   accessible name — once `label` is non-empty).
+ * @csspart trigger - The trigger button (closed-dropdown mode's positioning anchor).
+ * @csspart combobox - The text-input container (free-text mode's positioning anchor).
+ * @csspart combobox-input - The free-text mode's text input.
+ * @csspart provider-badge - The optional leading `provider` label.
+ * @csspart listbox - The options popover (shared by both modes).
+ * @csspart option - An option row.
+ * @csspart option-label - An option row's label.
+ * @csspart option-badge - The "not in catalog" badge on a synthetic stale-value row.
+ * @csspart expand-icon - The dropdown indicator.
+ */
+export declare class LyraModelSelect extends LyraElement {
+    static formAssociated: boolean;
+    static styles: import("lit").CSSResultGroup[];
+    static properties: {
+        disabled: {
+            type: BooleanConstructor;
+            reflect: boolean;
+            noAccessor: boolean;
+        };
+        required: {
+            type: BooleanConstructor;
+            reflect: boolean;
+            noAccessor: boolean;
+        };
+        value: {
+            noAccessor: boolean;
+        };
+        name: {
+            reflect: boolean;
+            noAccessor: boolean;
+        };
+    };
+    /** Informational only — e.g. `'ollama'`. Rendered as a small leading badge for display grouping. */
+    provider: string;
+    /** The full model list. Omit (or leave empty) to fall back to plain free-text entry. */
+    catalog?: LyraModelCatalog;
+    /** Let the user type/commit a value that isn't in `catalog`, even when `catalog` is non-empty. */
+    allowCustom: boolean;
+    /**
+     * Optional visible title above the control, mirroring `lyra-select`'s
+     * `label` exactly: rendered via a `part="form-control-label"` `<label>`
+     * paired with the control's id, and — once non-empty — it takes over as
+     * the accessible-name source (the `aria-label` fallback below is then only
+     * emitted when the host has an explicit `aria-label` override, same
+     * precedence as `lyra-select`). Leaving it empty (the default) keeps
+     * today's `aria-label || placeholder || 'Model'` chain untouched.
+     */
+    label: string;
+    placeholder: string;
+    open: boolean;
+    private activeIndex;
+    private query;
+    private touched;
+    private internals;
+    private validityController;
+    private listId;
+    private controlId;
+    private cleanup?;
+    private _value;
+    private _fieldsetDisabled;
+    private _name;
+    private _disabled;
+    private _required;
+    private _defaultValue;
+    constructor();
+    get form(): HTMLFormElement | null;
+    get labels(): NodeList;
+    get validity(): ValidityState;
+    get validationMessage(): string;
+    get willValidate(): boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, old: string | null, val: string | null): void;
+    /** The current model id (empty string when nothing is selected). */
+    get value(): string;
+    set value(next: string);
+    /** The form submission key, reflected synchronously for native form APIs. */
+    get name(): string;
+    set name(next: string);
+    get disabled(): boolean;
+    set disabled(next: boolean);
+    get required(): boolean;
+    set required(next: boolean);
+    /** Whether the control is disabled explicitly or by an ancestor fieldset. */
+    get effectiveDisabled(): boolean;
+    private updateValidity;
+    formResetCallback(): void;
+    formStateRestoreCallback(state: string | File | FormData | null, _mode?: 'restore' | 'autocomplete'): void;
+    formDisabledCallback(disabled: boolean): void;
+    checkValidity(): boolean;
+    reportValidity(): boolean;
+    /** `catalog`, normalized to `{ id, label }[]` regardless of the plain-string-array shorthand. */
+    private get normalizedCatalog();
+    /** Closed-dropdown-with-listbox mode vs. free-text filterable mode — see class doc. */
+    private get closedMode();
+    /**
+     * `normalizedCatalog` plus, when `value` isn't one of its ids, a synthetic
+     * trailing row for it — recomputed from scratch on every access so it
+     * always reflects the *current* `catalog`/`value`, never a snapshot from
+     * whenever `value` happened to be assigned.
+     */
+    private get effectiveEntries();
+    /** `effectiveEntries` filtered by the typed `query` (free-text mode only; id or label substring, case-insensitive). */
+    private get filteredEntries();
+    private labelFor;
+    private show;
+    private hide;
+    private onDocPointer;
+    protected updated(changed: PropertyValues): void;
+    private commitValue;
+    private selectEntry;
+    /** Enter in free-text mode: commit the highlighted suggestion, else the raw typed text. */
+    private commitFreeText;
+    private onTriggerClick;
+    private onTriggerBlur;
+    private onTriggerKeyDown;
+    private onComboMouseDown;
+    private onInputFocus;
+    private onInput;
+    private onInputBlur;
+    private onInputKeyDown;
+    private onListboxMouseDown;
+    private onListboxClick;
+    private renderRows;
+    private renderListbox;
+    /** `part="form-control-label"` — see `label`'s doc comment for its precedence over `aria-label`. */
+    private renderLabel;
+    private renderClosed;
+    private renderFreeText;
+    render(): TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'lyra-model-select': LyraModelSelect;
+    }
+}