@ecoma-io/loom 0.1.0 → 0.2.0

package/dist/primitives/DateTimeRangePicker/DateTimeRangePicker.vue.d.ts

@@ -0,0 +1,181 @@
+import { type DateValue } from "@internationalized/date";
+import { type LabelOverrides } from "../../lib/labels";
+import type { LabelOf } from "../../lib/labels";
+import type { CalendarPanelLabels, DateSegmentLabels, RangeCellLabels, TimeSegmentLabels } from "../../lib/date-labels";
+/**
+ * A span between two instants as the outside world holds it: two plain ISO
+ * local date-time strings, `"YYYY-MM-DDTHH:mm"`, both optional.
+ *
+ * The shape is `DateRange`'s and the reasoning behind it is `DateRange`'s — a
+ * half-made range has to be representable, and `range.start` reads where
+ * `range[0]` needs a comment. What is deliberately not shared is the **name**.
+ * Two identically-shaped types whose strings are in different formats are
+ * exactly what distinct names are for: a `DateRange` handed to this control
+ * loses its times, and a `DateTimeRange` handed to DateRangePicker carries a
+ * `T09:30` no calendar day can hold. One name for both would let either mistake
+ * compile.
+ */
+export interface DateTimeRange {
+    /** The instant the span opens at, ISO `"YYYY-MM-DDTHH:mm"`. Absent while nothing has been chosen. */
+    start?: string | undefined;
+    /** The instant the span closes at, ISO `"YYYY-MM-DDTHH:mm"`. Absent while only the start has been chosen. */
+    end?: string | undefined;
+}
+/**
+ * The strings this control says that no other member of the family says: the
+ * two half-group names and the status line above the grids.
+ *
+ * They are **not** shared with `DateRangePicker`, which says both in different
+ * words and from different facts — `Start date` against `Start date and time`,
+ * a count of whole days against a signed duration. A key shared between them
+ * would have to be a sentence that is never true of both. Its calendar cells'
+ * names *are* shared, in `rangeCell`, because those differ in neither.
+ *
+ * The segment names and the calendar chrome, which every one of the five
+ * shares, come from `src/lib/date-labels.ts` too.
+ */
+export interface DateTimeRangeLabels {
+    /** The group holding the first half of the field. Reka names a segment `hour` or `year` alone, which is ten segments and two identical sets of five names with nothing to tell the ends apart. */
+    readonly startDate: string;
+    /** The group holding the second half of the field. */
+    readonly endDate: string;
+    /**
+     * The `role="status"` line above the grids — what has been chosen, what is
+     * wanted next, how long the finished span is, and whether it runs backwards.
+     *
+     * **One message rather than four sentences and a joiner**, and that collapse
+     * is what deleted this control's hand-rolled pluraliser rather than moving
+     * it. `minutes` is the whole duration as a number, so a host builds "2 days
+     * 3 hours" with `Intl.DurationFormat`, `Intl.PluralRules` or their own
+     * translation file — Loom ships no plural engine and appends no `"s"`.
+     *
+     * `minutes` is **signed**: negative means the end falls before the start,
+     * which within a single day only the times can decide and which nothing in
+     * the grid distinguishes. It is `undefined` while the range is half made.
+     *
+     * `locale`, `hour12` and `seconds` arrive only because Loom's own English
+     * default has to format the two instants somehow, and they are the control's
+     * own props rather than anything it has already decided. A host replacing
+     * this formats with whatever their application already uses and ignores all
+     * three.
+     */
+    readonly status: LabelOf<{
+        locale: string;
+        start: DateValue | undefined;
+        end: DateValue | undefined;
+        minutes: number | undefined;
+        hour12: boolean | undefined;
+        seconds: boolean;
+    }>;
+}
+/**
+ * Loom's English, co-located with the component so it tree-shakes with it, and
+ * exported so a host can build a partial vocabulary against the real thing.
+ */
+export declare const DATE_TIME_RANGE_LABELS: DateTimeRangeLabels;
+/**
+ * Everything this control can be asked to say: the four shared slices, plus its
+ * own. Annotate a bag with `LabelOverrides<DateTimeRangePickerLabels>` and never
+ * with this, which is total.
+ */
+export type DateTimeRangePickerLabels = DateSegmentLabels & TimeSegmentLabels & CalendarPanelLabels & RangeCellLabels & DateTimeRangeLabels;
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    /**
+     * The chosen span, as `{ start, end }` ISO `"YYYY-MM-DDTHH:mm"` strings —
+     * `"…:ss"` when `granularity` asks for seconds. Either half may be absent:
+     * `{}` is nothing chosen, `{ start }` is a range half made. A bare
+     * `"YYYY-MM-DD"` is accepted in either half and read as midnight that day.
+     * The explicit `| undefined` is what lets `v-model` bind a ref that clears.
+     */
+    modelValue?: DateTimeRange | undefined;
+    /** The earliest choosable instant, same format. The calendar disables every day that lies wholly before it; a time before it on the boundary day is announced invalid rather than refused. */
+    min?: string;
+    /** The latest choosable instant, same format. The calendar disables every day that lies wholly after it; a time after it on the boundary day is announced invalid rather than refused. */
+    max?: string;
+    /** How far down both halves of the field go. `"minute"` reports `"YYYY-MM-DDTHH:mm"`; `"second"` adds a seconds segment to each end and reports `"YYYY-MM-DDTHH:mm:ss"`. */
+    granularity?: "minute" | "second";
+    /** Whether both times read as 12-hour with an AM/PM segment or as 24-hour. Display only: the value stays 24-hour. Unset follows `locale`. */
+    hourCycle?: 12 | 24;
+    /** BCP 47 tag driving the order of the segments in both halves, the month and weekday names, which day a week starts on, and the 12-or-24-hour default. */
+    locale?: string;
+    /** How many months the calendar shows at once. Two is the default because a span is usually read across a month boundary; one is for a host that knows it is rendering into a narrow shell. */
+    months?: 1 | 2;
+    /** Unavailable: dims the control, refuses the calendar, and takes the field out of the tab order. Unset defers to a wrapping Field. */
+    disabled?: boolean | undefined;
+    /** Shows the span without allowing an edit: the field stays a Tab stop and stays submitted, and the calendar button is dropped because nothing in the calendar could be chosen. Unset defers to a wrapping Field. */
+    readonly?: boolean | undefined;
+    /** Error state: paints the destructive border and ring, and sets `aria-invalid`. An instant outside `min`/`max`, or an end before its start, does the same on its own whatever this says. Unset defers to a wrapping Field's `error`. */
+    invalid?: boolean | undefined;
+    /** Marks the field mandatory to assistive tech (`aria-required` on the group holding both halves). Unset defers to a wrapping Field. */
+    required?: boolean | undefined;
+    /** The field name for a native form post or `FormData`. Reka submits the whole span through one hidden input, as `start - end`. Unset defers to a wrapping Field. */
+    name?: string;
+    /**
+     * Names for everything this control says out loud, as any subset of
+     * `DateTimeRangePickerLabels` — the rest stay as the host's
+     * `provideLoomLabels` vocabulary left them, and then as Loom's English.
+     *
+     * This is the per-instance correction, not the place to localise an
+     * application: eleven of the eighteen names replace English literals Reka UI
+     * writes of its own accord, and a language is set once with
+     * `provideLoomLabels`.
+     */
+    labels?: LabelOverrides<DateTimeRangePickerLabels>;
+}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: DateTimeRange) => any;
+}, string, import("vue").PublicProps, Readonly<{
+    /**
+     * The chosen span, as `{ start, end }` ISO `"YYYY-MM-DDTHH:mm"` strings —
+     * `"…:ss"` when `granularity` asks for seconds. Either half may be absent:
+     * `{}` is nothing chosen, `{ start }` is a range half made. A bare
+     * `"YYYY-MM-DD"` is accepted in either half and read as midnight that day.
+     * The explicit `| undefined` is what lets `v-model` bind a ref that clears.
+     */
+    modelValue?: DateTimeRange | undefined;
+    /** The earliest choosable instant, same format. The calendar disables every day that lies wholly before it; a time before it on the boundary day is announced invalid rather than refused. */
+    min?: string;
+    /** The latest choosable instant, same format. The calendar disables every day that lies wholly after it; a time after it on the boundary day is announced invalid rather than refused. */
+    max?: string;
+    /** How far down both halves of the field go. `"minute"` reports `"YYYY-MM-DDTHH:mm"`; `"second"` adds a seconds segment to each end and reports `"YYYY-MM-DDTHH:mm:ss"`. */
+    granularity?: "minute" | "second";
+    /** Whether both times read as 12-hour with an AM/PM segment or as 24-hour. Display only: the value stays 24-hour. Unset follows `locale`. */
+    hourCycle?: 12 | 24;
+    /** BCP 47 tag driving the order of the segments in both halves, the month and weekday names, which day a week starts on, and the 12-or-24-hour default. */
+    locale?: string;
+    /** How many months the calendar shows at once. Two is the default because a span is usually read across a month boundary; one is for a host that knows it is rendering into a narrow shell. */
+    months?: 1 | 2;
+    /** Unavailable: dims the control, refuses the calendar, and takes the field out of the tab order. Unset defers to a wrapping Field. */
+    disabled?: boolean | undefined;
+    /** Shows the span without allowing an edit: the field stays a Tab stop and stays submitted, and the calendar button is dropped because nothing in the calendar could be chosen. Unset defers to a wrapping Field. */
+    readonly?: boolean | undefined;
+    /** Error state: paints the destructive border and ring, and sets `aria-invalid`. An instant outside `min`/`max`, or an end before its start, does the same on its own whatever this says. Unset defers to a wrapping Field's `error`. */
+    invalid?: boolean | undefined;
+    /** Marks the field mandatory to assistive tech (`aria-required` on the group holding both halves). Unset defers to a wrapping Field. */
+    required?: boolean | undefined;
+    /** The field name for a native form post or `FormData`. Reka submits the whole span through one hidden input, as `start - end`. Unset defers to a wrapping Field. */
+    name?: string;
+    /**
+     * Names for everything this control says out loud, as any subset of
+     * `DateTimeRangePickerLabels` — the rest stay as the host's
+     * `provideLoomLabels` vocabulary left them, and then as Loom's English.
+     *
+     * This is the per-instance correction, not the place to localise an
+     * application: eleven of the eighteen names replace English literals Reka UI
+     * writes of its own accord, and a language is set once with
+     * `provideLoomLabels`.
+     */
+    labels?: LabelOverrides<DateTimeRangePickerLabels>;
+}> & Readonly<{
+    "onUpdate:modelValue"?: (value: DateTimeRange) => any;
+}>, {
+    locale: string;
+    disabled: boolean | undefined;
+    invalid: boolean | undefined;
+    readonly: boolean | undefined;
+    required: boolean | undefined;
+    months: 1 | 2;
+    granularity: "minute" | "second";
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+//# sourceMappingURL=DateTimeRangePicker.vue.d.ts.map

package/dist/primitives/DateTimeRangePicker/DateTimeRangePicker.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DateTimeRangePicker.vue.d.ts","sourceRoot":"","sources":["../../../src/primitives/DateTimeRangePicker/DateTimeRangePicker.vue"],"names":[],"mappings":"AA0iCA,OAAO,EAQL,KAAK,SAAS,EACf,MAAM,yBAAyB,CAAC;AAKjC,OAAO,EAAa,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAalE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EACV,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EAClB,MAAM,uBAAuB,CAAC;AAG/B;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,aAAa;IAC5B,qGAAqG;IACrG,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,6GAA6G;IAC7G,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,mBAAmB;IAClC,kMAAkM;IAClM,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,sDAAsD;IACtD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;QACvB,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,SAAS,GAAG,SAAS,CAAC;QAC7B,GAAG,EAAE,SAAS,GAAG,SAAS,CAAC;QAC3B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;QAC5B,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;QAC5B,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC,CAAC;CACJ;AA2CD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,mBAapC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,GACvD,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,GACf,mBAAmB,CAAC;wBACD,OAAO,YAAY;AAAxC,wBAAyC;AACzC,QAAA,MAAM,YAAY;IAiEd;;;;;;OAMG;iBACU,aAAa,GAAG,SAAS;IACtC,8LAA8L;UACxL,MAAM;IACZ,0LAA0L;UACpL,MAAM;IACZ,4KAA4K;kBAC9J,QAAQ,GAAG,QAAQ;IACjC,6IAA6I;gBACjI,EAAE,GAAG,EAAE;IACnB,2JAA2J;aAClJ,MAAM;IACf,+LAA+L;aACtL,CAAC,GAAG,CAAC;IACd,uIAAuI;eAC5H,OAAO,GAAG,SAAS;IAC9B,qNAAqN;eAC1M,OAAO,GAAG,SAAS;IAC9B,yOAAyO;cAC/N,OAAO,GAAG,SAAS;IAC7B,wIAAwI;eAC7H,OAAO,GAAG,SAAS;IAC9B,qKAAqK;WAC9J,MAAM;IACb;;;;;;;;;OASG;aACM,cAAc,CAAC,yBAAyB,CAAC;;;;IAxClD;;;;;;OAMG;iBACU,aAAa,GAAG,SAAS;IACtC,8LAA8L;UACxL,MAAM;IACZ,0LAA0L;UACpL,MAAM;IACZ,4KAA4K;kBAC9J,QAAQ,GAAG,QAAQ;IACjC,6IAA6I;gBACjI,EAAE,GAAG,EAAE;IACnB,2JAA2J;aAClJ,MAAM;IACf,+LAA+L;aACtL,CAAC,GAAG,CAAC;IACd,uIAAuI;eAC5H,OAAO,GAAG,SAAS;IAC9B,qNAAqN;eAC1M,OAAO,GAAG,SAAS;IAC9B,yOAAyO;cAC/N,OAAO,GAAG,SAAS;IAC7B,wIAAwI;eAC7H,OAAO,GAAG,SAAS;IAC9B,qKAAqK;WAC9J,MAAM;IACb;;;;;;;;;OASG;aACM,cAAc,CAAC,yBAAyB,CAAC;;;;YAvBzC,MAAM;cAIJ,OAAO,GAAG,SAAS;aAIpB,OAAO,GAAG,SAAS;cAFlB,OAAO,GAAG,SAAS;cAInB,OAAO,GAAG,SAAS;YARrB,CAAC,GAAG,CAAC;iBANA,QAAQ,GAAG,QAAQ;6EAqyCjC,CAAC"}