@fusion.dev/helix-headless 0.0.0-dev → 0.0.2

package/dist/date-picker/root/date-picker-root.d.ts

@@ -31,8 +31,7 @@ declare const HelixHeadlessDatePicker_base: (new (...args: any[]) => import("@fu
  * Left unset, month and day names come from the runtime's own locale, and a
  * server and a browser need not agree on what that is.
  *
- * `helix-before-change` was `helix-select`, and it moved when the calendar became
- * form control. A control whose value changes dispatches `helix-before-change` here:
+ * A control whose value changes dispatches `helix-before-change`:
  * `Input`, `Select`, `Listbox`, `Radio.Group` and `Toggle.Group` all do, and a
  * calendar submitting a date is the same kind of thing. `helix-select` stays
  * what it is elsewhere, which is a row or an item being chosen in something
@@ -78,19 +77,9 @@ declare const HelixHeadlessDatePicker_base: (new (...args: any[]) => import("@fu
  */
 export declare class HelixHeadlessDatePicker extends HelixHeadlessDatePicker_base {
     /**
-     * How many dates can be held at once.
-     */
-    mode?: 'range' | 'multiple';
-    /**
-     * How many months to show, side by side.
-     */
-    months: number;
-    /**
-     * Locale for month and day names.
-     *
-     * Absent uses the runtime's own.
+     * Month to open on, where nothing declared one.
      */
-    locale: string;
+    defaultMonth: string;
     /**
      * Dates that cannot be chosen, comma separated, as `YYYY-MM-DD`.
      */
@@ -99,73 +88,78 @@ export declare class HelixHeadlessDatePicker extends HelixHeadlessDatePicker_bas
      * Days of the week that cannot be chosen, comma separated, `0` to `6`.
      */
     disableDays: string;
+    /**
+     * First column of the week, `0` for Sunday through `6` for Saturday.
+     */
+    firstDayOfWeek: number;
     /**
      * Whether the current selection fails validation.
      */
     invalid: boolean;
+    /**
+     * Accessible name for the grid.
+     */
+    label: string;
     /**
      * The month on show, as `YYYY-MM`. Follows `value`, then the current month.
      *
      * Separate from `value` on purpose, so paging selects nothing and a consumer
-     * can drive the view. It said that and could not do it: the calendar wrote
-     * this when the reader paged, so a consumer holding it was overwritten and
-     * never told. Reading gives the month on show; writing declares it theirs,
-     * and `default-month` seeds one the calendar owns.
-     *
-     *
+     * can drive the view. Reading gives the month on show; writing sets it, and
+     * `default-month` seeds one the calendar keeps until somebody does.
      */
     get month(): string;
     set month(next: string);
     /**
-     * Accessible name for the control that pages back.
+     * Locale for month and day names.
      *
-     * A property because this is the one component in the library that takes a
-     * `locale`, and it carried two hardcoded English names with no way to change
-     * them: a calendar rendering its own month names in Japanese still announced
-     * its controls in English. `attribute:` spelled out, since Lit lowercases a
-     * camelCase name rather than dash-casing it.
+     * Absent uses the runtime's own.
      */
-    previousLabel: string;
+    locale: string;
     /**
-     * Accessible name for the control that pages forward.
+     * Latest selectable date, as `YYYY-MM-DD`.
      */
-    nextLabel: string;
+    max: string;
     /**
-     * Month to open on, where nothing declared one.
+     * Earliest selectable date, as `YYYY-MM-DD`.
      */
-    defaultMonth: string;
+    min: string;
     /** The month on show, whoever set it, and `undefined` until somebody has. */
     private monthState;
     /**
-     * Earliest selectable date, as `YYYY-MM-DD`.
+     * How many dates can be held at once.
      */
-    min: string;
+    mode?: 'range' | 'multiple';
     /**
-     * How far apart the selectable dates are, in days.
-     *
-     * `<input type="date" step>`'s own unit, counted from `min` where there is
-     * one and from 1 January 1970 where there is not, which is the platform's own
-     * base. A booking calendar that only takes Mondays is `step="7"` with a `min`
-     * on a Monday, and there was no way to say that: `disable-dates` takes a list
-     * and a year of Mondays is not a list anybody writes.
-     *
-     * One is every date and needs no rule, which is why anything below one is
-     * treated as one rather than as an error: a step of zero would block every
-     * date including the one already chosen.
+     * How many months to show, side by side.
      */
-    step: number;
+    months: number;
     /**
-     * Latest selectable date, as `YYYY-MM-DD`.
+     * Accessible name for the control that pages forward.
      */
-    max: string;
+    nextLabel: string;
     /**
-     * Accessible name for the grid.
+     * Accessible name for the control that pages back.
+     *
+     * A property because a calendar rendering its own month names from `locale`
+     * would otherwise still announce its controls in English. `attribute:`
+     * spelled out, since Lit lowercases a camelCase name rather than dash-casing
+     * it.
      */
-    label: string;
+    previousLabel: string;
     /**
-     * First column of the week, `0` for Sunday through `6` for Saturday.
+     * Whether the control refuses changes while still submitting its value.
+     *
+     * **Enforced by refusing every request in one place**, which is the seam this
+     * component already has: `requestValue` is what every path here comes through,
+     * and gating it once is what stops the next call site from being written
+     * without the check.
+     *
+     * Not `disabled`, which is the confusion worth naming: a disabled control
+     * submits nothing and leaves the tab order, and a read-only one submits its
+     * value and stays reachable, which is what a form showing a value somebody
+     * else set needs.
      */
-    firstDayOfWeek: number;
+    readOnly: boolean;
     /**
      * The date the grid's tab stop is on.
      *
@@ -184,7 +178,7 @@ export declare class HelixHeadlessDatePicker extends HelixHeadlessDatePicker_bas
      *
      * Split out from `shown` so `month` can report what is on display without the
      * two calling each other: `month` reading `shown` and `shown` reading `month`
-     * is a stack overflow, and the specs found it immediately.
+     * is a stack overflow.
      */
     private get derivedMonth();
     /**
@@ -206,11 +200,10 @@ export declare class HelixHeadlessDatePicker extends HelixHeadlessDatePicker_bas
     /**
      * Whether a date is barred, by bound, by weekday, or by name.
      *
-     * `barred`, not `disabled`: the calendar is a form control now, and
-     * `HelixFormElement.disabled` is a boolean about the whole control. A method
-     * and a flag cannot share a name, and of the two it is the method that should
-     * move, because "disabled" on a control means one thing everywhere else in
-     * the library.
+     * `barred`, not `disabled`: `HelixFormElement.disabled` is a boolean about the
+     * whole control, and a method and a flag cannot share a name. "Disabled" on a
+     * control means one thing everywhere else in the library, so the method is the
+     * one that moves.
      */
     private barred;
     /**
@@ -218,8 +211,8 @@ export declare class HelixHeadlessDatePicker extends HelixHeadlessDatePicker_bas
      *
      * `helix-navigate` and not `helix-change`: paging chooses nothing, and a
      * consumer driving the view has to hear that it moved without being told the
-     * answer did. In controlled mode nothing moves and the consumer decides,
-     * which is the point of them holding it.
+     * answer did. Refusing the event is how they take the decision, and nothing
+     * moves.
      */
     private show;
     private moveTo;
@@ -235,25 +228,25 @@ export declare class HelixHeadlessDatePicker extends HelixHeadlessDatePicker_bas
     connectedCallback(): void;
     disconnectedCallback(): void;
     /**
-     * Whether the control refuses changes while still submitting its value.
-     *
-     * **Enforced by refusing every request in one place**, which is the seam this
-     * component already has: `requestValue` is what every path here comes through,
-     * and gating it once is what stops the next call site from being written
-     * without the check.
-     *
-     * Not `disabled`, which is the confusion worth naming: a disabled control
-     * submits nothing and leaves the tab order, and a read-only one submits its
-     * value and stays reachable, which is what a form showing a value somebody
-     * else set needs.
+     * Whether the form refuses to submit while nothing is chosen.
      */
-    readOnly: boolean;
+    required: boolean;
     /** Refuses every change while read-only. See `readOnly`. */
     requestValue(next: string): boolean;
     /**
-     * Whether the form refuses to submit while nothing is chosen.
+     * How far apart the selectable dates are, in days.
+     *
+     * `<input type="date" step>`'s own unit, counted from `min` where there is
+     * one and from 1 January 1970 where there is not, which is the platform's own
+     * base. A booking calendar that only takes Mondays is `step="7"` with a `min`
+     * on a Monday, which `disable-dates` cannot express: it takes a list, and a
+     * year of Mondays is not a list anybody writes.
+     *
+     * One is every date and needs no rule, which is why anything below one is
+     * treated as one rather than as an error: a step of zero would block every
+     * date including the one already chosen.
      */
-    required: boolean;
+    step: number;
     /**
      * Reports "required and empty", or clears it.
      *
@@ -296,21 +289,20 @@ export declare class HelixHeadlessDatePicker extends HelixHeadlessDatePicker_bas
     /**
      * How many months are shown, clamped once.
      *
-     * `months` was clamped at the call site and read raw where the last month is
-     * identified, so a zero, a negative or a non-numeric value rendered nothing
-     * and took the forward control with it: `index === this.months - 1` is never
-     * true for `NaN`. One getter both read.
+     * One getter for both readers. Clamping at the call site while the last month
+     * is identified from the raw `months` renders nothing for a zero, a negative
+     * or a non-numeric value, and takes the forward control with it, since
+     * `index === this.months - 1` is never true for `NaN`.
      */
     private get monthCount();
     /**
      * The three date formatters, built once per locale rather than per render.
      *
-     * `Intl.DateTimeFormat` is expensive to construct and these depend on nothing
-     * but `locale`, and they were built inside the per-month render: three
-     * constructions for every month on show, on every update, so a two-month
-     * calendar rebuilt six of them each time an arrow key moved the anchor.
-     * Measured elsewhere at about a quarter of a millisecond apiece, which is not
-     * a crisis and is pure waste.
+     * `Intl.DateTimeFormat` costs about a quarter of a millisecond to construct
+     * and these depend on nothing but `locale`, so building them inside the
+     * per-month render is three constructions for every month on show, on every
+     * update: a two-month calendar rebuilds six each time an arrow key moves the
+     * anchor.
      *
      * Keyed on the locale so a change to it is picked up, which a plain lazy
      * field would not do.