@fastkit/vui 0.8.17 → 0.9.0

package/dist/vui.d.ts

@@ -4,7 +4,7 @@ import { App } from 'vue';
 import { BoldOptions } from '@tiptap/extension-bold';
 import { BulletListOptions } from '@tiptap/extension-bullet-list';
 import { ChainedCommands } from '@tiptap/vue-3';
-import {  ColorVariant , ThemeName, PaletteName, ScopeName } from '@fastkit/color-scheme';
+import {  ColorVariant , ThemeName, PaletteName } from '@fastkit/color-scheme';
 import { ComponentCustomProps } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { ComputedRef } from 'vue';
@@ -36,7 +36,7 @@ import { FormSelectorItemGroupControl } from '@fastkit/vue-kit';
 import { FormSelectorValue } from '@fastkit/vue-kit';
 import { HistoryOptions } from '@tiptap/extension-history';
 import { HTMLAttributes } from 'vue';
-import {  ICON_NAMES , IconName } from '@fastkit/icon-font';
+import { ICON_NAMES } from '@fastkit/icon-font';
 import { IconName } from '@fastkit/icon-font';
 import { IMaskEvent } from '@fastkit/vue-kit';
 import { IMaskTypedValue } from '@fastkit/vue-kit';
@@ -48,7 +48,6 @@ import { LocationService } from '@fastkit/vue-utils';
 import { Mark } from '@tiptap/vue-3';
 import { MediaMatchKey } from '@fastkit/media-match';
 import { NavigationableInheritProps } from '@fastkit/vue-utils';
-import { NavigationFailure } from 'vue-router';
 import { Node as Node_2 } from '@tiptap/vue-3';
 import { Node as Node_3 } from 'prosemirror-model';
 import { Numberish } from '@fastkit/vue-kit';
@@ -59,18 +58,13 @@ import { RawFormSelectorItems } from '@fastkit/vue-kit';
 import { RawTextableFinishingProp } from '@fastkit/vue-kit';
 import { RawTextareaAutosizeSettings } from '@fastkit/vue-kit';
 import { Ref } from 'vue';
-import { RendererElement } from 'vue';
-import { RendererNode } from 'vue';
 import { RequiredChipSource } from '@fastkit/vue-kit';
 import { ResolvedFormSelectorGroup } from '@fastkit/vue-kit';
 import { ResolvedFormSelectorItem } from '@fastkit/vue-kit';
 import { ResolveRawSlots } from '@fastkit/vue-kit';
 import { ResolveRawSlots as ResolveRawSlots_2 } from '@fastkit/vue-utils';
-import { RouteLocation } from 'vue-router';
 import { RouteLocationRaw } from 'vue-router';
 import type { Router } from 'vue-router';
-import { RouterLink } from 'vue-router';
-import { RouterLinkProps } from 'vue-router';
 import { ScopeName } from '@fastkit/color-scheme';
 import { ShallowRef } from 'vue';
 import { StyleValue } from 'vue';
@@ -84,13 +78,13 @@ import { TypedSlot } from '@fastkit/vue-kit';
 import { UnderlineOptions } from '@tiptap/extension-underline';
 import { UnwrapNestedRefs } from 'vue';
 import { useLink } from 'vue-router';
+import { UseLinkOptions } from 'vue-router';
 import { ValidateTiming } from '@fastkit/vue-kit';
 import { ValidationResult } from '@fastkit/vue-kit';
 import { VDialog } from '@fastkit/vue-kit';
 import { VDialogProps } from '@fastkit/vue-kit';
 import { VMenu } from '@fastkit/vue-kit';
 import { VMenuControl } from '@fastkit/vue-stack';
-import { VNode } from 'vue';
 import { VNodeChild } from 'vue';
 import { VNodeChildOrSlot } from '@fastkit/vue-kit';
 import { VNodeChildOrSlot as VNodeChildOrSlot_2 } from '@fastkit/vue-utils';
@@ -135,6 +129,8 @@ export declare interface BusyImageRects {
 
 export declare type BusyImageSizeValue = number | string;
 
+export declare const BUTTON_ALIGNS: readonly ["left", "center", "right"];
+
 export declare const CHIP_SIZES: readonly ["xs", "sm", "md", "lg", "xl"];
 
 export declare type ChipSize = typeof CHIP_SIZES[number];
@@ -532,7 +528,7 @@ export declare function createListTileProps(): {
 };
 
 export declare function createNavigationItemProps(): {
-    match: StringConstructor;
+    match: PropType<string | string[]>;
     depth: {
         type: NumberConstructor;
         default: number;
@@ -574,6 +570,19 @@ export declare function createNavigationItemProps(): {
     onClick: PropType<(ev: MouseEvent) => any>;
 };
 
+export declare function createNavigationProps(): {
+    items: {
+        type: PropType<NavigationItemInput[]>;
+        required: true;
+    };
+    color: PropType<ScopeName>;
+    startIconEmptySpace: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    caption: PropType<VNodeChild | (() => VNodeChild)>;
+};
+
 export declare function createPaperBaseProps(): {
     'v-slots': PropType<ResolveRawSlots_2<{
         header: void;
@@ -990,7 +999,7 @@ declare function createTextFieldProps(): {
     hiddenInfo: BooleanConstructor;
     requiredChip: PropType<RequiredChipSource>;
     type: {
-        type: PropType<"number" | "search" | "email" | "tel" | "url" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time">;
+        type: PropType<"number" | "email" | "tel" | "url" | "search" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time">;
         default: string;
     };
     masked: StringConstructor;
@@ -1450,6 +1459,8 @@ export declare function mergeVuiServiceOptions(base: VuiServiceOptions, override
 
 export declare function mergeVuiServiceUISettings(base: VuiServiceUISettings, overrides?: RawVuiServiceUISettings): VuiServiceUISettings;
 
+export declare type NavigationInput = ExtractPropInput<ReturnType<typeof createNavigationProps>>;
+
 export declare interface NavigationItemInput extends ExtractPropInput<ReturnType<typeof createNavigationItemProps>> {
     key: string | number;
     label: VNodeChild | (() => VNodeChild);
@@ -2380,6 +2391,8 @@ export declare interface UseElevationOptions {
     defaultValue?: VuiElevationValue;
 }
 
+export declare type UseLinkResult = ReturnType<typeof useLink>;
+
 export declare function useVui(): VuiService;
 
 export declare function useVuiColorProvider(): VuiColorProvider;
@@ -2901,6 +2914,10 @@ export declare const VButton: DefineComponent<{
     icon: PropType<RawVButtonIcon>;
     startIcon: PropType<RawVButtonIcon>;
     endIcon: PropType<RawVButtonIcon>;
+    align: {
+        type: PropType<"left" | "right" | "center">;
+        default: string;
+    };
     tag: PropType<string>;
     class: PropType<any>;
     style: PropType<CSSProperties>;
@@ -2967,7 +2984,7 @@ export declare const VButton: DefineComponent<{
     results: PropType<(string | number) | undefined>;
     security: PropType<string | undefined>;
     unselectable: PropType<"on" | "off" | undefined>;
-    inputmode: PropType<"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined>;
+    inputmode: PropType<"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined>;
     is: PropType<string | undefined>;
     'aria-activedescendant': PropType<string | undefined>;
     'aria-atomic': PropType<(boolean | "true" | "false") | undefined>;
@@ -2982,7 +2999,7 @@ export declare const VButton: DefineComponent<{
     'aria-describedby': PropType<string | undefined>;
     'aria-details': PropType<string | undefined>;
     'aria-disabled': PropType<(boolean | "true" | "false") | undefined>;
-    'aria-dropeffect': PropType<"link" | "none" | "copy" | "execute" | "move" | "popup" | undefined>;
+    'aria-dropeffect': PropType<"none" | "copy" | "execute" | "link" | "move" | "popup" | undefined>;
     'aria-errormessage': PropType<string | undefined>;
     'aria-expanded': PropType<(boolean | "true" | "false") | undefined>;
     'aria-flowto': PropType<string | undefined>;
@@ -3109,6 +3126,10 @@ export declare const VButton: DefineComponent<{
     icon: PropType<RawVButtonIcon>;
     startIcon: PropType<RawVButtonIcon>;
     endIcon: PropType<RawVButtonIcon>;
+    align: {
+        type: PropType<"left" | "right" | "center">;
+        default: string;
+    };
     tag: PropType<string>;
     class: PropType<any>;
     style: PropType<CSSProperties>;
@@ -3175,7 +3196,7 @@ export declare const VButton: DefineComponent<{
     results: PropType<(string | number) | undefined>;
     security: PropType<string | undefined>;
     unselectable: PropType<"on" | "off" | undefined>;
-    inputmode: PropType<"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined>;
+    inputmode: PropType<"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined>;
     is: PropType<string | undefined>;
     'aria-activedescendant': PropType<string | undefined>;
     'aria-atomic': PropType<(boolean | "true" | "false") | undefined>;
@@ -3190,7 +3211,7 @@ export declare const VButton: DefineComponent<{
     'aria-describedby': PropType<string | undefined>;
     'aria-details': PropType<string | undefined>;
     'aria-disabled': PropType<(boolean | "true" | "false") | undefined>;
-    'aria-dropeffect': PropType<"link" | "none" | "copy" | "execute" | "move" | "popup" | undefined>;
+    'aria-dropeffect': PropType<"none" | "copy" | "execute" | "link" | "move" | "popup" | undefined>;
     'aria-errormessage': PropType<string | undefined>;
     'aria-expanded': PropType<(boolean | "true" | "false") | undefined>;
     'aria-flowto': PropType<string | undefined>;
@@ -3308,10 +3329,13 @@ export declare const VButton: DefineComponent<{
     onTransitionstart: PropType<((payload: TransitionEvent) => void) | undefined>;
 }>>, {
     rounded: boolean;
+    align: "left" | "right" | "center";
     loading: boolean;
     ariaCurrentValue: "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined;
 }>;
 
+export declare type VButtonAlign = typeof BUTTON_ALIGNS[number];
+
 export declare const VButtonGroup: DefineComponent<{
     disabled: BooleanConstructor;
     size: {
@@ -6292,7 +6316,7 @@ export declare const VNavigation: DefineComponent<{
 
 export declare const VNavigationItem: DefineComponent<{
     children: PropType<NavigationItemInput[]>;
-    match: StringConstructor;
+    match: PropType<string | string[]>;
     depth: {
         type: NumberConstructor;
         default: number;
@@ -6336,7 +6360,7 @@ export declare const VNavigationItem: DefineComponent<{
     changeActive: (isActive: boolean) => boolean;
 }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
     children: PropType<NavigationItemInput[]>;
-    match: StringConstructor;
+    match: PropType<string | string[]>;
     depth: {
         type: NumberConstructor;
         default: number;
@@ -7576,10 +7600,16 @@ export declare const VRadioGroup: DefineComponent<{
 }>;
 
 export declare const VSelect: DefineComponent<{
+    closeOnNavigation: BooleanConstructor;
     placeholder: StringConstructor;
     loadingMessage: PropType<VNodeChildOrSlot<any>>;
     failedToLoadItemsMessage: PropType<VNodeChildOrSlot<any>>;
-    'v-slots': PropType<ResolveRawSlots<FormControlSlots & InputBoxSlots>>;
+    'v-slots': PropType<ResolveRawSlots<FormControlSlots & InputBoxSlots & {
+        selection: {
+            item: FormSelectorItemControl;
+            index: number;
+        };
+    }>>;
     size: {
         type: PropType<"sm" | "md" | "lg">;
         validator: (value: any) => boolean;
@@ -7713,10 +7743,16 @@ export declare const VSelect: DefineComponent<{
     focus: (ev: FocusEvent) => boolean;
     blur: (ev: FocusEvent) => boolean;
 }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
+    closeOnNavigation: BooleanConstructor;
     placeholder: StringConstructor;
     loadingMessage: PropType<VNodeChildOrSlot<any>>;
     failedToLoadItemsMessage: PropType<VNodeChildOrSlot<any>>;
-    'v-slots': PropType<ResolveRawSlots<FormControlSlots & InputBoxSlots>>;
+    'v-slots': PropType<ResolveRawSlots<FormControlSlots & InputBoxSlots & {
+        selection: {
+            item: FormSelectorItemControl;
+            index: number;
+        };
+    }>>;
     size: {
         type: PropType<"sm" | "md" | "lg">;
         validator: (value: any) => boolean;
@@ -7813,6 +7849,7 @@ export declare const VSelect: DefineComponent<{
     hiddenInfo: boolean;
     errors: FormNodeError[];
     loading: boolean;
+    closeOnNavigation: boolean;
 }>;
 
 export declare const VSkeltonLoaderBone: DefineComponent<{
@@ -8554,7 +8591,7 @@ export declare const VTextField: DefineComponent<{
     hiddenInfo: BooleanConstructor;
     requiredChip: PropType<RequiredChipSource>;
     type: {
-        type: PropType<"number" | "search" | "email" | "tel" | "url" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time">;
+        type: PropType<"number" | "email" | "tel" | "url" | "search" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time">;
         default: string;
     };
     masked: StringConstructor;
@@ -8594,7 +8631,7 @@ export declare const VTextField: DefineComponent<{
     classes: ComputedRef<any>;
     textInputControl: TextInputControl;
     computedMask: ComputedRef<any>;
-    computedType: ComputedRef<"number" | "search" | "email" | "tel" | "url" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time">;
+    computedType: ComputedRef<"number" | "email" | "tel" | "url" | "search" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time">;
     inputElementRef: Ref<HTMLInputElement | null>;
     focus: (opts?: FocusOptions | undefined) => void;
     blur: () => void;
@@ -8688,7 +8725,7 @@ export declare const VTextField: DefineComponent<{
     hiddenInfo: BooleanConstructor;
     requiredChip: PropType<RequiredChipSource>;
     type: {
-        type: PropType<"number" | "search" | "email" | "tel" | "url" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time">;
+        type: PropType<"number" | "email" | "tel" | "url" | "search" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time">;
         default: string;
     };
     masked: StringConstructor;
@@ -8734,7 +8771,7 @@ export declare const VTextField: DefineComponent<{
     "onUpdate:errors"?: ((errors: FormNodeError[]) => any) | undefined;
     onFocus?: ((ev: FocusEvent) => any) | undefined;
 }, {
-    type: "number" | "search" | "email" | "tel" | "url" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time";
+    type: "number" | "email" | "tel" | "url" | "search" | "color" | "date" | "datetime-local" | "month" | "password" | "text" | "time";
     autofocus: boolean;
     disabled: boolean;
     readonly: boolean;
@@ -8806,6 +8843,10 @@ export declare const VToolbarMenu: DefineComponent<{
     icon: PropType<RawVButtonIcon>;
     startIcon: PropType<RawVButtonIcon>;
     endIcon: PropType<RawVButtonIcon>;
+    align: {
+        type: PropType<"left" | "right" | "center">;
+        default: string;
+    };
     tag: PropType<string>;
     class: PropType<any>;
     style: PropType<CSSProperties>;
@@ -8872,7 +8913,7 @@ export declare const VToolbarMenu: DefineComponent<{
     results: PropType<(string | number) | undefined>;
     security: PropType<string | undefined>;
     unselectable: PropType<"on" | "off" | undefined>;
-    inputmode: PropType<"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined>;
+    inputmode: PropType<"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined>;
     is: PropType<string | undefined>;
     'aria-activedescendant': PropType<string | undefined>;
     'aria-atomic': PropType<(boolean | "true" | "false") | undefined>;
@@ -8887,7 +8928,7 @@ export declare const VToolbarMenu: DefineComponent<{
     'aria-describedby': PropType<string | undefined>;
     'aria-details': PropType<string | undefined>;
     'aria-disabled': PropType<(boolean | "true" | "false") | undefined>;
-    'aria-dropeffect': PropType<"link" | "none" | "copy" | "execute" | "move" | "popup" | undefined>;
+    'aria-dropeffect': PropType<"none" | "copy" | "execute" | "link" | "move" | "popup" | undefined>;
     'aria-errormessage': PropType<string | undefined>;
     'aria-expanded': PropType<(boolean | "true" | "false") | undefined>;
     'aria-flowto': PropType<string | undefined>;
@@ -9014,6 +9055,10 @@ export declare const VToolbarMenu: DefineComponent<{
     icon: PropType<RawVButtonIcon>;
     startIcon: PropType<RawVButtonIcon>;
     endIcon: PropType<RawVButtonIcon>;
+    align: {
+        type: PropType<"left" | "right" | "center">;
+        default: string;
+    };
     tag: PropType<string>;
     class: PropType<any>;
     style: PropType<CSSProperties>;
@@ -9080,7 +9125,7 @@ export declare const VToolbarMenu: DefineComponent<{
     results: PropType<(string | number) | undefined>;
     security: PropType<string | undefined>;
     unselectable: PropType<"on" | "off" | undefined>;
-    inputmode: PropType<"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined>;
+    inputmode: PropType<"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined>;
     is: PropType<string | undefined>;
     'aria-activedescendant': PropType<string | undefined>;
     'aria-atomic': PropType<(boolean | "true" | "false") | undefined>;
@@ -9095,7 +9140,7 @@ export declare const VToolbarMenu: DefineComponent<{
     'aria-describedby': PropType<string | undefined>;
     'aria-details': PropType<string | undefined>;
     'aria-disabled': PropType<(boolean | "true" | "false") | undefined>;
-    'aria-dropeffect': PropType<"link" | "none" | "copy" | "execute" | "move" | "popup" | undefined>;
+    'aria-dropeffect': PropType<"none" | "copy" | "execute" | "link" | "move" | "popup" | undefined>;
     'aria-errormessage': PropType<string | undefined>;
     'aria-expanded': PropType<(boolean | "true" | "false") | undefined>;
     'aria-flowto': PropType<string | undefined>;
@@ -9213,6 +9258,7 @@ export declare const VToolbarMenu: DefineComponent<{
     onTransitionstart: PropType<((payload: TransitionEvent) => void) | undefined>;
 }>>, {
     rounded: boolean;
+    align: "left" | "right" | "center";
     loading: boolean;
     ariaCurrentValue: "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined;
 }>;
@@ -9246,6 +9292,10 @@ export declare const vueButtonProps: {
     icon: PropType<RawVButtonIcon>;
     startIcon: PropType<RawVButtonIcon>;
     endIcon: PropType<RawVButtonIcon>;
+    align: {
+        type: PropType<"left" | "right" | "center">;
+        default: string;
+    };
     tag: PropType<string>;
     class: PropType<any>;
     style: PropType<CSSProperties>;
@@ -9312,7 +9362,7 @@ export declare const vueButtonProps: {
     results: PropType<(string | number) | undefined>;
     security: PropType<string | undefined>;
     unselectable: PropType<"on" | "off" | undefined>;
-    inputmode: PropType<"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined>;
+    inputmode: PropType<"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined>;
     is: PropType<string | undefined>;
     'aria-activedescendant': PropType<string | undefined>;
     'aria-atomic': PropType<(boolean | "true" | "false") | undefined>;
@@ -9327,7 +9377,7 @@ export declare const vueButtonProps: {
     'aria-describedby': PropType<string | undefined>;
     'aria-details': PropType<string | undefined>;
     'aria-disabled': PropType<(boolean | "true" | "false") | undefined>;
-    'aria-dropeffect': PropType<"link" | "none" | "copy" | "execute" | "move" | "popup" | undefined>;
+    'aria-dropeffect': PropType<"none" | "copy" | "execute" | "link" | "move" | "popup" | undefined>;
     'aria-errormessage': PropType<string | undefined>;
     'aria-expanded': PropType<(boolean | "true" | "false") | undefined>;
     'aria-flowto': PropType<string | undefined>;
@@ -9520,6 +9570,7 @@ export declare class VuiService {
     readonly router: Router;
     readonly location: LocationService;
     readonly stack: VueStackService;
+    readonly useLink: typeof useLink;
     get scroller(): {
         readonly elementRef: Ref<HTMLElement | null>;
         readonly scroller: Scroller;
@@ -9572,25 +9623,7 @@ export declare class VuiService {
     };
     constructor(options: VuiServiceOptions, stackService: VueStackService);
     configure(options?: Partial<VuiServiceOptions>): void;
-    getRouterLink(): {
-        new (): {
-            $props: AllowedComponentProps & ComponentCustomProps & VNodeProps & RouterLinkProps;
-            $slots: {
-                default: (arg: {
-                    route: RouteLocation & {
-                        href: string;
-                    };
-                    href: string;
-                    isActive: boolean;
-                    isExactActive: boolean;
-                    navigate: (e?: MouseEvent | undefined) => Promise<void | NavigationFailure>;
-                }) => VNode<RendererNode, RendererElement, {
-                    [key: string]: any;
-                }>[];
-            };
-        };
-        useLink: typeof useLink;
-    };
+    getRouterLink(): any;
     setting<K extends keyof VuiServiceUISettings>(key: K): VuiServiceUISettings[K];
     icon<K extends keyof VuiServiceIconSettings>(iconType: K): VuiServiceIconSettings[K];
     getAutoScrollToElementOffsetTop(): number;
@@ -9634,7 +9667,8 @@ export declare interface VuiServiceIconSettings {
 
 export declare interface VuiServiceOptions {
     router: Router;
-    RouterLink?: typeof RouterLink;
+    RouterLink?: any;
+    useLink?: (props: UseLinkOptions) => UseLinkResult;
     colorScheme: VueColorSchemePluginSettings;
     uiSettings: VuiServiceUISettings;
     icons: VuiServiceIconSettings;