nuxt-ui-tools 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/dist/module.json +1 -1
  2. package/dist/module.mjs +8 -1
  3. package/dist/runtime/form/components/actions/form-actions.vue +13 -127
  4. package/dist/runtime/form/components/page/form-page-actions.d.vue.ts +3 -0
  5. package/dist/runtime/form/components/page/form-page-actions.vue +40 -0
  6. package/dist/runtime/form/components/page/form-page-actions.vue.d.ts +3 -0
  7. package/dist/runtime/form/components/page/form-page-header.d.vue.ts +24 -0
  8. package/dist/runtime/form/components/page/form-page-header.vue +99 -0
  9. package/dist/runtime/form/components/page/form-page-header.vue.d.ts +24 -0
  10. package/dist/runtime/form/components/page/form-page-navigation.d.vue.ts +34 -0
  11. package/dist/runtime/form/components/page/form-page-navigation.vue +229 -0
  12. package/dist/runtime/form/components/page/form-page-navigation.vue.d.ts +34 -0
  13. package/dist/runtime/form/components/page/form-page-section.d.vue.ts +19 -0
  14. package/dist/runtime/form/components/page/form-page-section.vue +114 -0
  15. package/dist/runtime/form/components/page/form-page-section.vue.d.ts +19 -0
  16. package/dist/runtime/form/components/page/form-page-sections.d.vue.ts +21 -0
  17. package/dist/runtime/form/components/page/form-page-sections.vue +75 -0
  18. package/dist/runtime/form/components/page/form-page-sections.vue.d.ts +21 -0
  19. package/dist/runtime/form/components/page/form-page.d.vue.ts +80 -0
  20. package/dist/runtime/form/components/page/form-page.vue +91 -0
  21. package/dist/runtime/form/components/page/form-page.vue.d.ts +80 -0
  22. package/dist/runtime/form/components/renderer/form-field-shell.vue +7 -11
  23. package/dist/runtime/form/components/root/form.vue +25 -194
  24. package/dist/runtime/form/composables/use-form-action-buttons.d.ts +32 -0
  25. package/dist/runtime/form/composables/use-form-action-buttons.js +89 -0
  26. package/dist/runtime/form/composables/use-form-actions.d.ts +8 -5
  27. package/dist/runtime/form/composables/use-form-actions.js +1 -1
  28. package/dist/runtime/form/composables/use-form-page-scroll.d.ts +22 -0
  29. package/dist/runtime/form/composables/use-form-page-scroll.js +178 -0
  30. package/dist/runtime/form/composables/use-form-page.d.ts +114 -0
  31. package/dist/runtime/form/composables/use-form-page.js +83 -0
  32. package/dist/runtime/form/composables/use-form-root.d.ts +34 -0
  33. package/dist/runtime/form/composables/use-form-root.js +171 -0
  34. package/dist/runtime/form/composables/use-form-runtime.js +13 -4
  35. package/dist/runtime/form/composables/use-form.js +2 -22
  36. package/dist/runtime/form/fields/checkbox-card/component.vue +28 -19
  37. package/dist/runtime/form/fields/checkbox-card/types.d.ts +2 -5
  38. package/dist/runtime/form/fields/choice-card/choice-card-label.d.vue.ts +17 -0
  39. package/dist/runtime/form/fields/choice-card/choice-card-label.vue +50 -0
  40. package/dist/runtime/form/fields/choice-card/choice-card-label.vue.d.ts +17 -0
  41. package/dist/runtime/form/fields/choice-card/types.d.ts +31 -0
  42. package/dist/runtime/form/fields/choice-card/types.js +0 -0
  43. package/dist/runtime/form/fields/choice-card/use-choice-card.d.ts +22 -0
  44. package/dist/runtime/form/fields/choice-card/use-choice-card.js +52 -0
  45. package/dist/runtime/form/fields/radio-card/component.vue +17 -18
  46. package/dist/runtime/form/fields/radio-card/types.d.ts +2 -4
  47. package/dist/runtime/form/index.d.ts +1 -1
  48. package/dist/runtime/form/index.js +7 -1
  49. package/dist/runtime/form/schema/index.d.ts +1 -1
  50. package/dist/runtime/form/schema/index.js +1 -0
  51. package/dist/runtime/form/schema/page.d.ts +50 -0
  52. package/dist/runtime/form/schema/page.js +25 -0
  53. package/dist/runtime/form/types/index.d.ts +1 -0
  54. package/dist/runtime/form/types/page.d.ts +172 -0
  55. package/dist/runtime/form/types/page.js +0 -0
  56. package/dist/runtime/form/types/ui.d.ts +60 -0
  57. package/dist/runtime/form/utils/controls.d.ts +15 -0
  58. package/dist/runtime/form/utils/controls.js +38 -0
  59. package/dist/runtime/form/utils/layout.js +3 -1
  60. package/dist/runtime/form/utils/page.d.ts +20 -0
  61. package/dist/runtime/form/utils/page.js +107 -0
  62. package/dist/runtime/form/utils/state.d.ts +2 -0
  63. package/dist/runtime/form/utils/state.js +1 -1
  64. package/dist/runtime/form/utils/ui.js +1 -0
  65. package/dist/runtime/i18n/locales/en.js +18 -0
  66. package/dist/runtime/i18n/locales/fr.js +18 -0
  67. package/dist/runtime/i18n/types.d.ts +29 -0
  68. package/package.json +1 -1
package/dist/module.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "configKey": "nuxtUiTools",
6
6
  "docs": "https://ui.nuxt.com/docs/getting-started/installation/nuxt",
7
7
  "name": "nuxt-ui-tools",
8
- "version": "1.3.0",
8
+ "version": "1.4.0",
9
9
  "builder": {
10
10
  "@nuxt/module-builder": "1.0.3",
11
11
  "unbuild": "unknown"
package/dist/module.mjs CHANGED
@@ -89,7 +89,12 @@ function getPublicComponents(runtimeDir, options) {
89
89
  filePath: `${runtimeDir}/form/components/provider/form-provider.vue`,
90
90
  global: options.global,
91
91
  name: `${prefix}FormProvider`
92
- }
92
+ },
93
+ ...["", "Header", "Navigation", "Sections", "Actions"].map((part) => ({
94
+ filePath: `${runtimeDir}/form/components/page/form-page${part ? `-${toKebabCase(part)}` : ""}.vue`,
95
+ global: options.global,
96
+ name: `${prefix}FormPage${part}`
97
+ }))
93
98
  ];
94
99
  }
95
100
  function toKebabCase(value) {
@@ -169,6 +174,8 @@ function setupImports(runtimeDir) {
169
174
  ...withRuntime(runtimeDir, [
170
175
  { from: "form", name: "defineFormField" },
171
176
  { from: "form", name: "defineFormFields" },
177
+ { from: "form", name: "defineFormPageSchema" },
178
+ { from: "form", name: "defineFormPageSection" },
172
179
  { from: "form", name: "defineFormSchema" },
173
180
  { from: "form", name: "useForm" },
174
181
  { from: "form", name: "useFormApi" }
@@ -1,11 +1,8 @@
1
1
  <script setup>
2
2
  import UButton from "@nuxt/ui/components/Button.vue";
3
3
  import { computed } from "vue";
4
- import { getResponsiveValue } from "../../../shared/composables/use-responsive-value";
4
+ import { useFormActionButtons } from "../../composables/use-form-action-buttons";
5
5
  import { useFormUi } from "../../composables/use-form-ui";
6
- import { createPublicFormApi } from "../../utils/api";
7
- import { invokeFormFunction, isString } from "../../utils/predicate";
8
- import { resolveFormText } from "../../utils/text";
9
6
  import { mergeFormUiClass } from "../../utils/ui";
10
7
  const props = defineProps({
11
8
  runtime: { type: Object, required: true },
@@ -13,117 +10,24 @@ const props = defineProps({
13
10
  });
14
11
  const formUi = useFormUi();
15
12
  const emit = defineEmits(["cancel"]);
16
- const actionContext = computed(() => ({
17
- actionPending: props.runtime.actionPending.value,
18
- api: createPublicFormApi(props.runtime),
19
- currentStep: props.runtime.currentStepIndex.value,
20
- isFirstStep: props.runtime.isFirstStep.value,
21
- isLastStep: props.runtime.isLastStep.value,
22
- isMultiStep: props.runtime.isStepped.value
23
- }));
24
- const visibleActions = computed(
25
- () => props.actions.filter((action) => action.condition?.(actionContext.value) ?? true)
26
- );
13
+ const buttons = useFormActionButtons({
14
+ actions: () => props.actions,
15
+ onCancel: () => emit("cancel"),
16
+ runtime: props.runtime
17
+ });
27
18
  const actionsLeft = computed(
28
- () => visibleActions.value.filter((action) => resolveActionSlot(action) === "left")
19
+ () => buttons.visible.value.filter((action) => buttons.slot(action) === "left")
29
20
  );
30
21
  const actionsRight = computed(
31
- () => visibleActions.value.filter((action) => resolveActionSlot(action) !== "left")
22
+ () => buttons.visible.value.filter((action) => buttons.slot(action) !== "left")
32
23
  );
33
- async function runAction(action) {
34
- if (isBuiltInAction(action, "submit")) {
35
- return;
36
- }
37
- if (isBuiltInAction(action, "next")) {
38
- await props.runtime.nextStep();
39
- return;
40
- }
41
- if (isBuiltInAction(action, "previous")) {
42
- await props.runtime.previousStep();
43
- return;
44
- }
45
- if (isBuiltInAction(action, "reset")) {
46
- await props.runtime.reset();
47
- return;
48
- }
49
- if (isBuiltInAction(action, "cancel")) {
50
- emit("cancel");
51
- return;
52
- }
53
- if ("action" in action) {
54
- await action.action?.(actionContext.value);
55
- }
56
- }
57
- function resolveActionLabel(action) {
58
- return resolveFormText(action.label);
59
- }
60
- function resolveActionSlot(action) {
61
- const slot = getResponsiveValue(action.slot ?? "right");
62
- return slot === "left" ? "left" : "right";
63
- }
64
- function resolveActionWidth(action) {
65
- const width = getResponsiveValue(action.width ?? "fit");
66
- return width === "fill" ? "fill" : "fit";
67
- }
68
- function resolveActionLink(action) {
69
- if (!("link" in action)) {
70
- return;
71
- }
72
- if (isString(action.link)) {
73
- return action.link;
74
- }
75
- const link = invokeFormFunction(action.link, [actionContext.value]);
76
- return isString(link) ? link : void 0;
77
- }
78
- function isActionDisabled(action) {
79
- const disabled = action.disabled?.(actionContext.value) ?? false;
80
- if (disabled) {
81
- return true;
82
- }
83
- if (!props.runtime.actionPending.value) {
84
- return false;
85
- }
86
- return !isActionLoading(action);
87
- }
88
- function isActionLoading(action) {
89
- if (!isBuiltInActionKey(action.key)) {
90
- return false;
91
- }
92
- const pending = props.runtime.actionPending.value;
93
- if (pending === null) {
94
- return false;
95
- }
96
- return action.key === pending;
97
- }
98
- function resolveActionColor(action) {
99
- if (action.color) {
100
- return action.color;
101
- }
102
- if (action.type === "primary") {
103
- return "primary";
104
- }
105
- }
106
- function resolveActionVariant(action) {
107
- if (action.variant) {
108
- return action.variant;
109
- }
110
- if (action.type === "primary") {
111
- return "solid";
112
- }
113
- }
114
24
  function actionButtonClass(action) {
115
25
  return mergeFormUiClass(
116
- resolveActionWidth(action) === "fill" ? "flex-1 justify-center" : void 0,
26
+ buttons.fills(action) ? "flex-1 justify-center" : void 0,
117
27
  formUi.ui.value.actions?.ui?.button,
118
28
  action.class
119
29
  );
120
30
  }
121
- function isBuiltInAction(action, key) {
122
- return action.key === key;
123
- }
124
- function isBuiltInActionKey(value) {
125
- return value === "reset" || value === "cancel" || value === "submit" || value === "previous" || value === "next";
126
- }
127
31
  </script>
128
32
 
129
33
  <template>
@@ -147,18 +51,9 @@ function isBuiltInActionKey(value) {
147
51
  <UButton
148
52
  v-for="(action, index) in actionsLeft"
149
53
  :key="action.key ?? index"
150
- :type="isBuiltInAction(action, 'submit') ? 'submit' : 'button'"
151
- :to="resolveActionLink(action)"
152
- :label="resolveActionLabel(action)"
153
- :icon="action.icon === false ? void 0 : action.icon"
154
- :trailing-icon="action.trailingIcon === false ? void 0 : action.trailingIcon"
155
- :color="resolveActionColor(action)"
156
- :variant="resolveActionVariant(action)"
157
- :size="action.size ?? formUi.controlSize.value"
54
+ v-bind="buttons.button(action)"
158
55
  :class="actionButtonClass(action)"
159
- :disabled="isActionDisabled(action)"
160
- :loading="isActionLoading(action)"
161
- @click="runAction(action)"
56
+ @click="buttons.run(action)"
162
57
  />
163
58
  </div>
164
59
 
@@ -174,18 +69,9 @@ function isBuiltInActionKey(value) {
174
69
  <UButton
175
70
  v-for="(action, index) in actionsRight"
176
71
  :key="action.key ?? index"
177
- :type="isBuiltInAction(action, 'submit') ? 'submit' : 'button'"
178
- :to="resolveActionLink(action)"
179
- :label="resolveActionLabel(action)"
180
- :icon="action.icon === false ? void 0 : action.icon"
181
- :trailing-icon="action.trailingIcon === false ? void 0 : action.trailingIcon"
182
- :color="resolveActionColor(action)"
183
- :variant="resolveActionVariant(action)"
184
- :size="action.size ?? formUi.controlSize.value"
72
+ v-bind="buttons.button(action)"
185
73
  :class="actionButtonClass(action)"
186
- :disabled="isActionDisabled(action)"
187
- :loading="isActionLoading(action)"
188
- @click="runAction(action)"
74
+ @click="buttons.run(action)"
189
75
  />
190
76
  </div>
191
77
  </div>
@@ -0,0 +1,3 @@
1
+ declare const __VLS_export: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
2
+ declare const _default: typeof __VLS_export;
3
+ export default _default;
@@ -0,0 +1,40 @@
1
+ <script setup>
2
+ import UButton from "@nuxt/ui/components/Button.vue";
3
+ import { computed } from "vue";
4
+ import { useFormActionButtons } from "../../composables/use-form-action-buttons";
5
+ import { useFormActions } from "../../composables/use-form-actions";
6
+ import { useFormPageContext } from "../../composables/use-form-page";
7
+ import { useFormUi } from "../../composables/use-form-ui";
8
+ import { mergeFormUiClass } from "../../utils/ui";
9
+ const page = useFormPageContext();
10
+ const formUi = useFormUi();
11
+ const pageUi = computed(() => formUi.ui.value.page?.ui);
12
+ const actions = useFormActions({ runtime: page.root.runtime, slot: () => "right" });
13
+ const buttons = useFormActionButtons({
14
+ actions: () => actions.value,
15
+ onCancel: page.cancel,
16
+ runtime: page.root.runtime
17
+ });
18
+ function buttonClass(action) {
19
+ return mergeFormUiClass(
20
+ buttons.fills(action) ? "flex-1 justify-center" : void 0,
21
+ formUi.ui.value.actions?.ui?.button,
22
+ action.class
23
+ );
24
+ }
25
+ </script>
26
+
27
+ <template>
28
+ <div
29
+ :class="mergeFormUiClass('flex shrink-0 flex-wrap items-center gap-2', pageUi?.actions)"
30
+ data-form-page-actions
31
+ >
32
+ <UButton
33
+ v-for="(action, index) in buttons.visible.value"
34
+ :key="action.key ?? index"
35
+ v-bind="buttons.button(action)"
36
+ :class="buttonClass(action)"
37
+ @click="buttons.run(action)"
38
+ />
39
+ </div>
40
+ </template>
@@ -0,0 +1,3 @@
1
+ declare const __VLS_export: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
2
+ declare const _default: typeof __VLS_export;
3
+ export default _default;
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Header of a form page: the schema `header` (eyebrow, title, description), an unsaved-changes
3
+ * badge while a form with `controls.dirtyCheck` is modified, and the page actions. It stays
4
+ * pinned while the page scrolls on wide layouts, and sections scroll to just below it.
5
+ */
6
+ type __VLS_Slots = {
7
+ /** Before the heading, e.g. an avatar of the record. */
8
+ leading?: () => unknown;
9
+ eyebrow?: () => unknown;
10
+ title?: () => unknown;
11
+ /** Replaces the description, keeping the unsaved-changes badge after it. */
12
+ description?: () => unknown;
13
+ /** Replaces the page actions. */
14
+ actions?: () => unknown;
15
+ };
16
+ declare const __VLS_base: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
17
+ declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
18
+ declare const _default: typeof __VLS_export;
19
+ export default _default;
20
+ type __VLS_WithSlots<T, S> = T & {
21
+ new (): {
22
+ $slots: S;
23
+ };
24
+ };
@@ -0,0 +1,99 @@
1
+ <script setup>
2
+ import UBadge from "@nuxt/ui/components/Badge.vue";
3
+ import { useResizeObserver } from "@vueuse/core";
4
+ import { computed, onBeforeUnmount, useTemplateRef } from "vue";
5
+ import { useUiToolsLocale } from "../../../i18n/use-locale";
6
+ import { useFormPageContext } from "../../composables/use-form-page";
7
+ import { useFormUi } from "../../composables/use-form-ui";
8
+ import { getFormHeader } from "../../utils/overlay";
9
+ import { isRecord } from "../../utils/path";
10
+ import { resolveFormBoundaryText } from "../../utils/text";
11
+ import { mergeFormUiClass } from "../../utils/ui";
12
+ import FormPageActions from "./form-page-actions.vue";
13
+ defineSlots();
14
+ const page = useFormPageContext();
15
+ const formUi = useFormUi();
16
+ const { t } = useUiToolsLocale();
17
+ const pageUi = computed(() => formUi.ui.value.page?.ui);
18
+ const header = computed(() => getFormHeader(page.root.schema.value));
19
+ const eyebrow = computed(() => headerText(header.value, "eyebrow"));
20
+ const title = computed(() => headerText(header.value, "title"));
21
+ const description = computed(() => headerText(header.value, "description"));
22
+ const unsaved = computed(() => page.dirtyCheck.value && page.root.runtime.isDirty.value);
23
+ const element = useTemplateRef("element");
24
+ useResizeObserver(element, () => {
25
+ const node = element.value;
26
+ page.stickyOffset.value = node && getComputedStyle(node).position === "sticky" ? node.offsetHeight : 0;
27
+ });
28
+ onBeforeUnmount(() => {
29
+ page.stickyOffset.value = 0;
30
+ });
31
+ function headerText(config, key) {
32
+ return isRecord(config) ? resolveFormBoundaryText(config[key]) : void 0;
33
+ }
34
+ </script>
35
+
36
+ <template>
37
+ <header
38
+ ref="element"
39
+ :class="
40
+ mergeFormUiClass(
41
+ 'z-10 flex flex-col gap-3 border-b border-default bg-default px-4 py-4 @3xl/form-page:sticky @3xl/form-page:top-0 @3xl/form-page:flex-row @3xl/form-page:items-center @3xl/form-page:justify-between @3xl/form-page:gap-5 @3xl/form-page:px-7 @3xl/form-page:pt-[18px] @3xl/form-page:pb-4',
42
+ pageUi?.header
43
+ )
44
+ "
45
+ data-form-page-header
46
+ >
47
+ <div :class="mergeFormUiClass('flex min-w-0 items-center gap-3.5', pageUi?.headerContent)">
48
+ <slot name="leading" />
49
+ <div :class="mergeFormUiClass('grid min-w-0 gap-1.5', pageUi?.heading)">
50
+ <p
51
+ v-if="eyebrow || $slots.eyebrow"
52
+ :class="
53
+ mergeFormUiClass(
54
+ 'text-[11px] font-semibold tracking-[0.08em] text-dimmed uppercase',
55
+ pageUi?.eyebrow
56
+ )
57
+ "
58
+ >
59
+ <slot name="eyebrow">{{ eyebrow }}</slot>
60
+ </p>
61
+ <h1
62
+ v-if="title || $slots.title"
63
+ :class="
64
+ mergeFormUiClass(
65
+ 'm-0 truncate text-[22px] leading-[1.1] font-semibold tracking-[-0.025em] text-highlighted @3xl/form-page:text-[28px]',
66
+ pageUi?.title
67
+ )
68
+ "
69
+ >
70
+ <slot name="title">{{ title }}</slot>
71
+ </h1>
72
+ <div
73
+ v-if="description || unsaved || $slots.description"
74
+ :class="
75
+ mergeFormUiClass(
76
+ 'flex flex-wrap items-center gap-2.5 text-[13.5px] text-muted',
77
+ pageUi?.meta
78
+ )
79
+ "
80
+ >
81
+ <slot name="description">
82
+ <span v-if="description">{{ description }}</span>
83
+ </slot>
84
+ <UBadge
85
+ v-if="unsaved"
86
+ color="warning"
87
+ variant="soft"
88
+ :label="t('form.page.unsavedChanges')"
89
+ :class="pageUi?.unsaved"
90
+ data-form-page-unsaved
91
+ />
92
+ </div>
93
+ </div>
94
+ </div>
95
+ <slot name="actions">
96
+ <FormPageActions />
97
+ </slot>
98
+ </header>
99
+ </template>
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Header of a form page: the schema `header` (eyebrow, title, description), an unsaved-changes
3
+ * badge while a form with `controls.dirtyCheck` is modified, and the page actions. It stays
4
+ * pinned while the page scrolls on wide layouts, and sections scroll to just below it.
5
+ */
6
+ type __VLS_Slots = {
7
+ /** Before the heading, e.g. an avatar of the record. */
8
+ leading?: () => unknown;
9
+ eyebrow?: () => unknown;
10
+ title?: () => unknown;
11
+ /** Replaces the description, keeping the unsaved-changes badge after it. */
12
+ description?: () => unknown;
13
+ /** Replaces the page actions. */
14
+ actions?: () => unknown;
15
+ };
16
+ declare const __VLS_base: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
17
+ declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
18
+ declare const _default: typeof __VLS_export;
19
+ export default _default;
20
+ type __VLS_WithSlots<T, S> = T & {
21
+ new (): {
22
+ $slots: S;
23
+ };
24
+ };
@@ -0,0 +1,34 @@
1
+ import type { FormPageSectionState } from '../../types/index.js';
2
+ /**
3
+ * Navigation of a form page: one entry per visible section, following the section in view.
4
+ * An entry shows whether its section is complete, invalid, or still to fill, marks optional
5
+ * sections, and, with `controls.dirtyCheck`, a dot on modified sections. The footer sums up
6
+ * the sections left to complete, or the modified ones with dirty checking.
7
+ *
8
+ * From 768px of page width it is a pinned column; below, a row of chips that scrolls sideways.
9
+ */
10
+ type __VLS_Slots = {
11
+ /** Replaces the heading, which comes from the schema `navigation.title`. */
12
+ title?: () => unknown;
13
+ /** Replaces an entry. Call `select` to scroll to the section. */
14
+ item?: (props: {
15
+ section: FormPageSectionState;
16
+ active: boolean;
17
+ select: () => void;
18
+ }) => unknown;
19
+ /** Replaces the summary under the entries. */
20
+ footer?: (props: {
21
+ sections: readonly FormPageSectionState[];
22
+ remaining: number;
23
+ modified: number;
24
+ }) => unknown;
25
+ };
26
+ declare const __VLS_base: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
27
+ declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
28
+ declare const _default: typeof __VLS_export;
29
+ export default _default;
30
+ type __VLS_WithSlots<T, S> = T & {
31
+ new (): {
32
+ $slots: S;
33
+ };
34
+ };
@@ -0,0 +1,229 @@
1
+ <script setup>
2
+ import UIcon from "@nuxt/ui/components/Icon.vue";
3
+ import { computed, nextTick, useId, useTemplateRef, watch } from "vue";
4
+ import { useUiToolsLocale } from "../../../i18n/use-locale";
5
+ import { useFormPageContext } from "../../composables/use-form-page";
6
+ import { useFormUi } from "../../composables/use-form-ui";
7
+ import { mergeFormUiClass } from "../../utils/ui";
8
+ defineSlots();
9
+ const CHIP_ROW_INSET = 16;
10
+ const page = useFormPageContext();
11
+ const formUi = useFormUi();
12
+ const { code, t } = useUiToolsLocale();
13
+ const pageUi = computed(() => formUi.ui.value.page?.ui);
14
+ const titleId = useId();
15
+ const plurals = computed(() => new Intl.PluralRules(code.value));
16
+ const summary = computed(() => {
17
+ if (page.dirtyCheck.value) {
18
+ const count2 = page.modified.value;
19
+ if (!count2) {
20
+ return { text: t("form.page.unmodified") };
21
+ }
22
+ return sentence(count2, isOne(count2) ? "form.page.modifiedOne" : "form.page.modifiedOther");
23
+ }
24
+ const count = page.remaining.value;
25
+ return count ? sentence(count, "form.page.remaining") : { text: t("form.page.complete") };
26
+ });
27
+ function isOne(count) {
28
+ return plurals.value.select(count) === "one";
29
+ }
30
+ function sentence(count, message) {
31
+ const [before = "", after = ""] = t(message).split("{count}");
32
+ const phrase = t(isOne(count) ? "form.page.sectionsOne" : "form.page.sectionsOther", { count });
33
+ return { after, before, phrase };
34
+ }
35
+ function dirtyShown(section) {
36
+ return page.dirtyCheck.value && section.dirty;
37
+ }
38
+ function statusLabel(section) {
39
+ const status = t(`form.page.status.${section.status}`);
40
+ return dirtyShown(section) ? `${status}, ${t("form.page.unsavedChanges")}` : status;
41
+ }
42
+ const list = useTemplateRef("list");
43
+ watch(
44
+ () => page.active.value,
45
+ async (key) => {
46
+ await nextTick();
47
+ const row = list.value;
48
+ if (!row || !key || row.scrollWidth <= row.clientWidth) {
49
+ return;
50
+ }
51
+ const entry = [...row.children].find(
52
+ (child) => child.getAttribute("data-form-page-entry") === key
53
+ );
54
+ if (!entry) {
55
+ return;
56
+ }
57
+ const box = row.getBoundingClientRect();
58
+ const rect = entry.getBoundingClientRect();
59
+ const overflow = rect.left < box.left ? rect.left - box.left : Math.max(0, rect.right - box.right);
60
+ if (overflow) {
61
+ row.scrollBy?.({ behavior: "smooth", left: overflow + Math.sign(overflow) * CHIP_ROW_INSET });
62
+ }
63
+ }
64
+ );
65
+ function select(event, key) {
66
+ if (event.button !== 0 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) {
67
+ return;
68
+ }
69
+ event.preventDefault();
70
+ page.scrollTo(key, { focus: true });
71
+ }
72
+ </script>
73
+
74
+ <template>
75
+ <nav
76
+ :aria-labelledby="page.navigationTitle.value || $slots.title ? titleId : void 0"
77
+ :aria-label="page.navigationTitle.value || $slots.title ? void 0 : t('form.page.navigation')"
78
+ :class="
79
+ mergeFormUiClass(
80
+ 'flex min-w-0 flex-col gap-3.5 @3xl/form-page:sticky @3xl/form-page:top-[calc(var(--nut-form-page-header,0px)+var(--nut-form-page-gap,24px))]',
81
+ pageUi?.navigation
82
+ )
83
+ "
84
+ data-form-page-navigation
85
+ >
86
+ <div :class="mergeFormUiClass('flex min-w-0 flex-col gap-2', pageUi?.navigationGroup)">
87
+ <p
88
+ v-if="page.navigationTitle.value || $slots.title"
89
+ :id="titleId"
90
+ :class="
91
+ mergeFormUiClass(
92
+ 'hidden px-2.5 text-[11px] font-semibold tracking-[0.08em] text-dimmed uppercase @3xl/form-page:block',
93
+ pageUi?.navigationTitle
94
+ )
95
+ "
96
+ >
97
+ <slot name="title">{{ page.navigationTitle.value }}</slot>
98
+ </p>
99
+ <ul
100
+ ref="list"
101
+ role="list"
102
+ :class="
103
+ mergeFormUiClass(
104
+ 'm-0 flex list-none gap-1.5 overflow-x-auto p-0 [scrollbar-width:none] @3xl/form-page:flex-col @3xl/form-page:gap-0.5 @3xl/form-page:overflow-visible',
105
+ pageUi?.navigationList
106
+ )
107
+ "
108
+ >
109
+ <li
110
+ v-for="section in page.sections.value"
111
+ :key="section.key"
112
+ :data-form-page-entry="section.key"
113
+ :class="mergeFormUiClass('shrink-0 @3xl/form-page:shrink', pageUi?.navigationEntry)"
114
+ >
115
+ <slot
116
+ name="item"
117
+ :section
118
+ :active="section.key === page.active.value"
119
+ :select="() => page.scrollTo(section.key, { focus: true })"
120
+ >
121
+ <a
122
+ :href="`#${section.key}`"
123
+ :aria-current="section.key === page.active.value ? 'location' : void 0"
124
+ :data-active="section.key === page.active.value || void 0"
125
+ :data-state="section.status"
126
+ :data-dirty="dirtyShown(section) || void 0"
127
+ :class="
128
+ mergeFormUiClass(
129
+ 'group flex h-8 min-w-0 items-center gap-2 rounded-md border border-default bg-default px-2.5 text-[12.5px] font-medium text-muted no-underline transition-colors hover:text-highlighted focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-primary data-[active]:border-primary data-[active]:bg-primary/10 data-[active]:text-highlighted @3xl/form-page:h-9 @3xl/form-page:gap-2.5 @3xl/form-page:rounded-[7px] @3xl/form-page:border-transparent @3xl/form-page:bg-transparent @3xl/form-page:text-[13.5px] @3xl/form-page:hover:bg-elevated @3xl/form-page:data-[active]:border-transparent @3xl/form-page:data-[active]:bg-default @3xl/form-page:data-[active]:font-semibold @3xl/form-page:data-[active]:shadow-[inset_2px_0_0_var(--ui-primary)]',
130
+ pageUi?.navigationItem
131
+ )
132
+ "
133
+ @click="select($event, section.key)"
134
+ >
135
+ <span
136
+ :data-state="section.status"
137
+ aria-hidden="true"
138
+ :class="
139
+ mergeFormUiClass(
140
+ 'grid size-4 shrink-0 place-items-center rounded-full border-[1.5px] border-accented text-[10px] leading-none font-bold group-data-[active]:border-primary data-[state=complete]:border-(--ui-text-highlighted) data-[state=complete]:bg-(--ui-text-highlighted) data-[state=complete]:text-(--ui-bg) data-[state=invalid]:border-error data-[state=invalid]:bg-error data-[state=invalid]:text-inverted group-data-[active]:data-[state=complete]:border-primary group-data-[active]:data-[state=complete]:bg-primary group-data-[active]:data-[state=complete]:text-inverted',
141
+ pageUi?.navigationIndicator
142
+ )
143
+ "
144
+ >
145
+ <UIcon
146
+ v-if="section.status === 'complete'"
147
+ name="i-lucide-check"
148
+ :class="mergeFormUiClass('size-2.5', pageUi?.navigationIndicatorIcon)"
149
+ />
150
+ <template v-else-if="section.status === 'invalid'">!</template>
151
+ <span
152
+ v-else
153
+ :class="
154
+ mergeFormUiClass(
155
+ 'hidden size-1.5 rounded-full bg-primary group-data-[active]:block',
156
+ pageUi?.navigationIndicatorMarker
157
+ )
158
+ "
159
+ />
160
+ </span>
161
+ <span
162
+ :class="
163
+ mergeFormUiClass(
164
+ 'whitespace-nowrap @3xl/form-page:min-w-0 @3xl/form-page:flex-1 @3xl/form-page:truncate',
165
+ pageUi?.navigationLabel
166
+ )
167
+ "
168
+ >
169
+ {{ section.label }}
170
+ </span>
171
+ <span class="sr-only">{{ statusLabel(section) }}</span>
172
+ <span
173
+ v-if="dirtyShown(section)"
174
+ aria-hidden="true"
175
+ :class="
176
+ mergeFormUiClass(
177
+ 'size-1.5 shrink-0 rounded-full bg-primary',
178
+ pageUi?.navigationDirty
179
+ )
180
+ "
181
+ data-form-page-dirty
182
+ />
183
+ <span
184
+ v-else-if="section.optional && section.status !== 'complete'"
185
+ :class="
186
+ mergeFormUiClass(
187
+ 'hidden shrink-0 text-[11px] font-normal text-dimmed @3xl/form-page:inline',
188
+ pageUi?.navigationOptional
189
+ )
190
+ "
191
+ >
192
+ {{ t("form.page.optional") }}
193
+ </span>
194
+ </a>
195
+ </slot>
196
+ </li>
197
+ </ul>
198
+ </div>
199
+ <div :class="mergeFormUiClass('hidden px-2.5 @3xl/form-page:block', pageUi?.navigationFooter)">
200
+ <div
201
+ :class="
202
+ mergeFormUiClass(
203
+ 'border-t border-muted pt-3.5 text-[12.5px] leading-normal text-muted',
204
+ pageUi?.navigationSummary
205
+ )
206
+ "
207
+ data-form-page-summary
208
+ >
209
+ <slot
210
+ name="footer"
211
+ :sections="page.sections.value"
212
+ :remaining="page.remaining.value"
213
+ :modified="page.modified.value"
214
+ >
215
+ <template v-if="'phrase' in summary">
216
+ {{ summary.before
217
+ }}<b
218
+ :class="
219
+ mergeFormUiClass('font-semibold text-highlighted', pageUi?.navigationSummaryCount)
220
+ "
221
+ >{{ summary.phrase }}</b
222
+ >{{ summary.after }}
223
+ </template>
224
+ <template v-else>{{ summary.text }}</template>
225
+ </slot>
226
+ </div>
227
+ </div>
228
+ </nav>
229
+ </template>