@optionfactory/fml 9.0.0-rc13 → 9.0.0-rc15

package/dist/ful.d.mts

@@ -303,6 +303,8 @@ declare class Field extends ParsedElement {
      * @param {string} [context] the path below this field's name, '' when exact
      */
     setCustomValidity(error?: string, context?: string): void;
+    /** The form the platform associated the field with, null outside one: a native control's own `form`. */
+    get form(): HTMLFormElement | null;
     /** Submits the associated form through its first submitter, as Enter on a native control would. */
     _requestSubmit(): void;
     /**
@@ -632,8 +634,10 @@ declare class Anchors {
      *   the popover, giving toggle and light dismiss with no script of your own
      * @param {boolean} [options.expanded] keeps the invoker's `aria-expanded` in
      *   step with the popover
-     * @param {boolean} [options.stretch] widens the popover to its invoker, which
-     *   is what a combobox dropdown wants
+     * @param {boolean} [options.stretch] widens the popover to at least its
+     *   invoker's width, capped by its own `max-width`, which is what a combobox
+     *   dropdown wants; it flips above the invoker where the viewport leaves no
+     *   room below
      * @param {boolean} [options.handPlace] places here on every platform rather
      *   than only as a fallback, which a popover asks for when it needs to know
      *   where its invoker ended up: the tooltip's note points a callout at it, and
@@ -648,6 +652,36 @@ declare class Anchors {
         stretch?: boolean;
         handPlace?: boolean;
     }): void;
+    /**
+     * Shows and places a popover beside an anchor, once: the popover shared by
+     * many invokers, each open handing over its own anchor, and an anchor that
+     * is a rectangle rather than an element, one read out of an iframe being
+     * the case a paired invoker could not cover. No pairing, no reflow
+     * following, no close wiring: closing is the caller's, or the platform's
+     * for a light-dismissing popover.
+     *
+     * The placement is the menus' own geometry, below the anchor and
+     * start-aligned, clamped into the viewport; `flip` moves it above the
+     * anchor where the viewport leaves no room below, as the css
+     * `position-try-fallbacks` the paired popovers declare. A popover not
+     * already open is shown and placed before the call returns, so the first
+     * position anybody sees is the right one and the caller can move the focus
+     * into it on the next line.
+     *
+     * @param {HTMLElement} popover the `[popover]` element to show, or an
+     *   already-shown element to place
+     * @param {Element|DOMRect} anchor the element, or the rectangle, to place
+     *   beside
+     * @param {object} [options]
+     * @param {boolean} [options.flip] place above the anchor where no room is
+     *   left below
+     * @param {number} [options.gap] the distance from the anchor, in pixels
+     * @returns {HTMLElement} the popover
+     */
+    static show(popover: HTMLElement, anchor: Element | DOMRect, { flip, gap }?: {
+        flip?: boolean;
+        gap?: number;
+    }): HTMLElement;
 }
 /**
  * Fetches a select's whole vocabulary from a url and serves every later read
@@ -765,6 +799,7 @@ declare class Select extends Field {
     #private;
     static attributes: string[];
     static observed: string[];
+    unmarshal(attr: any, str: any): any;
     static slots: boolean;
     static template: string;
     static templates: {
@@ -969,7 +1004,9 @@ export type FilterCriterion = {
  * the data-jpa compare annotations.
  */
 declare class CompareFilter extends Input {
+    #private;
     static observed: string[];
+    static attributes: string[];
     static OPERATORS: string[];
     static DEFAULT_OPERATOR: string;
     static template: string;
@@ -1030,7 +1067,9 @@ declare class NumberFilter extends CompareFilter {
 }
 /** The compare filter over text, carrying a case sensitivity beside the operator. */
 declare class TextFilter extends CompareFilter {
+    #private;
     static observed: string[];
+    static attributes: string[];
     static template: string;
     _defaultOperator(): string;
     _vocabulary(): string[];
@@ -1078,6 +1117,7 @@ declare class BooleanFilter extends Field {
     _vocabulary(): string[];
     get value(): any[] | null;
     set value(v: any[] | null);
+    formResetCallback(): void;
     /** @returns {FilterCriterion|null} */
     get criterion(): FilterCriterion | null;
     get disabled(): boolean;
@@ -1181,6 +1221,43 @@ declare class Dialog extends ParsedElement {
      */
     refresh(): Promise<any[] | undefined>;
     close(result: any): void;
+    /**
+     * Asks a question in a dialog of the page's own, resolving with its outcome
+     * and removing the element afterwards: the element stays the author's when
+     * the question lives in the page, while a question asked from a button had
+     * to build, render, show, answer and clean up by hand.
+     *
+     * The body is text or a node: a string is never read as markup, an
+     * `innerHTML` sink being a thing the library does not carry. Each button is
+     * a `[result, label, className?]` tuple rendered as its answer, or a node
+     * the caller has built itself, which is how a button carries anything a
+     * tuple cannot say and how a footer gets a spacer.
+     * @param {string} header
+     * @param {string|Node} body
+     * @param {([string, string, string?]|Node)[]} [buttons]
+     * @param {{ className?: string }} [options] `className` dresses the dialog,
+     *   the way a declared `ful-dialog` is given one to size it
+     * @returns {Promise<DialogOutcome>}
+     */
+    static ask(header: string, body: string | Node, buttons?: ([string, string, string?] | Node)[], { className }?: {
+        className?: string;
+    }): Promise<DialogOutcome>;
+    /**
+     * Asks a yes/no question, resolving with the confirm button's answer:
+     * the cancel button, the close button and Escape all answer false, a
+     * dismissal being the negative.
+     * @param {string} header
+     * @param {string|Node} body
+     * @param {{ confirm?: string, cancel?: string }} [labels] overriding the localized defaults
+     * @param {{ className?: string }} [options] as `ask` takes them
+     * @returns {Promise<boolean>}
+     */
+    static confirm(header: string, body: string | Node, labels?: {
+        confirm?: string;
+        cancel?: string;
+    }, options?: {
+        className?: string;
+    }): Promise<boolean>;
 }
 /**
  * A side panel drawer on the native dialog platform, update() owning its
@@ -1199,15 +1276,15 @@ declare class Drawer extends ParsedElement {
     render({ slots }: {
         slots: any;
     }): void;
-    get title(): any;
-    set title(v: any);
+    get header(): any;
+    set header(v: any);
     /**
-     * Opens the drawer under the given title and waits for the callback: a
+     * Opens the drawer under the given header and waits for the callback: a
      * resolved value paints the content section (which is returned), a
      * rejection paints the problems and travels to the caller, and an update
      * superseded by a newer one paints nothing.
      */
-    update(title: any, cb: any): Promise<any>;
+    update(header: any, cb: any): Promise<any>;
     /**
      * Re-fires section:requested on the content, open or closed: the explicit
      * request for a body that wants refreshing. A failed refresh paints its
@@ -1217,6 +1294,26 @@ declare class Drawer extends ParsedElement {
     open(): void;
     close(): void;
 }
+/**
+ * A menu of commands on the native popover platform: the invoker named by
+ * `for` toggles it and light dismiss and Escape come from the browser, while
+ * the element adds the menu semantics and the keyboard protocol.
+ *
+ * The items are the buttons and links written inside it, kept as they are and
+ * given their menu role and their place in the roving focus. Activation is the
+ * item's own click, which the element only follows by closing.
+ */
+declare class Menu extends ParsedElement {
+    #private;
+    static attributes: string[];
+    render(): void;
+    /**
+     * The commands, in the order the arrows walk them: the menu's own buttons
+     * and links, minus the disabled and hidden ones, which keep their role and
+     * leave the walk.
+     */
+    get items(): HTMLElement[];
+}
 /** A transient feedback region: each show() stacks a toast that retires on its own timer. */
 declare class Toasts extends ParsedElement {
     #private;
@@ -1228,8 +1325,13 @@ declare class Toasts extends ParsedElement {
      * Appends a toast carrying the message (a Failure shows its problems'
      * reasons, one per line), severity picking the theme and the announcement,
      * the toast retiring through its own timer or its dismiss button.
+     *
+     * The timer holds while the toast is hovered or holds the focus, so an
+     * actionable toast waits for its reader: `action` is `{ label, onClick }`,
+     * a button beside the message whose click answers and retires. The same
+     * options travel in the `show-toast` event's detail.
      * @param {any} message
-     * @param {any} [options] severity and timeout
+     * @param {any} [options] severity, timeout and action
      * @returns {HTMLElement}
      */
     show(message: any, options?: any): HTMLElement;
@@ -1340,6 +1442,6 @@ declare class Plugin {
     });
     configure(registry: any): void;
 }
-export { Accordion, Anchors, AsyncEvents, Bindings, BooleanFilter, Checkbox, Claims, CompareFilter, Dialog, Drawer, Dropdown, Field, Form, FormLoader, InFilter, Input, InputFile, InputInstant, InputLocalDate, InputLocalTime, Instant, InstantFilter, LocalDate, LocalDateFilter, LocalStorage, NumberFilter, Pagination, Plugin, RadioGroup, Select, SelectLoader, SessionStorage, SortButton, Table, TableLoader, TableSchemaParser, Tabs, TextFilter, Timing, Toasts, Tooltip, VersionedLocalStorage, VersionedSessionStorage, Wizard, describable };
+export { Accordion, Anchors, AsyncEvents, Bindings, BooleanFilter, Checkbox, Claims, CompareFilter, Dialog, Drawer, Dropdown, Field, Form, FormLoader, InFilter, Input, InputFile, InputInstant, InputLocalDate, InputLocalTime, Instant, InstantFilter, LocalDate, LocalDateFilter, LocalStorage, Menu, NumberFilter, Pagination, Plugin, RadioGroup, Select, SelectLoader, SessionStorage, SortButton, Table, TableLoader, TableSchemaParser, Tabs, TextFilter, Timing, Toasts, Tooltip, VersionedLocalStorage, VersionedSessionStorage, Wizard, describable };
 
 export as namespace ful;