@lofid/vue 0.0.0-stage → 1.1.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.
package/README.md CHANGED
@@ -1,3 +1,131 @@
1
- # Temporary Holding Version
1
+ # @lofid/vue
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Vue 3 wrappers for every element in `@lofid/web`: all 51 `lof-*` custom elements,
4
+ companions included (`LofTabItem`, `LofMenuItem`, `LofResizablePanel`, …). They work with Vue 3.5+,
5
+ support `v-model`, and they server-render (Nuxt included).
6
+
7
+ The wrappers are **generated from the web package's source** (`scripts/generate.mjs`), so their
8
+ props, events and event detail types can't drift from the components. `npm run build` fails if
9
+ `src/generated.ts` is stale.
10
+
11
+ ```bash
12
+ npm install @lofid/vue @lofid/web
13
+ ```
14
+
15
+ ## Setup
16
+
17
+ Load the tokens once, then register the elements on the client.
18
+
19
+ ```ts
20
+ // main.ts (Vite)
21
+ import "@lofid/web/vars.css";
22
+ import "@lofid/web"; // defines lof-* and lof-icon
23
+ ```
24
+
25
+ In Nuxt (or any SSR setup), register the elements in a client-only plugin. The wrappers never import
26
+ the web package themselves, so they're safe in server-rendered trees:
27
+
28
+ ```ts
29
+ // plugins/lds.client.ts
30
+ import { defineElements } from "@lofid/vue";
31
+
32
+ export default defineNuxtPlugin(() => {
33
+ defineElements();
34
+ });
35
+ ```
36
+
37
+ The wrappers render plain `<lof-*>` tags from render functions, so you don't need
38
+ `compilerOptions.isCustomElement` in your Vite or Nuxt config.
39
+
40
+ ## Usage
41
+
42
+ ```vue
43
+ <script setup lang="ts">
44
+ import { ref } from "vue";
45
+ import { LofButton, LofCheckbox, LofSelect, LofTextfield } from "@lofid/vue";
46
+
47
+ const name = ref("");
48
+ const countries = ref<string[]>([]);
49
+ const terms = ref(false);
50
+ </script>
51
+
52
+ <template>
53
+ <form>
54
+ <LofTextfield v-model="name" label="Name" size="small" />
55
+ <LofSelect
56
+ v-model="countries"
57
+ label="Countries"
58
+ multiple
59
+ :options="[{ label: 'India', value: 'in' }, { label: 'Nepal', value: 'np' }]"
60
+ />
61
+ <LofCheckbox v-model="terms" label="I accept the terms" />
62
+ <LofButton variant="primary" @click="save">Save</LofButton>
63
+ </form>
64
+ </template>
65
+ ```
66
+
67
+ - **Props** are the element's own properties, typed from its class: `variant`, `options`,
68
+ `selectedValues` and so on, in camelCase or kebab-case (`:selected-values`). Arrays, objects and
69
+ functions are assigned as properties. Strings, numbers and `true` booleans are also rendered as
70
+ attributes, so server-rendered HTML carries them. A bare boolean (`multiple`) means `true`, and
71
+ `:full-width="false"` overrides a default of `true`.
72
+ - **Events** keep the element's event names: `@lof-change`, `@open-change`, `@changed`,
73
+ `@action-click`. The handler gets the `CustomEvent`, so read `event.detail`. A handler only fires
74
+ for events its own element dispatches, never for one bubbling up from a nested `lof-*` element.
75
+ - **HTML attributes and listeners** (`class`, `style`, `id`, `slot`, `aria-*`, `data-*`, `@click`, …)
76
+ fall through to the element.
77
+ - **Template refs** get the component. Its `el` (or `$el`) is the element itself. Each element type is
78
+ exported as `<Name>Element` (`LofSelectElement`, `LofModalElement`, …) for typing it.
79
+ - **Default slot** content is slotted into the element, exactly as in HTML. For a named slot, put
80
+ `slot="name"` on the child.
81
+
82
+ A prop that goes back to `undefined` returns the element to its default. Bound values are
83
+ re-applied whenever they change, so resetting the model resets the element.
84
+
85
+ ## v-model
86
+
87
+ Plain `v-model` binds each control's main value. `v-model:<prop>` binds any of the others listed:
88
+
89
+ | Component | `v-model` | Also `v-model:` |
90
+ | --- | --- | --- |
91
+ | `LofTextfield`, `LofOtp`, `LofCalendar`, `LofCarousel` | `value` | |
92
+ | `LofSlider` | `value` | `value-end` |
93
+ | `LofDatePicker`, `LofTimePicker` | `value` | `open` |
94
+ | `LofSelect` | `selected-values` with `multiple`, else `selected` | `selected`, `selected-values` |
95
+ | `LofAutocomplete` | `selected-values` with `multiple`, else `value` | `value`, `selected-values` |
96
+ | `LofCheckbox`, `LofSwitch` | `checked` | |
97
+ | `LofRadio` | `selected-value` | |
98
+ | `LofSegmentedButton` | `active` | |
99
+ | `LofTab` | `active-index` | |
100
+ | `LofPagination` | `page` | |
101
+ | `LofModal`, `LofDrawer`, `LofPopover`, `LofAccordion` | `open` | |
102
+ | `LofRangePicker` | | `from`, `to`, `open` |
103
+
104
+ Each one follows the element's change event (`lof-change`, `lof-open-change`, …), which still
105
+ reaches your own `@` listeners too. Since `LofSelect`'s and `LofAutocomplete`'s plain `v-model`
106
+ holds a string or an array depending on `multiple`, it is typed loosely. Use
107
+ `v-model:selected-values` for an exact `string[]`.
108
+
109
+ ## Global registration
110
+
111
+ Importing the components you use keeps bundles small. To register all of them at once:
112
+
113
+ ```ts
114
+ import { createApp } from "vue";
115
+ import { LofidDesign } from "@lofid/vue";
116
+
117
+ createApp(App).use(LofidDesign).mount("#app"); // also calls defineElements()
118
+ ```
119
+
120
+ ## Development
121
+
122
+ ```bash
123
+ npm run generate -w @lofid/vue # rewrite src/generated.ts from packages/web/src
124
+ npm run build -w @lofid/vue # check generated.ts is current, then bundle
125
+ npm test -w @lofid/vue # SSR tests + real-browser tests (Chrome or Edge)
126
+ ```
127
+
128
+ The element metadata comes from `packages/web/scripts/elements.mjs`, which the React wrappers use
129
+ too. The `v-model` table lives in `scripts/generate.mjs`, and the generator checks each binding's
130
+ property, event and detail key against the web source. The browser tests use `playwright-core`
131
+ with an installed Chrome or Edge; set `BROWSER_PATH` to use another Chromium.
@@ -0,0 +1,496 @@
1
+ import { DefineSetupFnComponent, HTMLAttributes, EmitsToProps, App } from 'vue';
2
+ import * as W from '@lofid/web';
3
+ export { LofAccordion as LofAccordionElement, LofAlert as LofAlertElement, LofAutocomplete as LofAutocompleteElement, LofAvatar as LofAvatarElement, LofAvatarGroup as LofAvatarGroupElement, LofBadge as LofBadgeElement, LofBreadcrumbs as LofBreadcrumbsElement, LofButton as LofButtonElement, LofCalendar as LofCalendarElement, LofCard as LofCardElement, LofCardMedia as LofCardMediaElement, LofCarousel as LofCarouselElement, LofCheckbox as LofCheckboxElement, LofChip as LofChipElement, LofContainer as LofContainerElement, LofDatePicker as LofDatePickerElement, LofDivider as LofDividerElement, LofDrawer as LofDrawerElement, LofDrawerFooter as LofDrawerFooterElement, LofEmptyState as LofEmptyStateElement, LofImageInput as LofImageInputElement, LofKbd as LofKbdElement, LofKbdGroup as LofKbdGroupElement, LofLayout as LofLayoutElement, LofLink as LofLinkElement, LofMenu as LofMenuElement, LofMenuItem as LofMenuItemElement, LofMenubar as LofMenubarElement, LofMenubarMenu as LofMenubarMenuElement, LofModal as LofModalElement, LofNav as LofNavElement, LofOtp as LofOtpElement, LofPageHeader as LofPageHeaderElement, LofPagination as LofPaginationElement, LofPopoverContent as LofPopoverContentElement, LofPopover as LofPopoverElement, LofProgress as LofProgressElement, LofRadio as LofRadioElement, LofRangePicker as LofRangePickerElement, LofRating as LofRatingElement, LofResizableGroup as LofResizableGroupElement, LofResizableHandle as LofResizableHandleElement, LofResizablePanel as LofResizablePanelElement, LofSegmentedButton as LofSegmentedButtonElement, LofSelect as LofSelectElement, LofSignaturePad as LofSignaturePadElement, LofSkeleton as LofSkeletonElement, LofSlider as LofSliderElement, LofSnackbar as LofSnackbarElement, LofSplitButton as LofSplitButtonElement, LofStat as LofStatElement, LofStepper as LofStepperElement, LofSwitch as LofSwitchElement, LofTab as LofTabElement, LofTabItem as LofTabItemElement, LofTable as LofTableElement, LofTextfield as LofTextfieldElement, LofTimePicker as LofTimePickerElement, LofToast as LofToastElement, LofTooltip as LofTooltipElement, LofTree as LofTreeElement, LofUploadActions as LofUploadActionsElement, LofUpload as LofUploadElement } from '@lofid/web';
4
+
5
+ /**
6
+ * How a property also renders as an attribute: `"attr"` for strings and numbers,
7
+ * `"?attr"` for booleans (present only when `true`), `null` for property-only
8
+ * values such as arrays, objects and functions.
9
+ */
10
+ type AttributeSpec = string | null;
11
+ /** A `v-model` binding: `[property, event, detail key]`, where `""` means the detail itself. */
12
+ type ModelBinding<P extends string = string, Ev extends string = string> = readonly [prop: P, event: Ev, key: string];
13
+ /** What the generator knows about one element (see `scripts/generate.mjs`). */
14
+ interface ElementSpec<P extends string, Ev extends string> {
15
+ /** Every public property, with how it renders as an attribute. */
16
+ props: {
17
+ readonly [K in P]: AttributeSpec;
18
+ };
19
+ /** Properties typed `boolean`, so `<LofSelect multiple>` in a template means `true`. */
20
+ booleans: readonly P[];
21
+ /** Every event the element dispatches. */
22
+ events: readonly Ev[];
23
+ /** The property plain `v-model` binds; a pair is `[when multiple, otherwise]`. */
24
+ model?: P | readonly [multiple: P, single: P];
25
+ /** The properties `v-model:<prop>` can bind, and the event that reports each. */
26
+ bindings?: readonly ModelBinding<P, Ev>[];
27
+ }
28
+ type IsUnion<T, U = T> = T extends unknown ? ([U] extends [T] ? false : true) : never;
29
+ /**
30
+ * The value plain `v-model` reports. When the model property depends on
31
+ * `multiple` (lof-select: `string[]` or `string`), it can't be known from the
32
+ * types, so it is left open and `v-model` works with either kind of ref.
33
+ */
34
+ type ModelValue<E, M extends keyof E> = true extends IsUnion<M> ? any : E[M];
35
+ /** Props of a wrapper: the element's public properties, typed from the element class, plus `modelValue`. */
36
+ type LofProps<E extends HTMLElement, P extends keyof E, M extends keyof E> = {
37
+ [K in P]?: E[K];
38
+ } & ([M] extends [never] ? {} : {
39
+ modelValue?: ModelValue<E, M>;
40
+ });
41
+ /**
42
+ * Emits of a wrapper: each element event, passed through as the `CustomEvent`
43
+ * itself, then `update:<prop>` for every `v-model:<prop>` and `update:modelValue`.
44
+ */
45
+ type LofEmits<E extends HTMLElement, Events, M extends keyof E, U extends keyof E> = {
46
+ [K in keyof Events]: (event: Events[K]) => void;
47
+ } & {
48
+ [K in U & string as `update:${K}`]: (value: E[K]) => void;
49
+ } & ([M] extends [never] ? {} : {
50
+ "update:modelValue": (value: ModelValue<E, M>) => void;
51
+ });
52
+ /**
53
+ * A wrapper component. Besides its own props it accepts ordinary HTML attributes
54
+ * and listeners (`class`, `style`, `id`, `aria-*`, `@click`, …), which fall
55
+ * through to the element.
56
+ */
57
+ type LofComponent<E extends HTMLElement, P extends keyof E, Events, M extends keyof E = never, U extends keyof E = never> = DefineSetupFnComponent<LofProps<E, P, M> & Omit<HTMLAttributes, P | "modelValue" | keyof EmitsToProps<LofEmits<E, Events, M, U>>>, LofEmits<E, Events, M, U>>;
58
+ /**
59
+ * Builds a Vue component that renders `tag` and bridges what Vue's own custom
60
+ * element support leaves open:
61
+ *
62
+ * - **Properties.** Every prop is assigned to the element as a JS property after
63
+ * each render, before paint. Vue alone sets an attribute whenever the element
64
+ * isn't defined yet, which turns arrays into "[object Object]", and it can't
65
+ * tell `<lof-select multiple>` means `true`. A prop that goes back to
66
+ * `undefined` returns the element to its default.
67
+ * - **Attributes.** Strings, numbers and `true` booleans are also rendered under
68
+ * their attribute name, so server-rendered HTML carries them and the element
69
+ * looks right the moment it is defined, before Vue hydrates.
70
+ * - **Events.** Each event the element dispatches is a declared emit, so
71
+ * `@lof-change` gets the `CustomEvent`. Only events the element itself
72
+ * dispatches are emitted: the events bubble, so a `<LofSelect>` inside a
73
+ * `<LofTab>` would otherwise reach the tab's `@lof-change` with the select's detail.
74
+ * - **v-model.** `modelValue` and `v-model:<prop>` follow the element's change
75
+ * events, reading the new value from the event detail.
76
+ *
77
+ * Nothing here imports the web package, so wrappers render on the server as plain
78
+ * tags. Register the elements once on the client (see `defineElements`).
79
+ */
80
+ declare function createComponent<E extends HTMLElement, P extends keyof E & string, Events extends Record<string, Event>, M extends P = never, U extends P = never>(tag: string, spec: ElementSpec<P, keyof Events & string>): LofComponent<E, P, Events, M, U>;
81
+
82
+ /** Vue wrapper for `<lof-accordion>`. `v-model` binds `open`. */
83
+ declare const LofAccordion: LofComponent<W.LofAccordion, "appearance" | "contentType" | "disabled" | "open" | "size" | "title" | "type", {
84
+ "open-change": CustomEvent<boolean>;
85
+ }, "open", "open">;
86
+ /** Vue wrapper for `<lof-alert>`. */
87
+ declare const LofAlert: LofComponent<W.LofAlert, "appearance" | "type" | "dismissed" | "dismissible" | "message1" | "message2" | "tone" | "urlHref" | "urlText", {
88
+ dismiss: CustomEvent<undefined>;
89
+ }, never, never>;
90
+ /** Vue wrapper for `<lof-autocomplete>`. `v-model` binds `selectedValues` (multiple) or `value`. */
91
+ declare const LofAutocomplete: LofComponent<W.LofAutocomplete, "disabled" | "size" | "placeholder" | "clearable" | "debounceMs" | "displayField" | "error" | "errorMessage" | "fieldAriaLabel" | "fieldAriaLabelledby" | "filter" | "floatingLabel" | "fullWidth" | "helperText" | "items" | "label" | "labelStyle" | "loading" | "loadingText" | "maxSuggestions" | "minSearchLength" | "multiple" | "name" | "noResultsText" | "prefixIcon" | "readonly" | "required" | "searchFn" | "selectAllLabel" | "selectedValues" | "supportingField" | "value" | "valueField" | "variant", {
92
+ changed: CustomEvent<{
93
+ value: string;
94
+ item: W.AutocompleteItem;
95
+ } | {
96
+ value: string[];
97
+ item: null;
98
+ } | {
99
+ value: string;
100
+ item: null;
101
+ }>;
102
+ "lof-change": CustomEvent<string>;
103
+ "lof-clear": CustomEvent<undefined>;
104
+ "lof-search-error": CustomEvent<{
105
+ query: string;
106
+ error: unknown;
107
+ }>;
108
+ }, "selectedValues" | "value", "selectedValues" | "value">;
109
+ /** Vue wrapper for `<lof-avatar>`. */
110
+ declare const LofAvatar: LofComponent<W.LofAvatar, "size" | "type" | "color" | "variant" | "alt" | "badge" | "badgeIcon" | "badgeLabel" | "bg" | "icon" | "ring" | "src" | "text", {}, never, never>;
111
+ /** Vue wrapper for `<lof-avatar-group>`. */
112
+ declare const LofAvatarGroup: LofComponent<W.LofAvatarGroup, "size" | "label" | "max" | "overflowLabel" | "total", {}, never, never>;
113
+ /** Vue wrapper for `<lof-badge>`. */
114
+ declare const LofBadge: LofComponent<W.LofBadge, "number" | "size" | "ariaLabel" | "color" | "variant" | "live" | "suffix" | "textColor", {}, never, never>;
115
+ /** Vue wrapper for `<lof-breadcrumbs>`. */
116
+ declare const LofBreadcrumbs: LofComponent<W.LofBreadcrumbs, "ariaLabel" | "items", {}, never, never>;
117
+ /** Vue wrapper for `<lof-button>`. */
118
+ declare const LofButton: LofComponent<W.LofButton, "disabled" | "size" | "ariaLabel" | "tone" | "loading" | "variant" | "badge" | "badgeDot" | "border" | "iconOnly", {}, never, never>;
119
+ /** Vue wrapper for `<lof-calendar>`. `v-model` binds `value`. */
120
+ declare const LofCalendar: LofComponent<W.LofCalendar, "disabled" | "value" | "max" | "isDateDisabled" | "locale" | "min" | "weekStart", {
121
+ "lof-change": CustomEvent<{
122
+ value: string;
123
+ date: Date;
124
+ }>;
125
+ }, "value", "value">;
126
+ /** Vue wrapper for `<lof-card>`. */
127
+ declare const LofCard: LofComponent<W.LofCard, "type" | "description" | "flush" | "heading", {}, never, never>;
128
+ /** Vue wrapper for `<lof-card-media>`. */
129
+ declare const LofCardMedia: LofComponent<W.LofCardMedia, "title" | "imageAlt" | "imageSrc" | "subtitle", {}, never, never>;
130
+ /** Vue wrapper for `<lof-carousel>`. `v-model` binds `value`. */
131
+ declare const LofCarousel: LofComponent<W.LofCarousel, "disabled" | "type" | "label" | "value" | "autoplay" | "gap" | "interval" | "loop" | "orientation" | "panels" | "pauseOnHover" | "showButtons" | "showDots", {
132
+ "lof-change": CustomEvent<{
133
+ value: number;
134
+ }>;
135
+ }, "value", "value">;
136
+ /** Vue wrapper for `<lof-checkbox>`. `v-model` binds `checked`. */
137
+ declare const LofCheckbox: LofComponent<W.LofCheckbox, "disabled" | "size" | "fieldAriaLabel" | "label" | "value" | "icon" | "alignment" | "checked" | "density" | "state" | "status" | "supportingtext" | "supportingText", {
138
+ "lof-change": CustomEvent<{
139
+ checked: boolean;
140
+ value: string;
141
+ }>;
142
+ }, "checked", "checked">;
143
+ /** Vue wrapper for `<lof-chip>`. */
144
+ declare const LofChip: LofComponent<W.LofChip, "size" | "tone" | "fieldAriaLabel" | "label" | "variant" | "border" | "avatar" | "draggableChip" | "leadingIcon" | "presentational" | "removable" | "removed" | "trailingIcon", {
145
+ "chip-move": CustomEvent<{
146
+ direction: number;
147
+ }>;
148
+ removed: CustomEvent<undefined>;
149
+ }, never, never>;
150
+ /** Vue wrapper for `<lof-container>`. */
151
+ declare const LofContainer: LofComponent<W.LofContainer, "background" | "padding" | "shadow" | "surface", {}, never, never>;
152
+ /** Vue wrapper for `<lof-date-picker>`. `v-model` binds `value`. */
153
+ declare const LofDatePicker: LofComponent<W.LofDatePicker, "disabled" | "open" | "size" | "placeholder" | "clearable" | "error" | "errorMessage" | "fullWidth" | "helperText" | "label" | "name" | "readonly" | "required" | "value" | "variant" | "max" | "isDateDisabled" | "locale" | "min" | "weekStart" | "closeOnSelect" | "displayFormat" | "formatDate" | "maxDate" | "minDate" | "showShortcuts", {
154
+ "lof-blur": CustomEvent<undefined>;
155
+ "lof-change": CustomEvent<{
156
+ value: string | null;
157
+ date: Date;
158
+ } | {
159
+ value: null;
160
+ date: null;
161
+ }>;
162
+ "lof-open-change": CustomEvent<{
163
+ open: boolean;
164
+ }>;
165
+ }, "value", "open" | "value">;
166
+ /** Vue wrapper for `<lof-divider>`. */
167
+ declare const LofDivider: LofComponent<W.LofDivider, "orientation", {}, never, never>;
168
+ /** Vue wrapper for `<lof-drawer>`. `v-model` binds `open`. */
169
+ declare const LofDrawer: LofComponent<W.LofDrawer, "open" | "title" | "draggable" | "dismissible" | "description" | "closeOnBackdrop" | "closeOnEscape" | "maxHeight" | "modal" | "showHandle" | "side" | "snapThreshold" | "width", {
170
+ "lof-open-change": CustomEvent<{
171
+ open: boolean;
172
+ }>;
173
+ }, "open", "open">;
174
+ /** Vue wrapper for `<lof-drawer-footer>`. */
175
+ declare const LofDrawerFooter: LofComponent<W.LofDrawerFooter, never, {}, never, never>;
176
+ /** Vue wrapper for `<lof-empty-state>`. */
177
+ declare const LofEmptyState: LofComponent<W.LofEmptyState, "size" | "icon" | "description" | "heading" | "align" | "headingLevel", {}, never, never>;
178
+ /** Vue wrapper for `<lof-image-input>`. */
179
+ declare const LofImageInput: LofComponent<W.LofImageInput, "disabled" | "size" | "fieldAriaLabel" | "name" | "src" | "accept" | "maxSize" | "noRemove" | "shape", {
180
+ "lof-change": CustomEvent<W.ImageInputChangeDetail>;
181
+ "lof-error": CustomEvent<{
182
+ reason: string;
183
+ file: File;
184
+ }>;
185
+ "lof-remove": CustomEvent<undefined>;
186
+ }, never, never>;
187
+ /** Vue wrapper for `<lof-kbd>`. */
188
+ declare const LofKbd: LofComponent<W.LofKbd, "size" | "variant" | "inset" | "keyName" | "pill" | "platform", {}, never, never>;
189
+ /** Vue wrapper for `<lof-kbd-group>`. */
190
+ declare const LofKbdGroup: LofComponent<W.LofKbdGroup, "size" | "items" | "variant" | "platform", {}, never, never>;
191
+ /** Vue wrapper for `<lof-layout>`. */
192
+ declare const LofLayout: LofComponent<W.LofLayout, "gap" | "columns" | "responsive", {}, never, never>;
193
+ /** Vue wrapper for `<lof-link>`. */
194
+ declare const LofLink: LofComponent<W.LofLink, "disabled" | "size" | "tone" | "arrow" | "href" | "inherit" | "rel" | "target" | "underline", {}, never, never>;
195
+ /** Vue wrapper for `<lof-menu>`. */
196
+ declare const LofMenu: LofComponent<W.LofMenu, "size" | "type" | "items" | "width", {
197
+ "lof-check": CustomEvent<{
198
+ item: {
199
+ checked: boolean;
200
+ label: string;
201
+ active?: boolean;
202
+ disabled?: boolean;
203
+ submenu?: W.MenuItem[];
204
+ open?: boolean;
205
+ icon?: string;
206
+ };
207
+ checked: boolean;
208
+ }>;
209
+ "lof-select": CustomEvent<{
210
+ item: W.MenuItem;
211
+ }>;
212
+ "lof-submenu-select": CustomEvent<{
213
+ parent: W.MenuItem;
214
+ sub: W.MenuItem | undefined;
215
+ }>;
216
+ }, never, never>;
217
+ /** Vue wrapper for `<lof-menu-item>`. */
218
+ declare const LofMenuItem: LofComponent<W.LofMenuItem, "disabled" | "label" | "value" | "icon", {}, never, never>;
219
+ /** Vue wrapper for `<lof-menubar>`. */
220
+ declare const LofMenubar: LofComponent<W.LofMenubar, "type" | "bindShortcuts", {
221
+ "lof-menubar-change": CustomEvent<W.MenubarChangeDetail>;
222
+ "lof-menubar-select": CustomEvent<W.MenubarSelectDetail | {
223
+ label: string;
224
+ value: string | undefined;
225
+ shortcut: string | undefined;
226
+ }>;
227
+ }, never, never>;
228
+ /** Vue wrapper for `<lof-menubar-menu>`. */
229
+ declare const LofMenubarMenu: LofComponent<W.LofMenubarMenu, "disabled" | "label", {}, never, never>;
230
+ /** Vue wrapper for `<lof-modal>`. `v-model` binds `open`. */
231
+ declare const LofModal: LofComponent<W.LofModal, "disabled" | "open" | "size" | "title" | "dismissible" | "loading" | "variant" | "description" | "subtitle" | "closeOnEscape" | "modal" | "side" | "autoFocus" | "breakpoint" | "closeOnBackdropClick" | "restoreFocus" | "scrollable" | "showCloseButton" | "zIndex", {
232
+ "lof-open-change": CustomEvent<boolean>;
233
+ }, "open", "open">;
234
+ /** Vue wrapper for `<lof-nav>`. */
235
+ declare const LofNav: LofComponent<W.LofNav, "fieldAriaLabel" | "items" | "value" | "collapsed" | "indicator", {
236
+ "lof-select": CustomEvent<W.NavSelectDetail>;
237
+ "lof-toggle": CustomEvent<{
238
+ value: string;
239
+ open: boolean;
240
+ }>;
241
+ }, never, never>;
242
+ /** Vue wrapper for `<lof-otp>`. `v-model` binds `value`. */
243
+ declare const LofOtp: LofComponent<W.LofOtp, "disabled" | "size" | "type" | "ariaLabel" | "inputMode" | "placeholder" | "inputmode" | "name" | "readonly" | "required" | "value" | "autocomplete" | "groupSize" | "invalid" | "length" | "mask" | "pattern" | "showSeparator", {
244
+ "lof-change": CustomEvent<{
245
+ value: string;
246
+ complete: boolean;
247
+ }>;
248
+ "lof-complete": CustomEvent<{
249
+ value: string;
250
+ }>;
251
+ }, "value", "value">;
252
+ /** Vue wrapper for `<lof-page-header>`. */
253
+ declare const LofPageHeader: LofComponent<W.LofPageHeader, "description" | "heading" | "headingLevel" | "divider" | "layout", {}, never, never>;
254
+ /** Vue wrapper for `<lof-pagination>`. `v-model` binds `page`. */
255
+ declare const LofPagination: LofComponent<W.LofPagination, "disabled" | "type" | "ariaLabel" | "defaultPage" | "hrefTemplate" | "page" | "perPage" | "rowsPerPageLabel" | "rowsPerPageOptions" | "showLabel" | "showRowsPerPage" | "totalItems" | "totalPages", {
256
+ "lof-change": CustomEvent<{
257
+ page: number;
258
+ }>;
259
+ "lof-per-page-change": CustomEvent<{
260
+ perPage: number;
261
+ }>;
262
+ }, "page", "page">;
263
+ /** Vue wrapper for `<lof-popover>`. `v-model` binds `open`. */
264
+ declare const LofPopover: LofComponent<W.LofPopover, "disabled" | "open" | "closeOnEscape" | "side" | "align" | "arrow" | "alignOffset" | "closeOnOutsideClick" | "defaultOpen" | "hasPopup" | "sideOffset" | "trapFocus", {
265
+ "lof-open-change": CustomEvent<{
266
+ open: boolean;
267
+ }>;
268
+ }, "open", "open">;
269
+ /** Vue wrapper for `<lof-popover-content>`. */
270
+ declare const LofPopoverContent: LofComponent<W.LofPopoverContent, "size" | "ariaLabel", {}, never, never>;
271
+ /** Vue wrapper for `<lof-progress>`. */
272
+ declare const LofProgress: LofComponent<W.LofProgress, "label" | "value" | "mode", {}, never, never>;
273
+ /** Vue wrapper for `<lof-radio>`. `v-model` binds `selectedValue`. */
274
+ declare const LofRadio: LofComponent<W.LofRadio, "disabled" | "size" | "error" | "errorMessage" | "fieldAriaLabel" | "name" | "value" | "orientation" | "alignment" | "density" | "options" | "selectedValue", {
275
+ "lof-change": CustomEvent<{
276
+ value: string;
277
+ checked: true;
278
+ }>;
279
+ }, "selectedValue", "selectedValue">;
280
+ /** Vue wrapper for `<lof-range-picker>`. */
281
+ declare const LofRangePicker: LofComponent<W.LofRangePicker, "disabled" | "open" | "size" | "placeholder" | "clearable" | "fullWidth" | "locale" | "weekStart" | "maxDate" | "minDate" | "maxHeight" | "width" | "mode" | "from" | "height" | "maxWidth" | "minHeight" | "minWidth" | "to" | "triggerVariant", {
282
+ "lof-blur": CustomEvent<undefined>;
283
+ "lof-change": CustomEvent<{
284
+ from: string;
285
+ to: string;
286
+ label: string;
287
+ }>;
288
+ "lof-open-change": CustomEvent<{
289
+ open: true;
290
+ } | {
291
+ open: false;
292
+ }>;
293
+ }, never, "open" | "from" | "to">;
294
+ /** Vue wrapper for `<lof-rating>`. */
295
+ declare const LofRating: LofComponent<W.LofRating, "disabled" | "size" | "fieldAriaLabel" | "name" | "readonly" | "value" | "max" | "showValue" | "step", {
296
+ "lof-change": CustomEvent<W.RatingChangeDetail>;
297
+ }, never, never>;
298
+ /** Vue wrapper for `<lof-resizable-group>`. */
299
+ declare const LofResizableGroup: LofComponent<W.LofResizableGroup, "direction", {
300
+ "lof-resize": CustomEvent<{
301
+ direction: W.ResizableOrientation;
302
+ sizes: number[];
303
+ }>;
304
+ "lof-resize-end": CustomEvent<{
305
+ direction: W.ResizableOrientation;
306
+ sizes: number[];
307
+ }>;
308
+ }, never, never>;
309
+ /** Vue wrapper for `<lof-resizable-handle>`. */
310
+ declare const LofResizableHandle: LofComponent<W.LofResizableHandle, "orientation", {}, never, never>;
311
+ /** Vue wrapper for `<lof-resizable-panel>`. */
312
+ declare const LofResizablePanel: LofComponent<W.LofResizablePanel, "maxSize" | "defaultSize" | "minSize" | "panelLabel", {}, never, never>;
313
+ /** Vue wrapper for `<lof-segmented-button>`. `v-model` binds `active`. */
314
+ declare const LofSegmentedButton: LofComponent<W.LofSegmentedButton, "disabled" | "size" | "fieldAriaLabel" | "align" | "options" | "active", {
315
+ changed: CustomEvent<{
316
+ value: string;
317
+ }>;
318
+ "lof-change": CustomEvent<{
319
+ value: string;
320
+ }>;
321
+ }, "active", "active">;
322
+ /** Vue wrapper for `<lof-select>`. `v-model` binds `selectedValues` (multiple) or `selected`. */
323
+ declare const LofSelect: LofComponent<W.LofSelect, "size" | "placeholder" | "fieldAriaLabel" | "fieldAriaLabelledby" | "label" | "labelStyle" | "multiple" | "selectAllLabel" | "selectedValues" | "border" | "state" | "supportingText" | "options" | "leftIcon" | "maxVisibleChips" | "noSearch" | "rightIcon" | "searchPlaceholder" | "selected" | "supportingIcon", {
324
+ changed: CustomEvent<{
325
+ value: string | string[];
326
+ }>;
327
+ "lof-change": CustomEvent<{
328
+ value: string | string[];
329
+ }>;
330
+ }, "selectedValues" | "selected", "selectedValues" | "selected">;
331
+ /** Vue wrapper for `<lof-signature-pad>`. */
332
+ declare const LofSignaturePad: LofComponent<W.LofSignaturePad, "disabled" | "placeholder" | "error" | "errorMessage" | "fieldAriaLabel" | "helperText" | "label" | "name" | "readonly" | "required" | "value" | "mode" | "disabledText" | "strokes" | "typedName", {
333
+ "lof-begin": CustomEvent<{}>;
334
+ "lof-change": CustomEvent<W.SignaturePadChangeDetail>;
335
+ "lof-end": CustomEvent<{}>;
336
+ }, never, never>;
337
+ /** Vue wrapper for `<lof-skeleton>`. */
338
+ declare const LofSkeleton: LofComponent<W.LofSkeleton, "width" | "shape" | "height" | "animation" | "lines" | "loaded", {}, never, never>;
339
+ /** Vue wrapper for `<lof-slider>`. `v-model` binds `value`. */
340
+ declare const LofSlider: LofComponent<W.LofSlider, "disabled" | "size" | "type" | "fieldAriaLabel" | "value" | "max" | "min" | "step" | "showBubble" | "showTickLabels" | "showTicks" | "track" | "valueEnd", {
341
+ "lof-change": CustomEvent<{
342
+ value: number;
343
+ valueEnd: number;
344
+ } | {
345
+ value: number;
346
+ }>;
347
+ }, "value", "value" | "valueEnd">;
348
+ /** Vue wrapper for `<lof-snackbar>`. */
349
+ declare const LofSnackbar: LofComponent<W.LofSnackbar, "type" | "tone" | "variant" | "lines" | "action" | "duration" | "iconClose" | "longerAction" | "message" | "show", {
350
+ actionClick: CustomEvent<undefined>;
351
+ close: CustomEvent<undefined>;
352
+ }, never, never>;
353
+ /** Vue wrapper for `<lof-split-button>`. */
354
+ declare const LofSplitButton: LofComponent<W.LofSplitButton, "disabled" | "open" | "size" | "ariaLabel" | "tone" | "items" | "label" | "loading" | "variant" | "icon" | "iconOnly" | "menuLabel", {
355
+ "lof-open-change": CustomEvent<{
356
+ open: boolean;
357
+ }>;
358
+ "lof-select": CustomEvent<W.SplitButtonSelectDetail>;
359
+ }, never, never>;
360
+ /** Vue wrapper for `<lof-stat>`. */
361
+ declare const LofStat: LofComponent<W.LofStat, "appearance" | "size" | "label" | "value" | "change" | "changeLabel" | "trend", {}, never, never>;
362
+ /** Vue wrapper for `<lof-stepper>`. */
363
+ declare const LofStepper: LofComponent<W.LofStepper, "size" | "type" | "orientation" | "connector" | "labelPlacement" | "steps" | "textAlign", {
364
+ "lof-step-change": CustomEvent<{
365
+ index: number;
366
+ step: W.Step;
367
+ }>;
368
+ }, never, never>;
369
+ /** Vue wrapper for `<lof-switch>`. `v-model` binds `checked`. */
370
+ declare const LofSwitch: LofComponent<W.LofSwitch, "disabled" | "size" | "type" | "fieldAriaLabel" | "label" | "value" | "checked" | "labelPlacement", {
371
+ "lof-change": CustomEvent<{
372
+ checked: boolean;
373
+ value: string;
374
+ }>;
375
+ }, "checked", "checked">;
376
+ /** Vue wrapper for `<lof-tab>`. `v-model` binds `activeIndex`. */
377
+ declare const LofTab: LofComponent<W.LofTab, "size" | "orientation" | "activeIndex" | "iconPlacement" | "tabs", {
378
+ "lof-change": CustomEvent<number>;
379
+ "lof-tab-change": CustomEvent<number>;
380
+ }, "activeIndex", "activeIndex">;
381
+ /** Vue wrapper for `<lof-tab-item>`. */
382
+ declare const LofTabItem: LofComponent<W.LofTabItem, "disabled" | "label" | "value" | "badge" | "icon" | "badgeDot", {}, never, never>;
383
+ /** Vue wrapper for `<lof-table>`. */
384
+ declare const LofTable: LofComponent<W.LofTable, "appearance" | "fieldAriaLabel" | "loading" | "heading" | "density" | "columns" | "page" | "totalItems" | "selected" | "emptyText" | "grid" | "pageSize" | "pageSizeLabel" | "pageSizeOptions" | "pageSizeSuffix" | "rangeTemplate" | "rowKey" | "rows" | "selectable" | "serverSide" | "sortDirection" | "sortKey" | "stickyHeader", {
385
+ "lof-page-change": CustomEvent<W.TablePageDetail>;
386
+ "lof-selection-change": CustomEvent<W.TableSelectionDetail>;
387
+ "lof-sort": CustomEvent<W.TableSortDetail>;
388
+ }, never, never>;
389
+ /** Vue wrapper for `<lof-textfield>`. `v-model` binds `value`. */
390
+ declare const LofTextfield: LofComponent<W.LofTextfield, "disabled" | "size" | "type" | "placeholder" | "error" | "errorMessage" | "fieldAriaLabel" | "fieldAriaLabelledby" | "floatingLabel" | "fullWidth" | "helperText" | "label" | "labelStyle" | "name" | "prefixIcon" | "readonly" | "required" | "value" | "variant" | "state" | "supportingText" | "leftIcon" | "rightIcon" | "rows" | "clickableRightIcon" | "helperIcon" | "maxLength" | "multiline" | "prefixIconAriaLabel" | "prefixStyle" | "prefixText" | "rightIconAriaLabel" | "suffixDivider" | "suffixText", {
391
+ "lof-change": CustomEvent<string>;
392
+ "lof-right-icon-click": CustomEvent<undefined>;
393
+ }, "value", "value">;
394
+ /** Vue wrapper for `<lof-time-picker>`. `v-model` binds `value`. */
395
+ declare const LofTimePicker: LofComponent<W.LofTimePicker, "disabled" | "open" | "size" | "placeholder" | "clearable" | "error" | "errorMessage" | "fullWidth" | "helperText" | "label" | "name" | "readonly" | "required" | "value" | "variant" | "invalid" | "format" | "maxTime" | "minTime" | "minuteStep" | "seconds", {
396
+ "lof-blur": CustomEvent<undefined>;
397
+ "lof-change": CustomEvent<{
398
+ value: string | null;
399
+ }>;
400
+ "lof-focus": CustomEvent<undefined>;
401
+ "lof-open-change": CustomEvent<{
402
+ open: boolean;
403
+ }>;
404
+ }, "value", "open" | "value">;
405
+ /** Vue wrapper for `<lof-toast>`. */
406
+ declare const LofToast: LofComponent<W.LofToast, "size" | "type" | "dismissible" | "tone" | "duration" | "message" | "show" | "actionLabel" | "maxVisible" | "position", {
407
+ action: CustomEvent<undefined>;
408
+ dismissed: CustomEvent<undefined>;
409
+ }, never, never>;
410
+ /** Vue wrapper for `<lof-tooltip>`. */
411
+ declare const LofTooltip: LofComponent<W.LofTooltip, "type" | "tone" | "text" | "position" | "showTail", {}, never, never>;
412
+ /** Vue wrapper for `<lof-tree>`. */
413
+ declare const LofTree: LofComponent<W.LofTree, "fieldAriaLabel" | "items" | "selectedValues" | "selected" | "expandedValues" | "selection" | "showGuides", {
414
+ "lof-change": CustomEvent<{
415
+ value: string[];
416
+ } | {
417
+ value: string;
418
+ }>;
419
+ "lof-expanded-change": CustomEvent<{
420
+ value: string;
421
+ expanded: boolean;
422
+ }>;
423
+ "lof-load-children": CustomEvent<{
424
+ value: string;
425
+ }>;
426
+ }, never, never>;
427
+ /** Vue wrapper for `<lof-upload>`. */
428
+ declare const LofUpload: LofComponent<W.LofUpload, "disabled" | "multiple" | "accept" | "maxSize" | "browseLabel" | "concurrency" | "delayThreshold" | "dropzoneTitle" | "files" | "hint" | "maxFiles" | "uploader", {
429
+ "lof-cancel": CustomEvent<undefined>;
430
+ "lof-change": CustomEvent<{
431
+ files: W.UploadFile[];
432
+ }>;
433
+ "lof-complete": CustomEvent<{
434
+ succeeded: W.UploadFile[];
435
+ failed: W.UploadFile[];
436
+ }>;
437
+ "lof-file-complete": CustomEvent<{
438
+ id: string;
439
+ file: File;
440
+ }>;
441
+ "lof-file-error": CustomEvent<{
442
+ id: string;
443
+ file: File;
444
+ error: string;
445
+ }>;
446
+ "lof-file-replaced": CustomEvent<W.FileReplacedDetail>;
447
+ "lof-files-added": CustomEvent<{
448
+ added: W.UploadFile[];
449
+ rejected: W.UploadRejection[];
450
+ }>;
451
+ "lof-invalid": CustomEvent<{
452
+ rejected: W.UploadRejection[];
453
+ }>;
454
+ "lof-progress": CustomEvent<{
455
+ id: string;
456
+ progress: number;
457
+ loaded: number;
458
+ total: number;
459
+ }>;
460
+ "lof-remove": CustomEvent<{
461
+ id: string;
462
+ file: File | undefined;
463
+ }>;
464
+ "lof-retry": CustomEvent<{
465
+ files: W.UploadFile[];
466
+ }>;
467
+ "lof-state": CustomEvent<W.UploadState>;
468
+ "lof-upload": CustomEvent<{
469
+ files: W.UploadFile[];
470
+ }>;
471
+ "lof-upload-complete": CustomEvent<W.UploadCompleteDetail>;
472
+ }, never, never>;
473
+ /** Vue wrapper for `<lof-upload-actions>`. */
474
+ declare const LofUploadActions: LofComponent<W.LofUploadActions, "cancelLabel" | "for" | "noCancel", {
475
+ "lof-cancel": CustomEvent<undefined>;
476
+ }, never, never>;
477
+
478
+ /** Every tag these wrappers render. */
479
+ declare const WRAPPED_TAGS: readonly ["lof-accordion", "lof-alert", "lof-autocomplete", "lof-avatar", "lof-avatar-group", "lof-badge", "lof-breadcrumbs", "lof-button", "lof-calendar", "lof-card", "lof-card-media", "lof-carousel", "lof-checkbox", "lof-chip", "lof-container", "lof-date-picker", "lof-divider", "lof-drawer", "lof-drawer-footer", "lof-empty-state", "lof-image-input", "lof-kbd", "lof-kbd-group", "lof-layout", "lof-link", "lof-menu", "lof-menu-item", "lof-menubar", "lof-menubar-menu", "lof-modal", "lof-nav", "lof-otp", "lof-page-header", "lof-pagination", "lof-popover", "lof-popover-content", "lof-progress", "lof-radio", "lof-range-picker", "lof-rating", "lof-resizable-group", "lof-resizable-handle", "lof-resizable-panel", "lof-segmented-button", "lof-select", "lof-signature-pad", "lof-skeleton", "lof-slider", "lof-snackbar", "lof-split-button", "lof-stat", "lof-stepper", "lof-switch", "lof-tab", "lof-tab-item", "lof-table", "lof-textfield", "lof-time-picker", "lof-toast", "lof-tooltip", "lof-tree", "lof-upload", "lof-upload-actions"];
480
+
481
+ /**
482
+ * Registers every lof-* element (and lof-icon) by loading @lofid/web.
483
+ * Safe to call from anywhere and any number of times; it does nothing on the
484
+ * server. Bundled SPAs can import "@lofid/web" at their entry instead.
485
+ */
486
+ declare function defineElements(): Promise<void>;
487
+ /**
488
+ * Optional plugin: `app.use(LofidDesign)` registers every wrapper globally
489
+ * (`<LofButton>`, `<LofSelect>`, …) and the elements themselves on the client.
490
+ * Importing only the components you use keeps the bundle smaller.
491
+ */
492
+ declare const LofidDesign: {
493
+ install(app: App): void;
494
+ };
495
+
496
+ export { type AttributeSpec, type ElementSpec, LofAccordion, LofAlert, LofAutocomplete, LofAvatar, LofAvatarGroup, LofBadge, LofBreadcrumbs, LofButton, LofCalendar, LofCard, LofCardMedia, LofCarousel, LofCheckbox, LofChip, type LofComponent, LofContainer, LofDatePicker, LofDivider, LofDrawer, LofDrawerFooter, type LofEmits, LofEmptyState, LofImageInput, LofKbd, LofKbdGroup, LofLayout, LofLink, LofMenu, LofMenuItem, LofMenubar, LofMenubarMenu, LofModal, LofNav, LofOtp, LofPageHeader, LofPagination, LofPopover, LofPopoverContent, LofProgress, type LofProps, LofRadio, LofRangePicker, LofRating, LofResizableGroup, LofResizableHandle, LofResizablePanel, LofSegmentedButton, LofSelect, LofSignaturePad, LofSkeleton, LofSlider, LofSnackbar, LofSplitButton, LofStat, LofStepper, LofSwitch, LofTab, LofTabItem, LofTable, LofTextfield, LofTimePicker, LofToast, LofTooltip, LofTree, LofUpload, LofUploadActions, LofidDesign, type ModelBinding, WRAPPED_TAGS, createComponent, defineElements };