@oods/components-vue 0.4.0 → 0.4.2

package/README.md

@@ -34,4 +34,4 @@ Use matching versions of the OODS packages. These packages are separate from the
 
 ## License
 
-Apache License 2.0. See [LICENSE](https://cdn.jsdelivr.net/npm/@oods/components-vue@0.4.0/LICENSE) and [NOTICE](https://cdn.jsdelivr.net/npm/@oods/components-vue@0.4.0/NOTICE). Generated output belongs to its user; installed package dependencies retain their own licenses.
+Apache License 2.0. See [LICENSE](https://cdn.jsdelivr.net/npm/@oods/components-vue@0.4.2/LICENSE) and [NOTICE](https://cdn.jsdelivr.net/npm/@oods/components-vue@0.4.2/NOTICE). Generated output belongs to its user; installed package dependencies retain their own licenses.

package/dist/index.cjs

@@ -187,6 +187,31 @@ var Button = vue.defineComponent({
   }
 });
 var canShowModal = () => typeof HTMLDialogElement !== "undefined" && typeof HTMLDialogElement.prototype.showModal === "function";
+var pageLocks = 0;
+var pageStyle;
+function lockPageScroll() {
+  const page = document.documentElement;
+  if (pageLocks++ === 0) {
+    const scrollbar = window.innerWidth - page.clientWidth;
+    pageStyle = { overflow: page.style.overflow, paddingRight: page.style.paddingRight };
+    if (scrollbar > 0) page.style.paddingRight = `${parseFloat(getComputedStyle(page).paddingRight) + scrollbar}px`;
+    page.style.overflow = "hidden";
+  }
+  let held = true;
+  return () => {
+    if (!held) return;
+    held = false;
+    if (--pageLocks === 0 && pageStyle) {
+      page.style.overflow = pageStyle.overflow;
+      page.style.paddingRight = pageStyle.paddingRight;
+      pageStyle = void 0;
+    }
+  };
+}
+var outsideBox = (event, dialog) => {
+  const box = dialog.getBoundingClientRect();
+  return event.clientX < box.left || event.clientX > box.right || event.clientY < box.top || event.clientY > box.bottom;
+};
 var Dialog = vue.defineComponent({
   name: "OodsDialog",
   props: {
@@ -208,15 +233,24 @@ var Dialog = vue.defineComponent({
     const element = vue.ref(null);
     const mounted = vue.ref(false);
     const managed = vue.computed(() => props.modal && mounted.value && canShowModal());
+    let unlockScroll;
+    let pressedBackdrop = false;
+    const releaseScroll = () => {
+      unlockScroll?.();
+      unlockScroll = void 0;
+    };
     const sync = () => {
       const dialog = element.value;
       if (!dialog || !managed.value) return;
-      if (props.open && !dialog.open) dialog.showModal();
-      else if (!props.open && dialog.open) dialog.close();
+      if (props.open && !dialog.open) {
+        dialog.showModal();
+        unlockScroll ??= lockPageScroll();
+      } else if (!props.open && dialog.open) dialog.close();
     };
     vue.onMounted(() => {
       mounted.value = true;
     });
+    vue.onBeforeUnmount(releaseScroll);
     vue.watch([() => props.open, managed], sync, { flush: "post" });
     const requestClose = (event) => {
       event.preventDefault();
@@ -239,10 +273,23 @@ var Dialog = vue.defineComponent({
           if (event.key === "Escape" && !event.defaultPrevented) requestClose(event);
         },
         onCancel: requestClose,
-        // The browser closed it (a close request it would not let be cancelled) while open is still true. A close event
-        // from moving a mounted dialog into the top layer finds it open again, and is not reported.
+        // A close event from moving a mounted dialog into the top layer finds it open again, and is not reported. Any other
+        // close releases the page; when the browser closed it (a close request it would not let be cancelled) while open is
+        // still true, it is reported.
         onClose: () => {
-          if (props.open && !element.value?.open) emit("close");
+          if (element.value?.open) return;
+          releaseScroll();
+          if (props.open) emit("close");
+        },
+        onMousedown: (event) => {
+          pressedBackdrop = managed.value && event.target === event.currentTarget && outsideBox(event, event.currentTarget);
+        },
+        // s223-m02 (#2527 ruling 13b): a click on the backdrop emits close, as the close control does. A press that began
+        // inside the dialog (text selected and dragged out) is not a backdrop click.
+        onClick: (event) => {
+          const backdrop = pressedBackdrop && event.target === event.currentTarget && outsideBox(event, event.currentTarget);
+          pressedBackdrop = false;
+          if (backdrop) emit("close");
         }
       }, [
         vue.h("div", { class: "oods-dialog__header" }, [
@@ -805,12 +852,15 @@ function createBadgeFamily(options) {
   };
   for (const key of options.extraProps) props[key] = String;
   for (const key of options.booleanProps ?? []) props[key] = { type: [String, Boolean], default: void 0 };
+  if (options.booleanProps) props.hideWhenFalse = { type: [Boolean, String], default: void 0 };
   return vue.defineComponent({
     name: `Oods${options.component}`,
     props,
     setup(componentProps, { slots }) {
       return () => {
         const record = componentProps;
+        const flag = options.booleanProps?.map((key) => record[key]).find((value) => typeof value === "boolean");
+        if (record.hideWhenFalse === true && flag === false) return null;
         const content = authoredContent(slots.default?.());
         const scalar = scalarContent(content);
         const read = (key) => typeof record[key] === "boolean" && options.booleanProps?.includes(key) ? String(record[key]) : record[key];
@@ -1437,12 +1487,13 @@ var TagSummary = vue.defineComponent({
 });
 var OwnershipMeta = vue.defineComponent({
   name: "OodsOwnershipMeta",
-  props: { title: String, label: String, heading: String, name: String, ownerType: String, owner_type: String, role: String, ownershipRole: String },
+  props: { title: String, label: String, heading: String, name: String, ownerType: String, owner_type: String, role: String, ownershipRole: String, ownerLabel: String },
   setup(props, { slots }) {
     return () => {
       const content = authoredContent(slots.default?.());
       const terms = [["Owner Type", firstScalar(props.ownerType, props.owner_type)], ["Role", firstScalar(props.role, props.ownershipRole)]].filter((entry) => entry[1] !== void 0);
-      return vue.h("div", { class: "oods-ownership-meta", "data-oods-component": "OwnershipMeta", "data-meta-type": "ownership" }, content.length ? content : [
+      const phrase = props.ownerLabel !== void 0 ? componentContracts.ownershipPhrase(props.ownerLabel, firstScalar(props.ownerType, props.owner_type), firstScalar(props.role, props.ownershipRole)) : void 0;
+      return vue.h("div", { class: "oods-ownership-meta", "data-oods-component": "OwnershipMeta", "data-meta-type": "ownership" }, content.length ? content : phrase ? [vue.h("span", { "data-meta-item": "true" }, phrase)] : [
         vue.h("span", { "data-meta-title": "true" }, firstText(props.title, props.label, props.heading, props.name) ?? "Ownership"),
         ...terms.map(([term, value]) => vue.h("span", { key: term, "data-meta-item": "true" }, [vue.h("strong", `${term}:`), ` ${value}`]))
       ]);
@@ -1472,11 +1523,14 @@ var CancellationBadge = createBadgeFamily({
   booleanLabels: ["Cancellation scheduled", "No cancellation scheduled"]
 });
 var ArchiveSummary = vue.defineComponent({
+  // s224-m01 (#2542 ruling 6): hideWhenDefault is Boolean first, as the badges' hideWhenFalse is: a generated template writes
+  // the bare attribute, which Vue casts to true only then.
   name: "OodsArchiveSummary",
-  props: { title: String, label: String, heading: String, name: String, isArchived: { type: [String, Boolean], default: void 0 }, archived: { type: [String, Boolean], default: void 0 }, status: { type: [String, Boolean], default: void 0 }, archivedAt: String, reason: String, archiveReason: String, summary: String, text: String, description: String },
+  props: { title: String, label: String, heading: String, name: String, isArchived: { type: [String, Boolean], default: void 0 }, archived: { type: [String, Boolean], default: void 0 }, status: { type: [String, Boolean], default: void 0 }, archivedAt: String, reason: String, archiveReason: String, summary: String, text: String, description: String, hideWhenDefault: { type: [Boolean, String], default: void 0 } },
   setup(props, { slots }) {
     return () => {
       const content = authoredContent(slots.default?.());
+      if (props.hideWhenDefault === true && (props.isArchived ?? props.archived ?? props.status) === false && !props.archivedAt && !firstText(props.reason, props.archiveReason) && !content.length) return null;
       const terms = [["Archived", componentContracts.summaryValue(props.isArchived ?? props.archived ?? props.status)], ["Archived At", props.archivedAt ? componentContracts.formatDateTime(props.archivedAt) : void 0], ["Reason", firstText(props.reason, props.archiveReason)]].filter((entry) => entry[1] !== void 0);
       const fallback = firstText(props.summary, props.text, props.description);
       return vue.h("section", { class: "oods-archive-summary", "data-oods-component": "ArchiveSummary", "data-summary-type": "archive" }, [
@@ -2132,13 +2186,16 @@ var Tabs = vue.defineComponent({
           onClick: () => selectTab(item.id),
           onKeydown: (event) => onTabKeydown(event, item.id)
         }, slots.itemLabel?.({ item, selected: item.id === activeId.value }) ?? [item.label])),
-        overflowItems.value.length > 0 ? vue.h("div", { class: "oods-tabs-overflow" }, [
+        // s224-m01 (#2542 ruling 2): the overflow markup is React's too: both class families, the trigger's data
+        // attribute and aria-current="true" on an item.
+        overflowItems.value.length > 0 ? vue.h("div", { class: "oods-tabs-overflow oods-tabs__overflow" }, [
           vue.h("button", {
             type: "button",
             class: "oods-tabs-overflow-trigger",
             "aria-label": `${props.overflowLabel} tabs`,
             "aria-haspopup": "menu",
             "aria-expanded": overflowOpen.value,
+            "data-tabs-overflow-trigger": "true",
             onClick: () => {
               overflowOpen.value = !overflowOpen.value;
             }
@@ -2148,7 +2205,7 @@ var Tabs = vue.defineComponent({
             type: "button",
             role: "menuitem",
             disabled: itemDisabled(item),
-            "aria-current": item.id === activeId.value ? "page" : void 0,
+            "aria-current": item.id === activeId.value ? "true" : void 0,
             onClick: () => {
               selectTab(item.id);
               overflowOpen.value = false;
@@ -2168,6 +2225,63 @@ var Tabs = vue.defineComponent({
     ]);
   }
 });
+var SegmentedControl = vue.defineComponent({
+  name: "OodsSegmentedControl",
+  props: {
+    id: String,
+    label: String,
+    modelValue: String,
+    value: String,
+    defaultValue: { type: String, default: "" },
+    name: String,
+    size: { type: String, default: "md" },
+    disabled: Boolean,
+    options: { type: Array, default: () => [] }
+  },
+  emits: {
+    "update:modelValue": (_value) => true,
+    change: (_value) => true
+  },
+  setup(props, { emit, slots }) {
+    const generatedId = vue.useId();
+    const internalValue = vue.ref(props.defaultValue);
+    const currentValue = vue.computed(() => props.modelValue ?? props.value ?? internalValue.value);
+    const select = (event) => {
+      const next = event.target.value;
+      if (props.modelValue === void 0 && props.value === void 0) internalValue.value = next;
+      emit("update:modelValue", next);
+      emit("change", next);
+    };
+    return () => {
+      const id = props.id || `oods-segmentedcontrol-${generatedId}`;
+      const label = slots.label?.() ?? props.label;
+      return vue.h("div", {
+        class: "oods-field oods-segmented-control",
+        "data-oods-component": "SegmentedControl",
+        "data-size": props.size
+      }, [
+        vue.h("span", { id: `${id}-label`, class: "oods-field-label" }, [label]),
+        vue.h("div", {
+          id,
+          role: "radiogroup",
+          "aria-labelledby": `${id}-label`,
+          class: "oods-segmented-control__track"
+        }, props.options.map((option) => vue.h("label", { key: option.value, class: "oods-segmented-control__option" }, [
+          vue.h("input", {
+            type: "radio",
+            class: "oods-segmented-control__input",
+            name: props.name || id,
+            value: option.value,
+            checked: option.value === currentValue.value,
+            disabled: props.disabled || option.disabled,
+            onChange: select
+          }),
+          vue.h("span", { class: "oods-segmented-control__label" }, option.label)
+        ])))
+      ]);
+    };
+  }
+});
 function isRecord2(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
@@ -2505,12 +2619,15 @@ var CancellationSummary = vue.defineComponent({
     cancelAtPeriodEndField: String,
     requestedAtField: String,
     reasonField: String,
-    codeField: String
+    codeField: String,
+    // s224-m01 (#2542 ruling 6): Boolean first, as the badges' hideWhenFalse is (a bare attribute casts to true).
+    hideWhenDefault: { type: [Boolean, String], default: void 0 }
   },
   setup(props, { attrs, slots }) {
     return () => {
       const slotValue = slotSummaryValue(slots);
       const cancellationValue = props.cancelAtPeriodEnd ?? slotValue;
+      if (props.hideWhenDefault === true && props.cancelAtPeriodEnd === false && !props.requestedAt && !props.reason && !props.code && slotValue === void 0) return null;
       const rows = [];
       if (cancellationValue !== void 0) {
         rows.push(summaryEntry(
@@ -2985,7 +3102,8 @@ var array = Array;
 function eventRecipe(id, kind, title) {
   return vue.defineComponent({ name: id, props: { id: String, title: { type: String, default: title }, archivedAt: String, restoredAt: String, archivedBy: String, reason: String, timestamp: String, code: String, history: array, status: String, showActor: { type: Boolean, default: true }, showReason: { type: Boolean, default: true } }, setup: (props) => () => {
     const rows = componentContracts.traitEventRows(kind, props);
-    return vue.h("article", { id: props.id, class: "oods-trait-recipe", "data-oods-component": id, "aria-label": props.title }, [vue.h("h2", props.title), rows.length ? vue.h("ol", rows.map((row, index) => vue.h("li", { key: index }, [vue.h("strong", row.title), vue.h("p", row.at ? vue.h("time", { datetime: row.at }, row.time) : row.time), row.actor && vue.h("p", `Actor: ${row.actor}`), row.reason && vue.h("p", `Reason: ${row.reason}`), row.code && vue.h("p", `Code: ${row.code}`)]))) : vue.h("p", "No events recorded.")]);
+    if (!rows.length) return null;
+    return vue.h("article", { id: props.id, class: "oods-trait-recipe", "data-oods-component": id, "aria-label": props.title }, [vue.h("h2", props.title), vue.h("ol", rows.map((row, index) => vue.h("li", { key: index }, [vue.h("strong", row.title), vue.h("p", row.at ? vue.h("time", { datetime: row.at }, row.time) : row.time), row.actor && vue.h("p", `Actor: ${row.actor}`), row.reason && vue.h("p", `Reason: ${row.reason}`), row.code && vue.h("p", `Code: ${row.code}`)])))]);
   } });
 }
 var ArchiveEvent = eventRecipe("ArchiveEvent", "archive", "Archive events");
@@ -3086,6 +3204,211 @@ var VizLinePreview = preview("VizLinePreview", "line");
 var VizMarkPreview = preview("VizMarkPreview", "bar");
 var VizPointPreview = preview("VizPointPreview", "scatter");
 var VizScatterPreview = preview("VizScatterPreview", "scatter");
+var Combobox = vue.defineComponent({
+  name: "OodsCombobox",
+  props: {
+    id: String,
+    label: String,
+    options: { type: Array, default: () => [] },
+    modelValue: String,
+    value: String,
+    defaultValue: { type: String, default: "" },
+    placeholder: String,
+    name: String,
+    required: Boolean,
+    disabled: Boolean,
+    help: String,
+    validation: Object,
+    /** The control height, as Button, Input and Select: xs 24, sm 28, md 32 (default) or lg 40. */
+    size: { type: String, default: "md" }
+  },
+  emits: {
+    "update:modelValue": (_value) => true,
+    change: (_value) => true
+  },
+  setup(props, { emit, slots }) {
+    const generatedId = vue.useId();
+    const controlId = vue.computed(() => props.id || `oods-combobox-${generatedId}`);
+    const internalValue = vue.ref(props.defaultValue);
+    const query = vue.ref(null);
+    const open = vue.ref(false);
+    const active = vue.ref(-1);
+    const root = vue.ref(null);
+    const listbox = vue.ref(null);
+    const chosenValue = vue.computed(() => props.modelValue ?? props.value ?? internalValue.value);
+    const chosen = vue.computed(() => props.options.find((option) => option.value === chosenValue.value));
+    const text = vue.computed(() => query.value ?? chosen.value?.label ?? "");
+    const matches = vue.computed(() => {
+      const needle = (query.value ?? "").trim().toLowerCase();
+      return props.options.map((option) => needle === "" || option.label.toLowerCase().includes(needle));
+    });
+    const reachable = vue.computed(() => props.options.flatMap((option, index) => matches.value[index] && !option.disabled ? [index] : []));
+    const optionId = (index) => `${controlId.value}-option-${index}`;
+    const close = () => {
+      open.value = false;
+      active.value = -1;
+    };
+    const commit = (next) => {
+      if (props.modelValue === void 0 && props.value === void 0) internalValue.value = next;
+      emit("update:modelValue", next);
+      emit("change", next);
+    };
+    const pick = (index) => {
+      const option = props.options[index];
+      if (!option || option.disabled) return;
+      query.value = null;
+      close();
+      if (option.value !== chosenValue.value) commit(option.value);
+    };
+    const outside = (event) => {
+      if (!root.value?.contains(event.target)) close();
+    };
+    vue.watch(open, (isOpen) => {
+      if (isOpen) document.addEventListener("pointerdown", outside);
+      else document.removeEventListener("pointerdown", outside);
+    });
+    vue.onBeforeUnmount(() => {
+      if (typeof document !== "undefined") document.removeEventListener("pointerdown", outside);
+    });
+    vue.watch([open, active], async () => {
+      if (!open.value || active.value < 0) return;
+      await vue.nextTick();
+      const element = listbox.value?.children[active.value];
+      element?.scrollIntoView?.({ block: "nearest" });
+    });
+    const keydown = (event) => {
+      if (event.defaultPrevented || props.disabled || event.isComposing) return;
+      const order = reachable.value;
+      const first = order[0] ?? -1;
+      const last = order[order.length - 1] ?? -1;
+      const at = order.indexOf(active.value);
+      switch (event.key) {
+        case "ArrowDown":
+          event.preventDefault();
+          active.value = !open.value || at === -1 ? first : order[(at + 1) % order.length];
+          open.value = true;
+          return;
+        case "ArrowUp":
+          event.preventDefault();
+          active.value = !open.value || at <= 0 ? last : order[at - 1];
+          open.value = true;
+          return;
+        case "Home":
+        case "End":
+          if (!open.value) return;
+          event.preventDefault();
+          active.value = event.key === "Home" ? first : last;
+          return;
+        case "Enter":
+          if (!open.value) return;
+          event.preventDefault();
+          if (active.value >= 0) pick(active.value);
+          return;
+        case "Escape":
+          if (open.value) {
+            event.preventDefault();
+            close();
+            return;
+          }
+          if (text.value === "" && chosenValue.value === "") return;
+          event.preventDefault();
+          query.value = null;
+          if (chosenValue.value !== "") commit("");
+          return;
+        case "Tab":
+          if (open.value) close();
+          return;
+      }
+    };
+    return () => {
+      const id = controlId.value;
+      const label = slots.label?.() ?? props.label;
+      const help = slots.help?.() ?? props.help;
+      const validation = slots.validation?.() ?? props.validation?.message;
+      const tone = props.validation ? props.validation.state === "error" ? "critical" : props.validation.state : void 0;
+      const describedBy = [help ? `${id}-help` : void 0, validation ? `${id}-validation` : void 0].filter(Boolean).join(" ") || void 0;
+      const noMatches = open.value && !matches.value.some(Boolean);
+      return vue.h("div", {
+        ref: root,
+        class: "oods-field oods-combobox",
+        ...tone ? { style: { "--cmp-input-message-border": `var(--sys-status-${tone}-border)`, "--cmp-input-message-text": `var(--sys-status-${tone}-text)` } } : {},
+        "data-oods-component": "Combobox",
+        "data-size": props.size,
+        "data-validation-state": props.validation?.state
+      }, [
+        vue.h("label", { id: `${id}-label`, class: "oods-field-label", for: id }, [
+          label,
+          props.required ? vue.h("span", { class: "oods-field-required", "aria-hidden": "true" }, "*") : null
+        ]),
+        vue.h("div", { class: "oods-combobox__control" }, [
+          vue.h("input", {
+            id,
+            type: "text",
+            role: "combobox",
+            class: "oods-field-control oods-combobox__input",
+            value: text.value,
+            placeholder: props.placeholder,
+            autocomplete: "off",
+            "aria-autocomplete": "list",
+            "aria-expanded": open.value ? "true" : "false",
+            "aria-controls": `${id}-listbox`,
+            "aria-activedescendant": open.value && active.value >= 0 ? optionId(active.value) : void 0,
+            "aria-describedby": describedBy,
+            "aria-invalid": props.validation?.state === "error" ? "true" : void 0,
+            required: props.required,
+            disabled: props.disabled,
+            onInput: (event) => {
+              query.value = event.target.value;
+              open.value = true;
+              active.value = -1;
+            },
+            onKeydown: keydown,
+            onClick: () => {
+              if (!props.disabled) open.value = true;
+            },
+            onBlur: () => {
+              query.value = null;
+              close();
+            }
+          }),
+          vue.h("span", { class: "oods-combobox__chevron", "aria-hidden": "true" }, [statusIcon("chevron-down")]),
+          vue.h("div", {
+            class: "oods-combobox__popup",
+            hidden: !open.value,
+            onMousedown: (event) => event.preventDefault()
+          }, [
+            vue.h(
+              "ul",
+              { ref: listbox, id: `${id}-listbox`, class: "oods-combobox__listbox", role: "listbox", "aria-labelledby": `${id}-label` },
+              props.options.map((option, index) => vue.h("li", {
+                key: option.value,
+                id: optionId(index),
+                class: "oods-combobox__option",
+                role: "option",
+                "aria-selected": option.value === chosenValue.value ? "true" : "false",
+                "aria-disabled": option.disabled ? "true" : void 0,
+                "data-value": option.value,
+                "data-active": index === active.value ? "true" : void 0,
+                hidden: !matches.value[index],
+                onClick: () => pick(index),
+                onPointermove: () => {
+                  if (!option.disabled && index !== active.value) active.value = index;
+                }
+              }, [
+                vue.h("span", { class: "oods-combobox__option-label" }, option.label),
+                vue.h("span", { class: "oods-combobox__check", "aria-hidden": "true" }, [statusIcon("check")])
+              ]))
+            ),
+            vue.h("p", { class: "oods-combobox__empty", role: "status" }, noMatches ? "No matches" : "")
+          ])
+        ]),
+        props.name ? vue.h("input", { type: "hidden", name: props.name, value: chosenValue.value }) : null,
+        help ? vue.h("p", { id: `${id}-help`, class: "oods-field-help" }, help) : null,
+        validation ? vue.h("p", { id: `${id}-validation`, class: "oods-field-error", role: props.validation?.state === "error" ? "alert" : void 0 }, validation) : null
+      ]);
+    };
+  }
+});
 
 exports.AddressCollectionPanel = AddressCollectionPanel;
 exports.AddressEditor = AddressEditor;
@@ -3118,6 +3441,7 @@ exports.ClassificationPanel = ClassificationPanel;
 exports.ColorStatePicker = ColorStatePicker;
 exports.ColorSwatch = ColorSwatch;
 exports.ColorizedBadge = ColorizedBadge;
+exports.Combobox = Combobox;
 exports.CommunicationDetailPanel = CommunicationDetailPanel;
 exports.CycleProgressCard = CycleProgressCard;
 exports.DatePicker = DatePicker;
@@ -3153,6 +3477,7 @@ exports.RelativeTimestamp = RelativeTimestamp;
 exports.RoleAssignmentForm = RoleAssignmentForm;
 exports.RoleBadgeList = RoleBadgeList;
 exports.SearchInput = SearchInput;
+exports.SegmentedControl = SegmentedControl;
 exports.Select = Select;
 exports.SortIndicator = SortIndicator;
 exports.Stack = Stack;