@fastkit/vui-wysiwyg 8.3.0-next.0 → 8.3.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/dist/pm/changeset.mjs +2 -3
- package/dist/pm/commands.mjs +2 -3
- package/dist/pm/dropcursor.mjs +2 -3
- package/dist/pm/gapcursor.mjs +2 -3
- package/dist/pm/history.mjs +2 -3
- package/dist/pm/inputrules.mjs +2 -3
- package/dist/pm/keymap.mjs +2 -3
- package/dist/pm/model.mjs +2 -3
- package/dist/pm/schema-list.mjs +2 -3
- package/dist/pm/state.mjs +2 -3
- package/dist/pm/tables.mjs +2 -3
- package/dist/pm/transform.mjs +2 -3
- package/dist/pm/view.mjs +2 -3
- package/dist/tiptap/core.mjs +2 -3
- package/dist/tiptap/extensions/bold.mjs +2 -3
- package/dist/tiptap/extensions/bullet-list.mjs +2 -3
- package/dist/tiptap/extensions/history.mjs +2 -3
- package/dist/tiptap/extensions/italic.mjs +2 -3
- package/dist/tiptap/extensions/link.mjs +2 -3
- package/dist/tiptap/extensions/ordered-list.mjs +2 -3
- package/dist/tiptap/extensions/text-align.mjs +2 -3
- package/dist/tiptap/extensions/text-style.mjs +2 -3
- package/dist/tiptap/extensions/underline.mjs +2 -3
- package/dist/vui-wysiwyg.css +117 -117
- package/dist/vui-wysiwyg.d.mts +38 -1407
- package/dist/vui-wysiwyg.mjs +2 -24
- package/dist/vui-wysiwyg.mjs.map +1 -1
- package/package.json +17 -62
- package/dist/pm/collab.d.mts +0 -1
- package/dist/pm/collab.mjs +0 -3
- package/dist/pm/markdown.d.mts +0 -1
- package/dist/pm/markdown.mjs +0 -3
- package/dist/pm/menu.d.mts +0 -1
- package/dist/pm/menu.mjs +0 -3
- package/dist/pm/schema-basic.d.mts +0 -1
- package/dist/pm/schema-basic.mjs +0 -3
- package/dist/pm/trailing-node.d.mts +0 -1
- package/dist/pm/trailing-node.mjs +0 -3
package/dist/vui-wysiwyg.d.mts
CHANGED
|
@@ -1,21 +1,16 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { AllowedComponentProps, App, Component, ComponentCustomProps, ComponentInternalInstance, ComponentPublicInstance, ComputedRef, DefineComponent, ExtractPropTypes, MaybeRef, Prop, PropType, Ref, SetupContext, SlotsType, UnwrapRef, VNode, VNodeArrayChildren, VNodeChild, VNodeProps, WritableComputedRef } from "vue";
|
|
1
|
+
import { ComponentInternalInstance, ComputedRef, ExtractPropTypes, Prop, PropType, Ref, SetupContext, SlotsType, VNode, VNodeArrayChildren, VNodeChild, WritableComputedRef } from "vue";
|
|
3
2
|
import { AnyExtension, Editor, EditorOptions, Extension, Extensions, Mark, Node } from "@tiptap/vue-3";
|
|
4
3
|
import { EditorView } from "@tiptap/pm/view";
|
|
5
|
-
import "@tiptap/extension-text-style";
|
|
6
4
|
import { BulletListOptions } from "@tiptap/extension-bullet-list";
|
|
7
5
|
import { BoldOptions } from "@tiptap/extension-bold";
|
|
8
6
|
import { ItalicOptions } from "@tiptap/extension-italic";
|
|
9
7
|
import { UnderlineOptions } from "@tiptap/extension-underline";
|
|
10
8
|
import { HistoryOptions } from "@tiptap/extension-history";
|
|
11
9
|
import { LinkOptions } from "@tiptap/extension-link";
|
|
12
|
-
import * as _fastkit_vui0 from "@fastkit/vui";
|
|
13
10
|
import { IconName, TextableControl, VuiService } from "@fastkit/vui";
|
|
14
11
|
import { OrderedListOptions } from "@tiptap/extension-ordered-list";
|
|
15
12
|
import { TextAlignOptions } from "@tiptap/extension-text-align";
|
|
16
13
|
import { Node as Node$1 } from "@tiptap/pm/model";
|
|
17
|
-
import * as vue_jsx_runtime0 from "vue/jsx-runtime";
|
|
18
|
-
|
|
19
14
|
//#region src/schemes.d.ts
|
|
20
15
|
declare const EDITOR_EVENTS: readonly ["beforeCreate", "create", "update", "selectionUpdate", "transaction", "focus", "blur", "destroy"];
|
|
21
16
|
type PrefixedEventName<S extends string> = `on${Capitalize<S>}`;
|
|
@@ -548,1366 +543,6 @@ type VerifiableRuleOrFn = VerifiableRule | VerifiableFn;
|
|
|
548
543
|
* @see {@link VerifiableRule}
|
|
549
544
|
*/
|
|
550
545
|
//#endregion
|
|
551
|
-
//#region ../../node_modules/.pnpm/vue-router@4.5.1_vue@3.5.22_typescript@5.9.3_/node_modules/vue-router/dist/vue-router.d.ts
|
|
552
|
-
declare type Awaitable<T> = T | Promise<T>;
|
|
553
|
-
/**
|
|
554
|
-
* Maybe a promise maybe not
|
|
555
|
-
* @internal
|
|
556
|
-
*/
|
|
557
|
-
declare type _Awaitable<T> = T | PromiseLike<T>;
|
|
558
|
-
/**
|
|
559
|
-
* Internal type to define an ErrorHandler
|
|
560
|
-
*
|
|
561
|
-
* @param error - error thrown
|
|
562
|
-
* @param to - location we were navigating to when the error happened
|
|
563
|
-
* @param from - location we were navigating from when the error happened
|
|
564
|
-
* @internal
|
|
565
|
-
*/
|
|
566
|
-
declare interface _ErrorListener {
|
|
567
|
-
(error: any, to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded): any;
|
|
568
|
-
}
|
|
569
|
-
/**
|
|
570
|
-
* Flags so we can combine them when checking for multiple errors. This is the internal version of
|
|
571
|
-
* {@link NavigationFailureType}.
|
|
572
|
-
*
|
|
573
|
-
* @internal
|
|
574
|
-
*/
|
|
575
|
-
declare const enum ErrorTypes {
|
|
576
|
-
MATCHER_NOT_FOUND = 1,
|
|
577
|
-
NAVIGATION_GUARD_REDIRECT = 2,
|
|
578
|
-
NAVIGATION_ABORTED = 4,
|
|
579
|
-
NAVIGATION_CANCELLED = 8,
|
|
580
|
-
NAVIGATION_DUPLICATED = 16
|
|
581
|
-
}
|
|
582
|
-
declare type HistoryLocation = string;
|
|
583
|
-
/**
|
|
584
|
-
* Allowed HTML history.state
|
|
585
|
-
*/
|
|
586
|
-
declare interface HistoryState {
|
|
587
|
-
[x: number]: HistoryStateValue;
|
|
588
|
-
[x: string]: HistoryStateValue;
|
|
589
|
-
}
|
|
590
|
-
/**
|
|
591
|
-
* Allowed arrays for history.state.
|
|
592
|
-
*
|
|
593
|
-
* @internal
|
|
594
|
-
*/
|
|
595
|
-
declare interface HistoryStateArray extends Array<HistoryStateValue> {}
|
|
596
|
-
/**
|
|
597
|
-
* Allowed variables in HTML5 history state. Note that pushState clones the state
|
|
598
|
-
* passed and does not accept everything: e.g.: it doesn't accept symbols, nor
|
|
599
|
-
* functions as values. It also ignores Symbols as keys.
|
|
600
|
-
*
|
|
601
|
-
* @internal
|
|
602
|
-
*/
|
|
603
|
-
declare type HistoryStateValue = string | number | boolean | null | undefined | HistoryState | HistoryStateArray;
|
|
604
|
-
/**
|
|
605
|
-
* Check if an object is a {@link NavigationFailure}.
|
|
606
|
-
*
|
|
607
|
-
* @param error - possible {@link NavigationFailure}
|
|
608
|
-
* @param type - optional types to check for
|
|
609
|
-
*
|
|
610
|
-
* @example
|
|
611
|
-
* ```js
|
|
612
|
-
* import { isNavigationFailure, NavigationFailureType } from 'vue-router'
|
|
613
|
-
*
|
|
614
|
-
* router.afterEach((to, from, failure) => {
|
|
615
|
-
* // Any kind of navigation failure
|
|
616
|
-
* if (isNavigationFailure(failure)) {
|
|
617
|
-
* // ...
|
|
618
|
-
* }
|
|
619
|
-
* // Only duplicated navigations
|
|
620
|
-
* if (isNavigationFailure(failure, NavigationFailureType.duplicated)) {
|
|
621
|
-
* // ...
|
|
622
|
-
* }
|
|
623
|
-
* // Aborted or canceled navigations
|
|
624
|
-
* if (isNavigationFailure(failure, NavigationFailureType.aborted | NavigationFailureType.canceled)) {
|
|
625
|
-
* // ...
|
|
626
|
-
* }
|
|
627
|
-
* })
|
|
628
|
-
* ```
|
|
629
|
-
*/
|
|
630
|
-
declare type Lazy<T> = () => Promise<T>;
|
|
631
|
-
/**
|
|
632
|
-
* Creates a union type that still allows autocompletion for strings.
|
|
633
|
-
* @internal
|
|
634
|
-
*/
|
|
635
|
-
declare type _LiteralUnion<LiteralType, BaseType extends string = string> = LiteralType | (BaseType & Record<never, never>);
|
|
636
|
-
/**
|
|
637
|
-
* Ensures a route is loaded, so it can be passed as o prop to `<RouterView>`.
|
|
638
|
-
*
|
|
639
|
-
* @param route - resolved route to load
|
|
640
|
-
*/
|
|
641
|
-
/**
|
|
642
|
-
* Normalized query object that appears in {@link RouteLocationNormalized}
|
|
643
|
-
*
|
|
644
|
-
* @public
|
|
645
|
-
*/
|
|
646
|
-
declare type LocationQuery = Record<string, LocationQueryValue | LocationQueryValue[]>;
|
|
647
|
-
/**
|
|
648
|
-
* Loose {@link LocationQuery} object that can be passed to functions like
|
|
649
|
-
* {@link Router.push} and {@link Router.replace} or anywhere when creating a
|
|
650
|
-
* {@link RouteLocationRaw}
|
|
651
|
-
*
|
|
652
|
-
* @public
|
|
653
|
-
*/
|
|
654
|
-
declare type LocationQueryRaw = Record<string | number, LocationQueryValueRaw | LocationQueryValueRaw[]>;
|
|
655
|
-
/**
|
|
656
|
-
* Possible values in normalized {@link LocationQuery}. `null` renders the query
|
|
657
|
-
* param but without an `=`.
|
|
658
|
-
*
|
|
659
|
-
* @example
|
|
660
|
-
* ```
|
|
661
|
-
* ?isNull&isEmpty=&other=other
|
|
662
|
-
* gives
|
|
663
|
-
* `{ isNull: null, isEmpty: '', other: 'other' }`.
|
|
664
|
-
* ```
|
|
665
|
-
*
|
|
666
|
-
* @internal
|
|
667
|
-
*/
|
|
668
|
-
declare type LocationQueryValue = string | null;
|
|
669
|
-
/**
|
|
670
|
-
* Possible values when defining a query.
|
|
671
|
-
*
|
|
672
|
-
* @internal
|
|
673
|
-
*/
|
|
674
|
-
declare type LocationQueryValueRaw = LocationQueryValue | number | undefined;
|
|
675
|
-
/**
|
|
676
|
-
* Normalized/resolved Route location that returned by the matcher.
|
|
677
|
-
*/
|
|
678
|
-
declare interface MatcherLocation {
|
|
679
|
-
/**
|
|
680
|
-
* Name of the matched record
|
|
681
|
-
*/
|
|
682
|
-
name: RouteRecordNameGeneric | null | undefined;
|
|
683
|
-
/**
|
|
684
|
-
* Percentage encoded pathname section of the URL.
|
|
685
|
-
*/
|
|
686
|
-
path: string;
|
|
687
|
-
/**
|
|
688
|
-
* Object of decoded params extracted from the `path`.
|
|
689
|
-
*/
|
|
690
|
-
params: RouteParamsGeneric;
|
|
691
|
-
/**
|
|
692
|
-
* Merged `meta` properties from all the matched route records.
|
|
693
|
-
*/
|
|
694
|
-
meta: RouteMeta;
|
|
695
|
-
/**
|
|
696
|
-
* Array of {@link RouteRecord} containing components as they were
|
|
697
|
-
* passed when adding records. It can also contain redirect records. This
|
|
698
|
-
* can't be used directly
|
|
699
|
-
*/
|
|
700
|
-
matched: RouteRecord[];
|
|
701
|
-
}
|
|
702
|
-
declare interface NavigationCallback {
|
|
703
|
-
(to: HistoryLocation, from: HistoryLocation, information: NavigationInformation): void;
|
|
704
|
-
}
|
|
705
|
-
declare enum NavigationDirection {
|
|
706
|
-
back = "back",
|
|
707
|
-
forward = "forward",
|
|
708
|
-
unknown = ""
|
|
709
|
-
}
|
|
710
|
-
/**
|
|
711
|
-
* Extended Error that contains extra information regarding a failed navigation.
|
|
712
|
-
*/
|
|
713
|
-
declare interface NavigationFailure extends Error {
|
|
714
|
-
/**
|
|
715
|
-
* Type of the navigation. One of {@link NavigationFailureType}
|
|
716
|
-
*/
|
|
717
|
-
type: ErrorTypes.NAVIGATION_CANCELLED | ErrorTypes.NAVIGATION_ABORTED | ErrorTypes.NAVIGATION_DUPLICATED;
|
|
718
|
-
/**
|
|
719
|
-
* Route location we were navigating from
|
|
720
|
-
*/
|
|
721
|
-
from: RouteLocationNormalized;
|
|
722
|
-
/**
|
|
723
|
-
* Route location we were navigating to
|
|
724
|
-
*/
|
|
725
|
-
to: RouteLocationNormalized;
|
|
726
|
-
}
|
|
727
|
-
/**
|
|
728
|
-
* Navigation Guard.
|
|
729
|
-
*/
|
|
730
|
-
declare interface NavigationGuard {
|
|
731
|
-
(to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded, next: NavigationGuardNext): _Awaitable<NavigationGuardReturn>;
|
|
732
|
-
}
|
|
733
|
-
/**
|
|
734
|
-
* `next()` callback passed to navigation guards.
|
|
735
|
-
*/
|
|
736
|
-
declare interface NavigationGuardNext {
|
|
737
|
-
(): void;
|
|
738
|
-
(error: Error): void;
|
|
739
|
-
(location: RouteLocationRaw): void;
|
|
740
|
-
(valid: boolean | undefined): void;
|
|
741
|
-
(cb: NavigationGuardNextCallback): void;
|
|
742
|
-
}
|
|
743
|
-
/**
|
|
744
|
-
* Callback that can be passed to `next()` in `beforeRouteEnter()` guards.
|
|
745
|
-
*/
|
|
746
|
-
declare type NavigationGuardNextCallback = (vm: ComponentPublicInstance) => unknown;
|
|
747
|
-
/**
|
|
748
|
-
* Return types for a Navigation Guard. Based on `TypesConfig`
|
|
749
|
-
*
|
|
750
|
-
* @see {@link TypesConfig}
|
|
751
|
-
*/
|
|
752
|
-
declare type NavigationGuardReturn = void | Error | boolean | RouteLocationRaw;
|
|
753
|
-
/**
|
|
754
|
-
* Navigation Guard with a type parameter for `this`.
|
|
755
|
-
* @see {@link TypesConfig}
|
|
756
|
-
*/
|
|
757
|
-
declare interface NavigationGuardWithThis<T> {
|
|
758
|
-
(this: T, to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded, next: NavigationGuardNext): _Awaitable<NavigationGuardReturn>;
|
|
759
|
-
}
|
|
760
|
-
/**
|
|
761
|
-
* Navigation hook triggered after a navigation is settled.
|
|
762
|
-
*/
|
|
763
|
-
declare interface NavigationHookAfter {
|
|
764
|
-
(to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded, failure?: NavigationFailure | void): unknown;
|
|
765
|
-
}
|
|
766
|
-
declare interface NavigationInformation {
|
|
767
|
-
type: NavigationType;
|
|
768
|
-
direction: NavigationDirection;
|
|
769
|
-
delta: number;
|
|
770
|
-
}
|
|
771
|
-
/**
|
|
772
|
-
* Internal error used to detect a redirection.
|
|
773
|
-
*
|
|
774
|
-
* @internal
|
|
775
|
-
*/
|
|
776
|
-
declare enum NavigationType {
|
|
777
|
-
pop = "pop",
|
|
778
|
-
push = "push"
|
|
779
|
-
}
|
|
780
|
-
/**
|
|
781
|
-
* Add a navigation guard that triggers whenever the component for the current
|
|
782
|
-
* location is about to be left. Similar to {@link beforeRouteLeave} but can be
|
|
783
|
-
* used in any component. The guard is removed when the component is unmounted.
|
|
784
|
-
*
|
|
785
|
-
* @param leaveGuard - {@link NavigationGuard}
|
|
786
|
-
*/
|
|
787
|
-
/**
|
|
788
|
-
* Transforms a queryString into a {@link LocationQuery} object. Accept both, a
|
|
789
|
-
* version with the leading `?` and without Should work as URLSearchParams
|
|
790
|
-
|
|
791
|
-
* @internal
|
|
792
|
-
*
|
|
793
|
-
* @param search - search string to parse
|
|
794
|
-
* @returns a query object
|
|
795
|
-
*/
|
|
796
|
-
declare function parseQuery(search: string): LocationQuery;
|
|
797
|
-
declare type PathParserOptions = Pick<_PathParserOptions, 'end' | 'sensitive' | 'strict'>;
|
|
798
|
-
/**
|
|
799
|
-
* @internal
|
|
800
|
-
*/
|
|
801
|
-
declare interface _PathParserOptions {
|
|
802
|
-
/**
|
|
803
|
-
* Makes the RegExp case-sensitive.
|
|
804
|
-
*
|
|
805
|
-
* @defaultValue `false`
|
|
806
|
-
*/
|
|
807
|
-
sensitive?: boolean;
|
|
808
|
-
/**
|
|
809
|
-
* Whether to disallow a trailing slash or not.
|
|
810
|
-
*
|
|
811
|
-
* @defaultValue `false`
|
|
812
|
-
*/
|
|
813
|
-
strict?: boolean;
|
|
814
|
-
/**
|
|
815
|
-
* Should the RegExp match from the beginning by prepending a `^` to it.
|
|
816
|
-
* @internal
|
|
817
|
-
*
|
|
818
|
-
* @defaultValue `true`
|
|
819
|
-
*/
|
|
820
|
-
start?: boolean;
|
|
821
|
-
/**
|
|
822
|
-
* Should the RegExp match until the end by appending a `$` to it.
|
|
823
|
-
*
|
|
824
|
-
* @defaultValue `true`
|
|
825
|
-
*/
|
|
826
|
-
end?: boolean;
|
|
827
|
-
}
|
|
828
|
-
/**
|
|
829
|
-
* Allowed Component definitions in route records provided by the user
|
|
830
|
-
*/
|
|
831
|
-
declare type RawRouteComponent = RouteComponent | Lazy<RouteComponent>;
|
|
832
|
-
/**
|
|
833
|
-
* Allowed Component in {@link RouteLocationMatched}
|
|
834
|
-
*/
|
|
835
|
-
declare type RouteComponent = Component | DefineComponent;
|
|
836
|
-
/**
|
|
837
|
-
* Type safe versions of types that are exposed by vue-router. We have to use a generic check to allow for names to be `undefined` when no `RouteMap` is provided.
|
|
838
|
-
*/
|
|
839
|
-
/**
|
|
840
|
-
* {@link RouteLocationRaw} resolved using the matcher
|
|
841
|
-
*/
|
|
842
|
-
declare type RouteLocation<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationGeneric : RouteLocationTypedList<RouteMap>[Name];
|
|
843
|
-
/**
|
|
844
|
-
* Route location as an object with a `path` property.
|
|
845
|
-
*/
|
|
846
|
-
declare type RouteLocationAsPath<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationAsPathGeneric : RouteLocationAsPathTypedList<RouteMap>[Name];
|
|
847
|
-
/**
|
|
848
|
-
* Generic version of {@link RouteLocationAsPath}. It is used when no {@link RouteMap} is provided.
|
|
849
|
-
*/
|
|
850
|
-
declare interface RouteLocationAsPathGeneric extends RouteQueryAndHash, RouteLocationOptions {
|
|
851
|
-
/**
|
|
852
|
-
* Percentage encoded pathname section of the URL.
|
|
853
|
-
*/
|
|
854
|
-
path: string;
|
|
855
|
-
}
|
|
856
|
-
/**
|
|
857
|
-
* Helper to generate a type safe version of the {@link RouteLocationAsPath} type.
|
|
858
|
-
*/
|
|
859
|
-
declare interface RouteLocationAsPathTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> extends RouteLocationAsPathGeneric {
|
|
860
|
-
path: _LiteralUnion<RouteMap[Name]['path']>;
|
|
861
|
-
}
|
|
862
|
-
/**
|
|
863
|
-
* List of all possible {@link RouteLocationAsPath} indexed by the route name.
|
|
864
|
-
* @internal
|
|
865
|
-
*/
|
|
866
|
-
declare type RouteLocationAsPathTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = { [N in keyof RouteMap]: RouteLocationAsPathTyped<RouteMap, N> };
|
|
867
|
-
/**
|
|
868
|
-
* Route location relative to the current location. It accepts other properties than `path` like `params`, `query` and
|
|
869
|
-
* `hash` to conveniently change them.
|
|
870
|
-
*/
|
|
871
|
-
declare type RouteLocationAsRelative<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationAsRelativeGeneric : RouteLocationAsRelativeTypedList<RouteMap>[Name];
|
|
872
|
-
/**
|
|
873
|
-
* Generic version of {@link RouteLocationAsRelative}. It is used when no {@link RouteMap} is provided.
|
|
874
|
-
*/
|
|
875
|
-
declare interface RouteLocationAsRelativeGeneric extends RouteQueryAndHash, RouteLocationOptions {
|
|
876
|
-
name?: RouteRecordNameGeneric;
|
|
877
|
-
params?: RouteParamsRawGeneric;
|
|
878
|
-
/**
|
|
879
|
-
* A relative path to the current location. This property should be removed
|
|
880
|
-
*/
|
|
881
|
-
path?: undefined;
|
|
882
|
-
}
|
|
883
|
-
/**
|
|
884
|
-
* Helper to generate a type safe version of the {@link RouteLocationAsRelative} type.
|
|
885
|
-
*/
|
|
886
|
-
declare interface RouteLocationAsRelativeTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> extends RouteLocationAsRelativeGeneric {
|
|
887
|
-
name?: Extract<Name, string | symbol>;
|
|
888
|
-
params?: RouteMap[Name]['paramsRaw'];
|
|
889
|
-
}
|
|
890
|
-
/**
|
|
891
|
-
* List of all possible {@link RouteLocationAsRelative} indexed by the route name.
|
|
892
|
-
* @internal
|
|
893
|
-
*/
|
|
894
|
-
declare type RouteLocationAsRelativeTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = { [N in keyof RouteMap]: RouteLocationAsRelativeTyped<RouteMap, N> };
|
|
895
|
-
/**
|
|
896
|
-
* Same as {@link RouteLocationAsPath} but as a string literal.
|
|
897
|
-
*/
|
|
898
|
-
declare type RouteLocationAsString<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? string : _LiteralUnion<RouteLocationAsStringTypedList<RouteMap>[Name], string>;
|
|
899
|
-
/**
|
|
900
|
-
* Helper to generate a type safe version of the {@link RouteLocationAsString} type.
|
|
901
|
-
*/
|
|
902
|
-
declare type RouteLocationAsStringTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> = RouteMap[Name]['path'];
|
|
903
|
-
/**
|
|
904
|
-
* List of all possible {@link RouteLocationAsString} indexed by the route name.
|
|
905
|
-
* @internal
|
|
906
|
-
*/
|
|
907
|
-
declare type RouteLocationAsStringTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = { [N in keyof RouteMap]: RouteLocationAsStringTyped<RouteMap, N> };
|
|
908
|
-
/**
|
|
909
|
-
* Base properties for a normalized route location.
|
|
910
|
-
*
|
|
911
|
-
* @internal
|
|
912
|
-
*/
|
|
913
|
-
declare interface _RouteLocationBase extends Pick<MatcherLocation, 'name' | 'path' | 'params' | 'meta'> {
|
|
914
|
-
/**
|
|
915
|
-
* The whole location including the `search` and `hash`. This string is
|
|
916
|
-
* percentage encoded.
|
|
917
|
-
*/
|
|
918
|
-
fullPath: string;
|
|
919
|
-
/**
|
|
920
|
-
* Object representation of the `search` property of the current location.
|
|
921
|
-
*/
|
|
922
|
-
query: LocationQuery;
|
|
923
|
-
/**
|
|
924
|
-
* Hash of the current location. If present, starts with a `#`.
|
|
925
|
-
*/
|
|
926
|
-
hash: string;
|
|
927
|
-
/**
|
|
928
|
-
* Contains the location we were initially trying to access before ending up
|
|
929
|
-
* on the current location.
|
|
930
|
-
*/
|
|
931
|
-
redirectedFrom: RouteLocation | undefined;
|
|
932
|
-
}
|
|
933
|
-
/**
|
|
934
|
-
* Generic version of {@link RouteLocation}. It is used when no {@link RouteMap} is provided.
|
|
935
|
-
*/
|
|
936
|
-
declare interface RouteLocationGeneric extends _RouteLocationBase {
|
|
937
|
-
/**
|
|
938
|
-
* Array of {@link RouteRecord} containing components as they were
|
|
939
|
-
* passed when adding records. It can also contain redirect records. This
|
|
940
|
-
* can't be used directly. **This property is non-enumerable**.
|
|
941
|
-
*/
|
|
942
|
-
matched: RouteRecord[];
|
|
943
|
-
}
|
|
944
|
-
declare interface RouteLocationMatched extends RouteRecordNormalized {
|
|
945
|
-
components: Record<string, RouteComponent> | null | undefined;
|
|
946
|
-
}
|
|
947
|
-
/**
|
|
948
|
-
* Similar to {@link RouteLocation} but its
|
|
949
|
-
* {@link RouteLocationNormalizedTyped.matched | `matched` property} cannot contain redirect records
|
|
950
|
-
*/
|
|
951
|
-
declare type RouteLocationNormalized<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationNormalizedGeneric : RouteLocationNormalizedTypedList<RouteMap>[Name];
|
|
952
|
-
/**
|
|
953
|
-
* Generic version of {@link RouteLocationNormalized} that is used when no {@link RouteMap} is provided.
|
|
954
|
-
*/
|
|
955
|
-
declare interface RouteLocationNormalizedGeneric extends _RouteLocationBase {
|
|
956
|
-
name: RouteRecordNameGeneric;
|
|
957
|
-
params: RouteParamsGeneric;
|
|
958
|
-
/**
|
|
959
|
-
* Array of {@link RouteRecordNormalized}
|
|
960
|
-
*/
|
|
961
|
-
matched: RouteRecordNormalized[];
|
|
962
|
-
}
|
|
963
|
-
/**
|
|
964
|
-
* Similar to {@link RouteLocationNormalized} but its `components` do not contain any function to lazy load components.
|
|
965
|
-
* In other words, it's ready to be rendered by `<RouterView>`.
|
|
966
|
-
*/
|
|
967
|
-
declare type RouteLocationNormalizedLoaded<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationNormalizedLoadedGeneric : RouteLocationNormalizedLoadedTypedList<RouteMap>[Name];
|
|
968
|
-
/**
|
|
969
|
-
* Generic version of {@link RouteLocationNormalizedLoaded} that is used when no {@link RouteMap} is provided.
|
|
970
|
-
*/
|
|
971
|
-
declare interface RouteLocationNormalizedLoadedGeneric extends RouteLocationNormalizedGeneric {
|
|
972
|
-
/**
|
|
973
|
-
* Array of {@link RouteLocationMatched} containing only plain components (any
|
|
974
|
-
* lazy-loaded components have been loaded and were replaced inside the
|
|
975
|
-
* `components` object) so it can be directly used to display routes. It
|
|
976
|
-
* cannot contain redirect records either. **This property is non-enumerable**.
|
|
977
|
-
*/
|
|
978
|
-
matched: RouteLocationMatched[];
|
|
979
|
-
}
|
|
980
|
-
/**
|
|
981
|
-
* Helper to generate a type safe version of the {@link RouteLocationNormalizedLoaded} type.
|
|
982
|
-
*/
|
|
983
|
-
declare interface RouteLocationNormalizedLoadedTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> extends RouteLocationNormalizedLoadedGeneric {
|
|
984
|
-
name: Extract<Name, string | symbol>;
|
|
985
|
-
params: RouteMap[Name]['params'];
|
|
986
|
-
}
|
|
987
|
-
/**
|
|
988
|
-
* List of all possible {@link RouteLocationNormalizedLoaded} indexed by the route name.
|
|
989
|
-
* @internal
|
|
990
|
-
*/
|
|
991
|
-
declare type RouteLocationNormalizedLoadedTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = { [N in keyof RouteMap]: RouteLocationNormalizedLoadedTyped<RouteMap, N> };
|
|
992
|
-
/**
|
|
993
|
-
* Helper to generate a type safe version of the {@link RouteLocationNormalized} type.
|
|
994
|
-
*/
|
|
995
|
-
declare interface RouteLocationNormalizedTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> extends RouteLocationNormalizedGeneric {
|
|
996
|
-
name: Extract<Name, string | symbol>;
|
|
997
|
-
params: RouteMap[Name]['params'];
|
|
998
|
-
/**
|
|
999
|
-
* Array of {@link RouteRecordNormalized}
|
|
1000
|
-
*/
|
|
1001
|
-
matched: RouteRecordNormalized[];
|
|
1002
|
-
}
|
|
1003
|
-
/**
|
|
1004
|
-
* List of all possible {@link RouteLocationNormalized} indexed by the route name.
|
|
1005
|
-
* @internal
|
|
1006
|
-
*/
|
|
1007
|
-
declare type RouteLocationNormalizedTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = { [N in keyof RouteMap]: RouteLocationNormalizedTyped<RouteMap, N> };
|
|
1008
|
-
/**
|
|
1009
|
-
* Common options for all navigation methods.
|
|
1010
|
-
*/
|
|
1011
|
-
declare interface RouteLocationOptions {
|
|
1012
|
-
/**
|
|
1013
|
-
* Replace the entry in the history instead of pushing a new entry
|
|
1014
|
-
*/
|
|
1015
|
-
replace?: boolean;
|
|
1016
|
-
/**
|
|
1017
|
-
* Triggers the navigation even if the location is the same as the current one.
|
|
1018
|
-
* Note this will also add a new entry to the history unless `replace: true`
|
|
1019
|
-
* is passed.
|
|
1020
|
-
*/
|
|
1021
|
-
force?: boolean;
|
|
1022
|
-
/**
|
|
1023
|
-
* State to save using the History API. This cannot contain any reactive
|
|
1024
|
-
* values and some primitives like Symbols are forbidden. More info at
|
|
1025
|
-
* https://developer.mozilla.org/en-US/docs/Web/API/History/state
|
|
1026
|
-
*/
|
|
1027
|
-
state?: HistoryState;
|
|
1028
|
-
}
|
|
1029
|
-
/**
|
|
1030
|
-
* Route location that can be passed to `router.push()` and other user-facing APIs.
|
|
1031
|
-
*/
|
|
1032
|
-
declare type RouteLocationRaw<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationAsString | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric : _LiteralUnion<RouteLocationAsStringTypedList<RouteMap>[Name], string> | RouteLocationAsRelativeTypedList<RouteMap>[Name] | RouteLocationAsPathTypedList<RouteMap>[Name];
|
|
1033
|
-
/**
|
|
1034
|
-
* Route location resolved with {@link Router | `router.resolve()`}.
|
|
1035
|
-
*/
|
|
1036
|
-
declare type RouteLocationResolved<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationResolvedGeneric : RouteLocationResolvedTypedList<RouteMap>[Name];
|
|
1037
|
-
/**
|
|
1038
|
-
* Generic version of {@link RouteLocationResolved}. It is used when no {@link RouteMap} is provided.
|
|
1039
|
-
*/
|
|
1040
|
-
declare interface RouteLocationResolvedGeneric extends RouteLocationGeneric {
|
|
1041
|
-
/**
|
|
1042
|
-
* Resolved `href` for the route location that will be set on the `<a href="...">`.
|
|
1043
|
-
*/
|
|
1044
|
-
href: string;
|
|
1045
|
-
}
|
|
1046
|
-
/**
|
|
1047
|
-
* Helper to generate a type safe version of the {@link RouteLocationResolved} type.
|
|
1048
|
-
*/
|
|
1049
|
-
declare interface RouteLocationResolvedTyped<RouteMap extends RouteMapGeneric, Name extends keyof RouteMap> extends RouteLocationTyped<RouteMap, Name> {
|
|
1050
|
-
/**
|
|
1051
|
-
* Resolved `href` for the route location that will be set on the `<a href="...">`.
|
|
1052
|
-
*/
|
|
1053
|
-
href: string;
|
|
1054
|
-
}
|
|
1055
|
-
/**
|
|
1056
|
-
* List of all possible {@link RouteLocationResolved} indexed by the route name.
|
|
1057
|
-
* @internal
|
|
1058
|
-
*/
|
|
1059
|
-
declare type RouteLocationResolvedTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = { [N in keyof RouteMap]: RouteLocationResolvedTyped<RouteMap, N> };
|
|
1060
|
-
/**
|
|
1061
|
-
* Helper to generate a type safe version of the {@link RouteLocation} type.
|
|
1062
|
-
*/
|
|
1063
|
-
declare interface RouteLocationTyped<RouteMap extends RouteMapGeneric, Name extends keyof RouteMap> extends RouteLocationGeneric {
|
|
1064
|
-
name: Extract<Name, string | symbol>;
|
|
1065
|
-
params: RouteMap[Name]['params'];
|
|
1066
|
-
}
|
|
1067
|
-
/**
|
|
1068
|
-
* List of all possible {@link RouteLocation} indexed by the route name.
|
|
1069
|
-
* @internal
|
|
1070
|
-
*/
|
|
1071
|
-
declare type RouteLocationTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = { [N in keyof RouteMap]: RouteLocationTyped<RouteMap, N> };
|
|
1072
|
-
/**
|
|
1073
|
-
* Convenience type to get the typed RouteMap or a generic one if not provided. It is extracted from the {@link TypesConfig} if it exists, it becomes {@link RouteMapGeneric} otherwise.
|
|
1074
|
-
*/
|
|
1075
|
-
declare type RouteMap = TypesConfig extends Record<'RouteNamedMap', infer RouteNamedMap> ? RouteNamedMap : RouteMapGeneric;
|
|
1076
|
-
/**
|
|
1077
|
-
* Generic version of the `RouteMap`.
|
|
1078
|
-
*/
|
|
1079
|
-
declare type RouteMapGeneric = Record<string | symbol, RouteRecordInfoGeneric>;
|
|
1080
|
-
/**
|
|
1081
|
-
* Interface to type `meta` fields in route records.
|
|
1082
|
-
*
|
|
1083
|
-
* @example
|
|
1084
|
-
*
|
|
1085
|
-
* ```ts
|
|
1086
|
-
* // typings.d.ts or router.ts
|
|
1087
|
-
* import 'vue-router';
|
|
1088
|
-
*
|
|
1089
|
-
* declare module 'vue-router' {
|
|
1090
|
-
* interface RouteMeta {
|
|
1091
|
-
* requiresAuth?: boolean
|
|
1092
|
-
* }
|
|
1093
|
-
* }
|
|
1094
|
-
* ```
|
|
1095
|
-
*/
|
|
1096
|
-
declare interface RouteMeta extends Record<PropertyKey, unknown> {}
|
|
1097
|
-
declare type RouteParamsGeneric = Record<string, RouteParamValue | RouteParamValue[]>;
|
|
1098
|
-
declare type RouteParamsRawGeneric = Record<string, RouteParamValueRaw | Exclude<RouteParamValueRaw, null | undefined>[]>;
|
|
1099
|
-
/**
|
|
1100
|
-
* @internal
|
|
1101
|
-
*/
|
|
1102
|
-
declare type RouteParamValue = string;
|
|
1103
|
-
/**
|
|
1104
|
-
* @internal
|
|
1105
|
-
*/
|
|
1106
|
-
declare type RouteParamValueRaw = RouteParamValue | number | null | undefined;
|
|
1107
|
-
/**
|
|
1108
|
-
* @internal
|
|
1109
|
-
*/
|
|
1110
|
-
declare interface RouteQueryAndHash {
|
|
1111
|
-
query?: LocationQueryRaw;
|
|
1112
|
-
hash?: string;
|
|
1113
|
-
}
|
|
1114
|
-
/**
|
|
1115
|
-
* Router instance.
|
|
1116
|
-
*/
|
|
1117
|
-
declare interface Router {
|
|
1118
|
-
/**
|
|
1119
|
-
* @internal
|
|
1120
|
-
*/
|
|
1121
|
-
/**
|
|
1122
|
-
* Current {@link RouteLocationNormalized}
|
|
1123
|
-
*/
|
|
1124
|
-
readonly currentRoute: Ref<RouteLocationNormalizedLoaded>;
|
|
1125
|
-
/**
|
|
1126
|
-
* Original options object passed to create the Router
|
|
1127
|
-
*/
|
|
1128
|
-
readonly options: RouterOptions;
|
|
1129
|
-
/**
|
|
1130
|
-
* Allows turning off the listening of history events. This is a low level api for micro-frontend.
|
|
1131
|
-
*/
|
|
1132
|
-
listening: boolean;
|
|
1133
|
-
/**
|
|
1134
|
-
* Add a new {@link RouteRecordRaw | route record} as the child of an existing route.
|
|
1135
|
-
*
|
|
1136
|
-
* @param parentName - Parent Route Record where `route` should be appended at
|
|
1137
|
-
* @param route - Route Record to add
|
|
1138
|
-
*/
|
|
1139
|
-
addRoute(parentName: NonNullable<RouteRecordNameGeneric>, route: RouteRecordRaw): () => void;
|
|
1140
|
-
/**
|
|
1141
|
-
* Add a new {@link RouteRecordRaw | route record} to the router.
|
|
1142
|
-
*
|
|
1143
|
-
* @param route - Route Record to add
|
|
1144
|
-
*/
|
|
1145
|
-
addRoute(route: RouteRecordRaw): () => void;
|
|
1146
|
-
/**
|
|
1147
|
-
* Remove an existing route by its name.
|
|
1148
|
-
*
|
|
1149
|
-
* @param name - Name of the route to remove
|
|
1150
|
-
*/
|
|
1151
|
-
removeRoute(name: NonNullable<RouteRecordNameGeneric>): void;
|
|
1152
|
-
/**
|
|
1153
|
-
* Checks if a route with a given name exists
|
|
1154
|
-
*
|
|
1155
|
-
* @param name - Name of the route to check
|
|
1156
|
-
*/
|
|
1157
|
-
hasRoute(name: NonNullable<RouteRecordNameGeneric>): boolean;
|
|
1158
|
-
/**
|
|
1159
|
-
* Get a full list of all the {@link RouteRecord | route records}.
|
|
1160
|
-
*/
|
|
1161
|
-
getRoutes(): RouteRecord[];
|
|
1162
|
-
/**
|
|
1163
|
-
* Delete all routes from the router matcher.
|
|
1164
|
-
*/
|
|
1165
|
-
clearRoutes(): void;
|
|
1166
|
-
/**
|
|
1167
|
-
* Returns the {@link RouteLocation | normalized version} of a
|
|
1168
|
-
* {@link RouteLocationRaw | route location}. Also includes an `href` property
|
|
1169
|
-
* that includes any existing `base`. By default, the `currentLocation` used is
|
|
1170
|
-
* `router.currentRoute` and should only be overridden in advanced use cases.
|
|
1171
|
-
*
|
|
1172
|
-
* @param to - Raw route location to resolve
|
|
1173
|
-
* @param currentLocation - Optional current location to resolve against
|
|
1174
|
-
*/
|
|
1175
|
-
resolve<Name extends keyof RouteMap = keyof RouteMap>(to: RouteLocationAsRelativeTyped<RouteMap, Name>, currentLocation?: RouteLocationNormalizedLoaded): RouteLocationResolved<Name>;
|
|
1176
|
-
resolve(to: RouteLocationAsString | RouteLocationAsRelative | RouteLocationAsPath, currentLocation?: RouteLocationNormalizedLoaded): RouteLocationResolved;
|
|
1177
|
-
/**
|
|
1178
|
-
* Programmatically navigate to a new URL by pushing an entry in the history
|
|
1179
|
-
* stack.
|
|
1180
|
-
*
|
|
1181
|
-
* @param to - Route location to navigate to
|
|
1182
|
-
*/
|
|
1183
|
-
push(to: RouteLocationRaw): Promise<NavigationFailure | void | undefined>;
|
|
1184
|
-
/**
|
|
1185
|
-
* Programmatically navigate to a new URL by replacing the current entry in
|
|
1186
|
-
* the history stack.
|
|
1187
|
-
*
|
|
1188
|
-
* @param to - Route location to navigate to
|
|
1189
|
-
*/
|
|
1190
|
-
replace(to: RouteLocationRaw): Promise<NavigationFailure | void | undefined>;
|
|
1191
|
-
/**
|
|
1192
|
-
* Go back in history if possible by calling `history.back()`. Equivalent to
|
|
1193
|
-
* `router.go(-1)`.
|
|
1194
|
-
*/
|
|
1195
|
-
back(): ReturnType<Router['go']>;
|
|
1196
|
-
/**
|
|
1197
|
-
* Go forward in history if possible by calling `history.forward()`.
|
|
1198
|
-
* Equivalent to `router.go(1)`.
|
|
1199
|
-
*/
|
|
1200
|
-
forward(): ReturnType<Router['go']>;
|
|
1201
|
-
/**
|
|
1202
|
-
* Allows you to move forward or backward through the history. Calls
|
|
1203
|
-
* `history.go()`.
|
|
1204
|
-
*
|
|
1205
|
-
* @param delta - The position in the history to which you want to move,
|
|
1206
|
-
* relative to the current page
|
|
1207
|
-
*/
|
|
1208
|
-
go(delta: number): void;
|
|
1209
|
-
/**
|
|
1210
|
-
* Add a navigation guard that executes before any navigation. Returns a
|
|
1211
|
-
* function that removes the registered guard.
|
|
1212
|
-
*
|
|
1213
|
-
* @param guard - navigation guard to add
|
|
1214
|
-
*/
|
|
1215
|
-
beforeEach(guard: NavigationGuardWithThis<undefined>): () => void;
|
|
1216
|
-
/**
|
|
1217
|
-
* Add a navigation guard that executes before navigation is about to be
|
|
1218
|
-
* resolved. At this state all component have been fetched and other
|
|
1219
|
-
* navigation guards have been successful. Returns a function that removes the
|
|
1220
|
-
* registered guard.
|
|
1221
|
-
*
|
|
1222
|
-
* @param guard - navigation guard to add
|
|
1223
|
-
* @returns a function that removes the registered guard
|
|
1224
|
-
*
|
|
1225
|
-
* @example
|
|
1226
|
-
* ```js
|
|
1227
|
-
* router.beforeResolve(to => {
|
|
1228
|
-
* if (to.meta.requiresAuth && !isAuthenticated) return false
|
|
1229
|
-
* })
|
|
1230
|
-
* ```
|
|
1231
|
-
*
|
|
1232
|
-
*/
|
|
1233
|
-
beforeResolve(guard: NavigationGuardWithThis<undefined>): () => void;
|
|
1234
|
-
/**
|
|
1235
|
-
* Add a navigation hook that is executed after every navigation. Returns a
|
|
1236
|
-
* function that removes the registered hook.
|
|
1237
|
-
*
|
|
1238
|
-
* @param guard - navigation hook to add
|
|
1239
|
-
* @returns a function that removes the registered hook
|
|
1240
|
-
*
|
|
1241
|
-
* @example
|
|
1242
|
-
* ```js
|
|
1243
|
-
* router.afterEach((to, from, failure) => {
|
|
1244
|
-
* if (isNavigationFailure(failure)) {
|
|
1245
|
-
* console.log('failed navigation', failure)
|
|
1246
|
-
* }
|
|
1247
|
-
* })
|
|
1248
|
-
* ```
|
|
1249
|
-
*/
|
|
1250
|
-
afterEach(guard: NavigationHookAfter): () => void;
|
|
1251
|
-
/**
|
|
1252
|
-
* Adds an error handler that is called every time a non caught error happens
|
|
1253
|
-
* during navigation. This includes errors thrown synchronously and
|
|
1254
|
-
* asynchronously, errors returned or passed to `next` in any navigation
|
|
1255
|
-
* guard, and errors occurred when trying to resolve an async component that
|
|
1256
|
-
* is required to render a route.
|
|
1257
|
-
*
|
|
1258
|
-
* @param handler - error handler to register
|
|
1259
|
-
*/
|
|
1260
|
-
onError(handler: _ErrorListener): () => void;
|
|
1261
|
-
/**
|
|
1262
|
-
* Returns a Promise that resolves when the router has completed the initial
|
|
1263
|
-
* navigation, which means it has resolved all async enter hooks and async
|
|
1264
|
-
* components that are associated with the initial route. If the initial
|
|
1265
|
-
* navigation already happened, the promise resolves immediately.
|
|
1266
|
-
*
|
|
1267
|
-
* This is useful in server-side rendering to ensure consistent output on both
|
|
1268
|
-
* the server and the client. Note that on server side, you need to manually
|
|
1269
|
-
* push the initial location while on client side, the router automatically
|
|
1270
|
-
* picks it up from the URL.
|
|
1271
|
-
*/
|
|
1272
|
-
isReady(): Promise<void>;
|
|
1273
|
-
/**
|
|
1274
|
-
* Called automatically by `app.use(router)`. Should not be called manually by
|
|
1275
|
-
* the user. This will trigger the initial navigation when on client side.
|
|
1276
|
-
*
|
|
1277
|
-
* @internal
|
|
1278
|
-
* @param app - Application that uses the router
|
|
1279
|
-
*/
|
|
1280
|
-
install(app: App): void;
|
|
1281
|
-
}
|
|
1282
|
-
/**
|
|
1283
|
-
* {@inheritDoc RouteRecordNormalized}
|
|
1284
|
-
*/
|
|
1285
|
-
declare type RouteRecord = RouteRecordNormalized;
|
|
1286
|
-
/**
|
|
1287
|
-
* Internal type for common properties among all kind of {@link RouteRecordRaw}.
|
|
1288
|
-
*/
|
|
1289
|
-
declare interface _RouteRecordBase extends PathParserOptions {
|
|
1290
|
-
/**
|
|
1291
|
-
* Path of the record. Should start with `/` unless the record is the child of
|
|
1292
|
-
* another record.
|
|
1293
|
-
*
|
|
1294
|
-
* @example `/users/:id` matches `/users/1` as well as `/users/posva`.
|
|
1295
|
-
*/
|
|
1296
|
-
path: string;
|
|
1297
|
-
/**
|
|
1298
|
-
* Where to redirect if the route is directly matched. The redirection happens
|
|
1299
|
-
* before any navigation guard and triggers a new navigation with the new
|
|
1300
|
-
* target location.
|
|
1301
|
-
*/
|
|
1302
|
-
redirect?: RouteRecordRedirectOption;
|
|
1303
|
-
/**
|
|
1304
|
-
* Aliases for the record. Allows defining extra paths that will behave like a
|
|
1305
|
-
* copy of the record. Allows having paths shorthands like `/users/:id` and
|
|
1306
|
-
* `/u/:id`. All `alias` and `path` values must share the same params.
|
|
1307
|
-
*/
|
|
1308
|
-
alias?: string | string[];
|
|
1309
|
-
/**
|
|
1310
|
-
* Name for the route record. Must be unique.
|
|
1311
|
-
*/
|
|
1312
|
-
name?: RouteRecordNameGeneric;
|
|
1313
|
-
/**
|
|
1314
|
-
* Before Enter guard specific to this record. Note `beforeEnter` has no
|
|
1315
|
-
* effect if the record has a `redirect` property.
|
|
1316
|
-
*/
|
|
1317
|
-
beforeEnter?: NavigationGuardWithThis<undefined> | NavigationGuardWithThis<undefined>[];
|
|
1318
|
-
/**
|
|
1319
|
-
* Arbitrary data attached to the record.
|
|
1320
|
-
*/
|
|
1321
|
-
meta?: RouteMeta;
|
|
1322
|
-
/**
|
|
1323
|
-
* Array of nested routes.
|
|
1324
|
-
*/
|
|
1325
|
-
children?: RouteRecordRaw[];
|
|
1326
|
-
/**
|
|
1327
|
-
* Allow passing down params as props to the component rendered by `router-view`.
|
|
1328
|
-
*/
|
|
1329
|
-
props?: _RouteRecordProps | Record<string, _RouteRecordProps>;
|
|
1330
|
-
}
|
|
1331
|
-
/**
|
|
1332
|
-
* Helper type to define a Typed `RouteRecord`
|
|
1333
|
-
* @see {@link RouteRecord}
|
|
1334
|
-
*/
|
|
1335
|
-
declare interface RouteRecordInfo<Name extends string | symbol = string, Path extends string = string, ParamsRaw extends RouteParamsRawGeneric = RouteParamsRawGeneric, Params extends RouteParamsGeneric = RouteParamsGeneric, ChildrenNames extends string | symbol = never> {
|
|
1336
|
-
name: Name;
|
|
1337
|
-
path: Path;
|
|
1338
|
-
paramsRaw: ParamsRaw;
|
|
1339
|
-
params: Params;
|
|
1340
|
-
childrenNames: ChildrenNames;
|
|
1341
|
-
}
|
|
1342
|
-
declare type RouteRecordInfoGeneric = RouteRecordInfo<string | symbol, string, RouteParamsRawGeneric, RouteParamsGeneric, string | symbol>;
|
|
1343
|
-
/**
|
|
1344
|
-
* Route Record defining multiple named components with the `components` option.
|
|
1345
|
-
*/
|
|
1346
|
-
declare interface RouteRecordMultipleViews extends _RouteRecordBase {
|
|
1347
|
-
/**
|
|
1348
|
-
* Components to display when the URL matches this route. Allow using named views.
|
|
1349
|
-
*/
|
|
1350
|
-
components: Record<string, RawRouteComponent>;
|
|
1351
|
-
component?: never;
|
|
1352
|
-
children?: never;
|
|
1353
|
-
redirect?: never;
|
|
1354
|
-
/**
|
|
1355
|
-
* Allow passing down params as props to the component rendered by
|
|
1356
|
-
* `router-view`. Should be an object with the same keys as `components` or a
|
|
1357
|
-
* boolean to be applied to every component.
|
|
1358
|
-
*/
|
|
1359
|
-
props?: Record<string, _RouteRecordProps> | boolean;
|
|
1360
|
-
}
|
|
1361
|
-
/**
|
|
1362
|
-
* Route Record defining multiple named components with the `components` option and children.
|
|
1363
|
-
*/
|
|
1364
|
-
declare interface RouteRecordMultipleViewsWithChildren extends _RouteRecordBase {
|
|
1365
|
-
/**
|
|
1366
|
-
* Components to display when the URL matches this route. Allow using named views.
|
|
1367
|
-
*/
|
|
1368
|
-
components?: Record<string, RawRouteComponent> | null | undefined;
|
|
1369
|
-
component?: never;
|
|
1370
|
-
children: RouteRecordRaw[];
|
|
1371
|
-
/**
|
|
1372
|
-
* Allow passing down params as props to the component rendered by
|
|
1373
|
-
* `router-view`. Should be an object with the same keys as `components` or a
|
|
1374
|
-
* boolean to be applied to every component.
|
|
1375
|
-
*/
|
|
1376
|
-
props?: Record<string, _RouteRecordProps> | boolean;
|
|
1377
|
-
}
|
|
1378
|
-
/**
|
|
1379
|
-
* Generic version of {@link RouteRecordName}.
|
|
1380
|
-
*/
|
|
1381
|
-
declare type RouteRecordNameGeneric = string | symbol | undefined;
|
|
1382
|
-
/**
|
|
1383
|
-
* Normalized version of a {@link RouteRecord | route record}.
|
|
1384
|
-
*/
|
|
1385
|
-
declare interface RouteRecordNormalized {
|
|
1386
|
-
/**
|
|
1387
|
-
* {@inheritDoc _RouteRecordBase.path}
|
|
1388
|
-
*/
|
|
1389
|
-
path: _RouteRecordBase['path'];
|
|
1390
|
-
/**
|
|
1391
|
-
* {@inheritDoc _RouteRecordBase.redirect}
|
|
1392
|
-
*/
|
|
1393
|
-
redirect: _RouteRecordBase['redirect'] | undefined;
|
|
1394
|
-
/**
|
|
1395
|
-
* {@inheritDoc _RouteRecordBase.name}
|
|
1396
|
-
*/
|
|
1397
|
-
name: _RouteRecordBase['name'];
|
|
1398
|
-
/**
|
|
1399
|
-
* {@inheritDoc RouteRecordMultipleViews.components}
|
|
1400
|
-
*/
|
|
1401
|
-
components: RouteRecordMultipleViews['components'] | null | undefined;
|
|
1402
|
-
/**
|
|
1403
|
-
* Contains the original modules for lazy loaded components.
|
|
1404
|
-
* @internal
|
|
1405
|
-
*/
|
|
1406
|
-
mods: Record<string, unknown>;
|
|
1407
|
-
/**
|
|
1408
|
-
* Nested route records.
|
|
1409
|
-
*/
|
|
1410
|
-
children: RouteRecordRaw[];
|
|
1411
|
-
/**
|
|
1412
|
-
* {@inheritDoc _RouteRecordBase.meta}
|
|
1413
|
-
*/
|
|
1414
|
-
meta: Exclude<_RouteRecordBase['meta'], void>;
|
|
1415
|
-
/**
|
|
1416
|
-
* {@inheritDoc RouteRecordMultipleViews.props}
|
|
1417
|
-
*/
|
|
1418
|
-
props: Record<string, _RouteRecordProps>;
|
|
1419
|
-
/**
|
|
1420
|
-
* Registered beforeEnter guards
|
|
1421
|
-
*/
|
|
1422
|
-
beforeEnter: _RouteRecordBase['beforeEnter'];
|
|
1423
|
-
/**
|
|
1424
|
-
* Registered leave guards
|
|
1425
|
-
*
|
|
1426
|
-
* @internal
|
|
1427
|
-
*/
|
|
1428
|
-
leaveGuards: Set<NavigationGuard>;
|
|
1429
|
-
/**
|
|
1430
|
-
* Registered update guards
|
|
1431
|
-
*
|
|
1432
|
-
* @internal
|
|
1433
|
-
*/
|
|
1434
|
-
updateGuards: Set<NavigationGuard>;
|
|
1435
|
-
/**
|
|
1436
|
-
* Registered beforeRouteEnter callbacks passed to `next` or returned in guards
|
|
1437
|
-
*
|
|
1438
|
-
* @internal
|
|
1439
|
-
*/
|
|
1440
|
-
enterCallbacks: Record<string, NavigationGuardNextCallback[]>;
|
|
1441
|
-
/**
|
|
1442
|
-
* Mounted route component instances
|
|
1443
|
-
* Having the instances on the record mean beforeRouteUpdate and
|
|
1444
|
-
* beforeRouteLeave guards can only be invoked with the latest mounted app
|
|
1445
|
-
* instance if there are multiple application instances rendering the same
|
|
1446
|
-
* view, basically duplicating the content on the page, which shouldn't happen
|
|
1447
|
-
* in practice. It will work if multiple apps are rendering different named
|
|
1448
|
-
* views.
|
|
1449
|
-
*/
|
|
1450
|
-
instances: Record<string, ComponentPublicInstance | undefined | null>;
|
|
1451
|
-
/**
|
|
1452
|
-
* Defines if this record is the alias of another one. This property is
|
|
1453
|
-
* `undefined` if the record is the original one.
|
|
1454
|
-
*/
|
|
1455
|
-
aliasOf: RouteRecordNormalized | undefined;
|
|
1456
|
-
}
|
|
1457
|
-
/**
|
|
1458
|
-
* @internal
|
|
1459
|
-
*/
|
|
1460
|
-
declare type _RouteRecordProps<Name extends keyof RouteMap = keyof RouteMap> = boolean | Record<string, any> | ((to: RouteLocationNormalized<Name>) => Record<string, any>);
|
|
1461
|
-
declare type RouteRecordRaw = RouteRecordSingleView | RouteRecordSingleViewWithChildren | RouteRecordMultipleViews | RouteRecordMultipleViewsWithChildren | RouteRecordRedirect;
|
|
1462
|
-
/**
|
|
1463
|
-
* Route Record that defines a redirect. Cannot have `component` or `components`
|
|
1464
|
-
* as it is never rendered.
|
|
1465
|
-
*/
|
|
1466
|
-
declare interface RouteRecordRedirect extends _RouteRecordBase {
|
|
1467
|
-
redirect: RouteRecordRedirectOption;
|
|
1468
|
-
component?: never;
|
|
1469
|
-
components?: never;
|
|
1470
|
-
props?: never;
|
|
1471
|
-
}
|
|
1472
|
-
/**
|
|
1473
|
-
* @internal
|
|
1474
|
-
*/
|
|
1475
|
-
declare type RouteRecordRedirectOption = RouteLocationRaw | ((to: RouteLocation) => RouteLocationRaw);
|
|
1476
|
-
/**
|
|
1477
|
-
* Route Record defining one single component with the `component` option.
|
|
1478
|
-
*/
|
|
1479
|
-
declare interface RouteRecordSingleView extends _RouteRecordBase {
|
|
1480
|
-
/**
|
|
1481
|
-
* Component to display when the URL matches this route.
|
|
1482
|
-
*/
|
|
1483
|
-
component: RawRouteComponent;
|
|
1484
|
-
components?: never;
|
|
1485
|
-
children?: never;
|
|
1486
|
-
redirect?: never;
|
|
1487
|
-
/**
|
|
1488
|
-
* Allow passing down params as props to the component rendered by `router-view`.
|
|
1489
|
-
*/
|
|
1490
|
-
props?: _RouteRecordProps;
|
|
1491
|
-
}
|
|
1492
|
-
/**
|
|
1493
|
-
* Route Record defining one single component with a nested view.
|
|
1494
|
-
*/
|
|
1495
|
-
declare interface RouteRecordSingleViewWithChildren extends _RouteRecordBase {
|
|
1496
|
-
/**
|
|
1497
|
-
* Component to display when the URL matches this route.
|
|
1498
|
-
*/
|
|
1499
|
-
component?: RawRouteComponent | null | undefined;
|
|
1500
|
-
components?: never;
|
|
1501
|
-
children: RouteRecordRaw[];
|
|
1502
|
-
/**
|
|
1503
|
-
* Allow passing down params as props to the component rendered by `router-view`.
|
|
1504
|
-
*/
|
|
1505
|
-
props?: _RouteRecordProps;
|
|
1506
|
-
}
|
|
1507
|
-
/**
|
|
1508
|
-
* Interface implemented by History implementations that can be passed to the
|
|
1509
|
-
* router as {@link Router.history}
|
|
1510
|
-
*
|
|
1511
|
-
* @alpha
|
|
1512
|
-
*/
|
|
1513
|
-
declare interface RouterHistory {
|
|
1514
|
-
/**
|
|
1515
|
-
* Base path that is prepended to every url. This allows hosting an SPA at a
|
|
1516
|
-
* sub-folder of a domain like `example.com/sub-folder` by having a `base` of
|
|
1517
|
-
* `/sub-folder`
|
|
1518
|
-
*/
|
|
1519
|
-
readonly base: string;
|
|
1520
|
-
/**
|
|
1521
|
-
* Current History location
|
|
1522
|
-
*/
|
|
1523
|
-
readonly location: HistoryLocation;
|
|
1524
|
-
/**
|
|
1525
|
-
* Current History state
|
|
1526
|
-
*/
|
|
1527
|
-
readonly state: HistoryState;
|
|
1528
|
-
/**
|
|
1529
|
-
* Navigates to a location. In the case of an HTML5 History implementation,
|
|
1530
|
-
* this will call `history.pushState` to effectively change the URL.
|
|
1531
|
-
*
|
|
1532
|
-
* @param to - location to push
|
|
1533
|
-
* @param data - optional {@link HistoryState} to be associated with the
|
|
1534
|
-
* navigation entry
|
|
1535
|
-
*/
|
|
1536
|
-
push(to: HistoryLocation, data?: HistoryState): void;
|
|
1537
|
-
/**
|
|
1538
|
-
* Same as {@link RouterHistory.push} but performs a `history.replaceState`
|
|
1539
|
-
* instead of `history.pushState`
|
|
1540
|
-
*
|
|
1541
|
-
* @param to - location to set
|
|
1542
|
-
* @param data - optional {@link HistoryState} to be associated with the
|
|
1543
|
-
* navigation entry
|
|
1544
|
-
*/
|
|
1545
|
-
replace(to: HistoryLocation, data?: HistoryState): void;
|
|
1546
|
-
/**
|
|
1547
|
-
* Traverses history in a given direction.
|
|
1548
|
-
*
|
|
1549
|
-
* @example
|
|
1550
|
-
* ```js
|
|
1551
|
-
* myHistory.go(-1) // equivalent to window.history.back()
|
|
1552
|
-
* myHistory.go(1) // equivalent to window.history.forward()
|
|
1553
|
-
* ```
|
|
1554
|
-
*
|
|
1555
|
-
* @param delta - distance to travel. If delta is \< 0, it will go back,
|
|
1556
|
-
* if it's \> 0, it will go forward by that amount of entries.
|
|
1557
|
-
* @param triggerListeners - whether this should trigger listeners attached to
|
|
1558
|
-
* the history
|
|
1559
|
-
*/
|
|
1560
|
-
go(delta: number, triggerListeners?: boolean): void;
|
|
1561
|
-
/**
|
|
1562
|
-
* Attach a listener to the History implementation that is triggered when the
|
|
1563
|
-
* navigation is triggered from outside (like the Browser back and forward
|
|
1564
|
-
* buttons) or when passing `true` to {@link RouterHistory.back} and
|
|
1565
|
-
* {@link RouterHistory.forward}
|
|
1566
|
-
*
|
|
1567
|
-
* @param callback - listener to attach
|
|
1568
|
-
* @returns a callback to remove the listener
|
|
1569
|
-
*/
|
|
1570
|
-
listen(callback: NavigationCallback): () => void;
|
|
1571
|
-
/**
|
|
1572
|
-
* Generates the corresponding href to be used in an anchor tag.
|
|
1573
|
-
*
|
|
1574
|
-
* @param location - history location that should create an href
|
|
1575
|
-
*/
|
|
1576
|
-
createHref(location: HistoryLocation): string;
|
|
1577
|
-
/**
|
|
1578
|
-
* Clears any event listener attached by the history implementation.
|
|
1579
|
-
*/
|
|
1580
|
-
destroy(): void;
|
|
1581
|
-
}
|
|
1582
|
-
/**
|
|
1583
|
-
* Component to render a link that triggers a navigation on click.
|
|
1584
|
-
*/
|
|
1585
|
-
declare const RouterLink: _RouterLinkI;
|
|
1586
|
-
/**
|
|
1587
|
-
* Typed version of the `RouterLink` component. Its generic defaults to the typed router, so it can be inferred
|
|
1588
|
-
* automatically for JSX.
|
|
1589
|
-
*
|
|
1590
|
-
* @internal
|
|
1591
|
-
*/
|
|
1592
|
-
declare interface _RouterLinkI {
|
|
1593
|
-
new (): {
|
|
1594
|
-
$props: AllowedComponentProps & ComponentCustomProps & VNodeProps & RouterLinkProps;
|
|
1595
|
-
$slots: {
|
|
1596
|
-
default?: ({
|
|
1597
|
-
route,
|
|
1598
|
-
href,
|
|
1599
|
-
isActive,
|
|
1600
|
-
isExactActive,
|
|
1601
|
-
navigate
|
|
1602
|
-
}: UnwrapRef<UseLinkReturn>) => VNode[];
|
|
1603
|
-
};
|
|
1604
|
-
};
|
|
1605
|
-
/**
|
|
1606
|
-
* Access to `useLink()` without depending on using vue-router
|
|
1607
|
-
*
|
|
1608
|
-
* @internal
|
|
1609
|
-
*/
|
|
1610
|
-
useLink: typeof useLink;
|
|
1611
|
-
}
|
|
1612
|
-
declare interface RouterLinkOptions {
|
|
1613
|
-
/**
|
|
1614
|
-
* Route Location the link should navigate to when clicked on.
|
|
1615
|
-
*/
|
|
1616
|
-
to: RouteLocationRaw;
|
|
1617
|
-
/**
|
|
1618
|
-
* Calls `router.replace` instead of `router.push`.
|
|
1619
|
-
*/
|
|
1620
|
-
replace?: boolean;
|
|
1621
|
-
}
|
|
1622
|
-
declare interface RouterLinkProps extends RouterLinkOptions {
|
|
1623
|
-
/**
|
|
1624
|
-
* Whether RouterLink should not wrap its content in an `a` tag. Useful when
|
|
1625
|
-
* using `v-slot` to create a custom RouterLink
|
|
1626
|
-
*/
|
|
1627
|
-
custom?: boolean;
|
|
1628
|
-
/**
|
|
1629
|
-
* Class to apply when the link is active
|
|
1630
|
-
*/
|
|
1631
|
-
activeClass?: string;
|
|
1632
|
-
/**
|
|
1633
|
-
* Class to apply when the link is exact active
|
|
1634
|
-
*/
|
|
1635
|
-
exactActiveClass?: string;
|
|
1636
|
-
/**
|
|
1637
|
-
* Value passed to the attribute `aria-current` when the link is exact active.
|
|
1638
|
-
*
|
|
1639
|
-
* @defaultValue `'page'`
|
|
1640
|
-
*/
|
|
1641
|
-
ariaCurrentValue?: 'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false';
|
|
1642
|
-
/**
|
|
1643
|
-
* Pass the returned promise of `router.push()` to `document.startViewTransition()` if supported.
|
|
1644
|
-
*/
|
|
1645
|
-
viewTransition?: boolean;
|
|
1646
|
-
}
|
|
1647
|
-
/**
|
|
1648
|
-
* Options to initialize a {@link Router} instance.
|
|
1649
|
-
*/
|
|
1650
|
-
declare interface RouterOptions extends PathParserOptions {
|
|
1651
|
-
/**
|
|
1652
|
-
* History implementation used by the router. Most web applications should use
|
|
1653
|
-
* `createWebHistory` but it requires the server to be properly configured.
|
|
1654
|
-
* You can also use a _hash_ based history with `createWebHashHistory` that
|
|
1655
|
-
* does not require any configuration on the server but isn't handled at all
|
|
1656
|
-
* by search engines and does poorly on SEO.
|
|
1657
|
-
*
|
|
1658
|
-
* @example
|
|
1659
|
-
* ```js
|
|
1660
|
-
* createRouter({
|
|
1661
|
-
* history: createWebHistory(),
|
|
1662
|
-
* // other options...
|
|
1663
|
-
* })
|
|
1664
|
-
* ```
|
|
1665
|
-
*/
|
|
1666
|
-
history: RouterHistory;
|
|
1667
|
-
/**
|
|
1668
|
-
* Initial list of routes that should be added to the router.
|
|
1669
|
-
*/
|
|
1670
|
-
routes: Readonly<RouteRecordRaw[]>;
|
|
1671
|
-
/**
|
|
1672
|
-
* Function to control scrolling when navigating between pages. Can return a
|
|
1673
|
-
* Promise to delay scrolling. Check {@link ScrollBehavior}.
|
|
1674
|
-
*
|
|
1675
|
-
* @example
|
|
1676
|
-
* ```js
|
|
1677
|
-
* function scrollBehavior(to, from, savedPosition) {
|
|
1678
|
-
* // `to` and `from` are both route locations
|
|
1679
|
-
* // `savedPosition` can be null if there isn't one
|
|
1680
|
-
* }
|
|
1681
|
-
* ```
|
|
1682
|
-
*/
|
|
1683
|
-
scrollBehavior?: RouterScrollBehavior;
|
|
1684
|
-
/**
|
|
1685
|
-
* Custom implementation to parse a query. See its counterpart,
|
|
1686
|
-
* {@link RouterOptions.stringifyQuery}.
|
|
1687
|
-
*
|
|
1688
|
-
* @example
|
|
1689
|
-
* Let's say you want to use the [qs package](https://github.com/ljharb/qs)
|
|
1690
|
-
* to parse queries, you can provide both `parseQuery` and `stringifyQuery`:
|
|
1691
|
-
* ```js
|
|
1692
|
-
* import qs from 'qs'
|
|
1693
|
-
*
|
|
1694
|
-
* createRouter({
|
|
1695
|
-
* // other options...
|
|
1696
|
-
* parseQuery: qs.parse,
|
|
1697
|
-
* stringifyQuery: qs.stringify,
|
|
1698
|
-
* })
|
|
1699
|
-
* ```
|
|
1700
|
-
*/
|
|
1701
|
-
parseQuery?: typeof parseQuery;
|
|
1702
|
-
/**
|
|
1703
|
-
* Custom implementation to stringify a query object. Should not prepend a leading `?`.
|
|
1704
|
-
* {@link RouterOptions.parseQuery | parseQuery} counterpart to handle query parsing.
|
|
1705
|
-
*/
|
|
1706
|
-
stringifyQuery?: typeof stringifyQuery;
|
|
1707
|
-
/**
|
|
1708
|
-
* Default class applied to active {@link RouterLink}. If none is provided,
|
|
1709
|
-
* `router-link-active` will be applied.
|
|
1710
|
-
*/
|
|
1711
|
-
linkActiveClass?: string;
|
|
1712
|
-
/**
|
|
1713
|
-
* Default class applied to exact active {@link RouterLink}. If none is provided,
|
|
1714
|
-
* `router-link-exact-active` will be applied.
|
|
1715
|
-
*/
|
|
1716
|
-
linkExactActiveClass?: string;
|
|
1717
|
-
}
|
|
1718
|
-
/**
|
|
1719
|
-
* Type of the `scrollBehavior` option that can be passed to `createRouter`.
|
|
1720
|
-
*/
|
|
1721
|
-
declare interface RouterScrollBehavior {
|
|
1722
|
-
/**
|
|
1723
|
-
* @param to - Route location where we are navigating to
|
|
1724
|
-
* @param from - Route location where we are navigating from
|
|
1725
|
-
* @param savedPosition - saved position if it exists, `null` otherwise
|
|
1726
|
-
*/
|
|
1727
|
-
(to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded, savedPosition: _ScrollPositionNormalized | null): Awaitable<ScrollPosition | false | void>;
|
|
1728
|
-
}
|
|
1729
|
-
/**
|
|
1730
|
-
* Component to display the current route the user is at.
|
|
1731
|
-
*/
|
|
1732
|
-
declare const RouterView: {
|
|
1733
|
-
new (): {
|
|
1734
|
-
$props: AllowedComponentProps & ComponentCustomProps & VNodeProps & RouterViewProps;
|
|
1735
|
-
$slots: {
|
|
1736
|
-
default?: ({
|
|
1737
|
-
Component,
|
|
1738
|
-
route
|
|
1739
|
-
}: {
|
|
1740
|
-
Component: VNode;
|
|
1741
|
-
route: RouteLocationNormalizedLoaded;
|
|
1742
|
-
}) => VNode[];
|
|
1743
|
-
};
|
|
1744
|
-
};
|
|
1745
|
-
};
|
|
1746
|
-
declare interface RouterViewProps {
|
|
1747
|
-
name?: string;
|
|
1748
|
-
route?: RouteLocationNormalized;
|
|
1749
|
-
}
|
|
1750
|
-
declare type ScrollPosition = ScrollPositionCoordinates | ScrollPositionElement;
|
|
1751
|
-
/**
|
|
1752
|
-
* Scroll position similar to
|
|
1753
|
-
* {@link https://developer.mozilla.org/en-US/docs/Web/API/ScrollToOptions | `ScrollToOptions`}.
|
|
1754
|
-
* Note that not all browsers support `behavior`.
|
|
1755
|
-
*/
|
|
1756
|
-
declare type ScrollPositionCoordinates = {
|
|
1757
|
-
behavior?: ScrollOptions['behavior'];
|
|
1758
|
-
left?: number;
|
|
1759
|
-
top?: number;
|
|
1760
|
-
};
|
|
1761
|
-
declare interface ScrollPositionElement extends ScrollToOptions {
|
|
1762
|
-
/**
|
|
1763
|
-
* A valid CSS selector. Note some characters must be escaped in id selectors (https://mathiasbynens.be/notes/css-escapes).
|
|
1764
|
-
* @example
|
|
1765
|
-
* Here are a few examples:
|
|
1766
|
-
*
|
|
1767
|
-
* - `.title`
|
|
1768
|
-
* - `.content:first-child`
|
|
1769
|
-
* - `#marker`
|
|
1770
|
-
* - `#marker\~with\~symbols`
|
|
1771
|
-
* - `#marker.with.dot`: selects `class="with dot" id="marker"`, not `id="marker.with.dot"`
|
|
1772
|
-
*
|
|
1773
|
-
*/
|
|
1774
|
-
el: string | Element;
|
|
1775
|
-
}
|
|
1776
|
-
/**
|
|
1777
|
-
* Internal normalized version of {@link ScrollPositionCoordinates} that always
|
|
1778
|
-
* has `left` and `top` coordinates. Must be a type to be assignable to HistoryStateValue.
|
|
1779
|
-
*
|
|
1780
|
-
* @internal
|
|
1781
|
-
*/
|
|
1782
|
-
declare type _ScrollPositionNormalized = {
|
|
1783
|
-
behavior?: ScrollOptions['behavior'];
|
|
1784
|
-
left: number;
|
|
1785
|
-
top: number;
|
|
1786
|
-
};
|
|
1787
|
-
/**
|
|
1788
|
-
* Initial route location where the router is. Can be used in navigation guards
|
|
1789
|
-
* to differentiate the initial navigation.
|
|
1790
|
-
*
|
|
1791
|
-
* @example
|
|
1792
|
-
* ```js
|
|
1793
|
-
* import { START_LOCATION } from 'vue-router'
|
|
1794
|
-
*
|
|
1795
|
-
* router.beforeEach((to, from) => {
|
|
1796
|
-
* if (from === START_LOCATION) {
|
|
1797
|
-
* // initial navigation
|
|
1798
|
-
* }
|
|
1799
|
-
* })
|
|
1800
|
-
* ```
|
|
1801
|
-
*/
|
|
1802
|
-
/**
|
|
1803
|
-
* Stringifies a {@link LocationQueryRaw} object. Like `URLSearchParams`, it
|
|
1804
|
-
* doesn't prepend a `?`
|
|
1805
|
-
*
|
|
1806
|
-
* @internal
|
|
1807
|
-
*
|
|
1808
|
-
* @param query - query object to stringify
|
|
1809
|
-
* @returns string version of the query without the leading `?`
|
|
1810
|
-
*/
|
|
1811
|
-
declare function stringifyQuery(query: LocationQueryRaw): string;
|
|
1812
|
-
/**
|
|
1813
|
-
* Allows customizing existing types of the router that are used globally like `$router`, `<RouterLink>`, etc. **ONLY FOR INTERNAL USAGE**.
|
|
1814
|
-
*
|
|
1815
|
-
* - `$router` - the router instance
|
|
1816
|
-
* - `$route` - the current route location
|
|
1817
|
-
* - `beforeRouteEnter` - Page component option
|
|
1818
|
-
* - `beforeRouteUpdate` - Page component option
|
|
1819
|
-
* - `beforeRouteLeave` - Page component option
|
|
1820
|
-
* - `RouterLink` - RouterLink Component
|
|
1821
|
-
* - `RouterView` - RouterView Component
|
|
1822
|
-
*
|
|
1823
|
-
* @internal
|
|
1824
|
-
*/
|
|
1825
|
-
declare interface TypesConfig {}
|
|
1826
|
-
/**
|
|
1827
|
-
* Returns the internal behavior of a {@link RouterLink} without the rendering part.
|
|
1828
|
-
*
|
|
1829
|
-
* @param props - a `to` location and an optional `replace` flag
|
|
1830
|
-
*/
|
|
1831
|
-
declare function useLink<Name extends keyof RouteMap = keyof RouteMap>(props: UseLinkOptions<Name>): UseLinkReturn<Name>;
|
|
1832
|
-
/**
|
|
1833
|
-
* Options passed to {@link useLink}.
|
|
1834
|
-
*/
|
|
1835
|
-
declare interface UseLinkOptions<Name extends keyof RouteMap = keyof RouteMap> {
|
|
1836
|
-
to: MaybeRef<RouteLocationAsString | RouteLocationAsRelativeTyped<RouteMap, Name> | RouteLocationAsPath | RouteLocationRaw>;
|
|
1837
|
-
replace?: MaybeRef<boolean | undefined>;
|
|
1838
|
-
/**
|
|
1839
|
-
* Pass the returned promise of `router.push()` to `document.startViewTransition()` if supported.
|
|
1840
|
-
*/
|
|
1841
|
-
viewTransition?: boolean;
|
|
1842
|
-
}
|
|
1843
|
-
/**
|
|
1844
|
-
* Return type of {@link useLink}.
|
|
1845
|
-
* @internal
|
|
1846
|
-
*/
|
|
1847
|
-
declare interface UseLinkReturn<Name extends keyof RouteMap = keyof RouteMap> {
|
|
1848
|
-
route: ComputedRef<RouteLocationResolved<Name>>;
|
|
1849
|
-
href: ComputedRef<string>;
|
|
1850
|
-
isActive: ComputedRef<boolean>;
|
|
1851
|
-
isExactActive: ComputedRef<boolean>;
|
|
1852
|
-
navigate(e?: MouseEvent): Promise<void | NavigationFailure>;
|
|
1853
|
-
}
|
|
1854
|
-
/**
|
|
1855
|
-
* NOTE: this used to be `@vue/runtime-core` but it should have been `vue` for a long time. Using both declaration at
|
|
1856
|
-
* the same time breaks so using only one everywhere is the preferred way.
|
|
1857
|
-
*/
|
|
1858
|
-
declare module 'vue' {
|
|
1859
|
-
export interface ComponentCustomOptions {
|
|
1860
|
-
/**
|
|
1861
|
-
* Guard called when the router is navigating to the route that is rendering
|
|
1862
|
-
* this component from a different route. Differently from `beforeRouteUpdate`
|
|
1863
|
-
* and `beforeRouteLeave`, `beforeRouteEnter` does not have access to the
|
|
1864
|
-
* component instance through `this` because it triggers before the component
|
|
1865
|
-
* is even mounted.
|
|
1866
|
-
*
|
|
1867
|
-
* @param to - RouteLocationRaw we are navigating to
|
|
1868
|
-
* @param from - RouteLocationRaw we are navigating from
|
|
1869
|
-
* @param next - function to validate, cancel or modify (by redirecting) the
|
|
1870
|
-
* navigation
|
|
1871
|
-
*/
|
|
1872
|
-
beforeRouteEnter?: TypesConfig extends Record<'beforeRouteEnter', infer T> ? T : NavigationGuardWithThis<undefined>;
|
|
1873
|
-
/**
|
|
1874
|
-
* Guard called whenever the route that renders this component has changed, but
|
|
1875
|
-
* it is reused for the new route. This allows you to guard for changes in
|
|
1876
|
-
* params, the query or the hash.
|
|
1877
|
-
*
|
|
1878
|
-
* @param to - RouteLocationRaw we are navigating to
|
|
1879
|
-
* @param from - RouteLocationRaw we are navigating from
|
|
1880
|
-
* @param next - function to validate, cancel or modify (by redirecting) the
|
|
1881
|
-
* navigation
|
|
1882
|
-
*/
|
|
1883
|
-
beforeRouteUpdate?: TypesConfig extends Record<'beforeRouteUpdate', infer T> ? T : NavigationGuard;
|
|
1884
|
-
/**
|
|
1885
|
-
* Guard called when the router is navigating away from the current route that
|
|
1886
|
-
* is rendering this component.
|
|
1887
|
-
*
|
|
1888
|
-
* @param to - RouteLocationRaw we are navigating to
|
|
1889
|
-
* @param from - RouteLocationRaw we are navigating from
|
|
1890
|
-
* @param next - function to validate, cancel or modify (by redirecting) the
|
|
1891
|
-
* navigation
|
|
1892
|
-
*/
|
|
1893
|
-
beforeRouteLeave?: TypesConfig extends Record<'beforeRouteLeave', infer T> ? T : NavigationGuard;
|
|
1894
|
-
}
|
|
1895
|
-
export interface ComponentCustomProperties {
|
|
1896
|
-
/**
|
|
1897
|
-
* Normalized current location. See {@link RouteLocationNormalizedLoaded}.
|
|
1898
|
-
*/
|
|
1899
|
-
$route: TypesConfig extends Record<'$route', infer T> ? T : RouteLocationNormalizedLoaded;
|
|
1900
|
-
/**
|
|
1901
|
-
* {@link Router} instance used by the application.
|
|
1902
|
-
*/
|
|
1903
|
-
$router: TypesConfig extends Record<'$router', infer T> ? T : Router;
|
|
1904
|
-
}
|
|
1905
|
-
export interface GlobalComponents {
|
|
1906
|
-
RouterView: TypesConfig extends Record<'RouterView', infer T> ? T : typeof RouterView;
|
|
1907
|
-
RouterLink: TypesConfig extends Record<'RouterLink', infer T> ? T : typeof RouterLink;
|
|
1908
|
-
}
|
|
1909
|
-
}
|
|
1910
|
-
//#endregion
|
|
1911
546
|
//#region ../vue-utils/dist/vue-utils.d.mts
|
|
1912
547
|
type TypedSlot<Prop = any> = (prop: Prop) => VNodeChild;
|
|
1913
548
|
type VNodeChildOrSlot<Prop = any> = VNodeChild | TypedSlot<Prop>;
|
|
@@ -2001,7 +636,7 @@ declare function createFormGroupProps(): {
|
|
|
2001
636
|
disableAutoScroll: BooleanConstructor;
|
|
2002
637
|
name: StringConstructor;
|
|
2003
638
|
tag: StringConstructor;
|
|
2004
|
-
modelValue:
|
|
639
|
+
modelValue: import("vue").Prop<unknown, unknown>;
|
|
2005
640
|
tabindex: {
|
|
2006
641
|
type: (StringConstructor | NumberConstructor)[];
|
|
2007
642
|
default: number;
|
|
@@ -2011,19 +646,19 @@ declare function createFormGroupProps(): {
|
|
|
2011
646
|
readonly: BooleanConstructor;
|
|
2012
647
|
viewonly: BooleanConstructor;
|
|
2013
648
|
spellcheck: BooleanConstructor;
|
|
2014
|
-
required: BooleanConstructor |
|
|
649
|
+
required: BooleanConstructor | import("vue").PropType<boolean>;
|
|
2015
650
|
clearable: BooleanConstructor;
|
|
2016
651
|
validateTiming: {
|
|
2017
|
-
type:
|
|
652
|
+
type: import("vue").PropType<ValidateTiming>;
|
|
2018
653
|
default: ValidateTiming;
|
|
2019
654
|
};
|
|
2020
655
|
rules: {
|
|
2021
|
-
type:
|
|
656
|
+
type: import("vue").PropType<RecursiveVerifiableRuleOrFn>;
|
|
2022
657
|
default: () => never[];
|
|
2023
658
|
};
|
|
2024
|
-
validationDeps:
|
|
659
|
+
validationDeps: import("vue").PropType<(nodeControl: FormNodeControl) => any>;
|
|
2025
660
|
error: BooleanConstructor;
|
|
2026
|
-
errorMessages:
|
|
661
|
+
errorMessages: import("vue").PropType<string | string[]>;
|
|
2027
662
|
showOwnErrors: {
|
|
2028
663
|
type: BooleanConstructor;
|
|
2029
664
|
default: undefined;
|
|
@@ -2171,7 +806,7 @@ declare function createFormProps(options?: FormOptions): {
|
|
|
2171
806
|
disableAutoScroll: BooleanConstructor;
|
|
2172
807
|
name: StringConstructor;
|
|
2173
808
|
tag: StringConstructor;
|
|
2174
|
-
modelValue:
|
|
809
|
+
modelValue: import("vue").Prop<unknown, unknown>;
|
|
2175
810
|
tabindex: {
|
|
2176
811
|
type: (StringConstructor | NumberConstructor)[];
|
|
2177
812
|
default: number;
|
|
@@ -2557,21 +1192,19 @@ declare class FormNodeWrapper {
|
|
|
2557
1192
|
get infoAppendsSlot(): TypedSlot<FormNodeWrapper> | undefined;
|
|
2558
1193
|
get hinttipDelay(): FormNodeWrapperHinttipDelay | undefined;
|
|
2559
1194
|
constructor(props: FormNodeWrapperProps, ctx: FormNodeWrapperContext, options?: FormNodeWrapperOptions);
|
|
2560
|
-
renderLabel():
|
|
2561
|
-
renderHint(allowNotFocused?: boolean):
|
|
2562
|
-
renderInfoAppends():
|
|
1195
|
+
renderLabel(): import("vue").VNodeArrayChildren | undefined;
|
|
1196
|
+
renderHint(allowNotFocused?: boolean): import("vue").VNodeArrayChildren | undefined;
|
|
1197
|
+
renderInfoAppends(): import("vue").VNodeArrayChildren | undefined;
|
|
2563
1198
|
protected _getContextOrDie(): {
|
|
2564
|
-
attrs:
|
|
2565
|
-
[x: string]: unknown;
|
|
2566
|
-
};
|
|
1199
|
+
attrs: import("vue").Attrs;
|
|
2567
1200
|
slots: Readonly<{
|
|
2568
|
-
[name: string]:
|
|
1201
|
+
[name: string]: import("vue").Slot<any> | undefined;
|
|
2569
1202
|
}>;
|
|
2570
1203
|
emit: (event: "clickLabel", ev: PointerEvent, wrapper: FormNodeWrapper) => void;
|
|
2571
1204
|
expose: <Exposed extends Record<string, any> = Record<string, any>>(exposed?: Exposed) => void;
|
|
2572
1205
|
};
|
|
2573
|
-
renderFirstError(slotsOverrides?: FormNodeErrorSlotsSource):
|
|
2574
|
-
renderMessage(allowNotFocused?: boolean):
|
|
1206
|
+
renderFirstError(slotsOverrides?: FormNodeErrorSlotsSource): import("vue").VNodeArrayChildren | undefined;
|
|
1207
|
+
renderMessage(allowNotFocused?: boolean): import("vue").VNodeArrayChildren | " ";
|
|
2575
1208
|
renderHinttip(): {
|
|
2576
1209
|
tip: VNodeChild;
|
|
2577
1210
|
hint: VNodeChild;
|
|
@@ -3106,11 +1739,9 @@ declare class FormNodeControl<T = any, D = T, Required extends Prop<any> = Boole
|
|
|
3106
1739
|
*/
|
|
3107
1740
|
findNodeByTag(tag: string): FormNodeControl | undefined;
|
|
3108
1741
|
protected _getContextOrDie(): {
|
|
3109
|
-
attrs:
|
|
3110
|
-
[x: string]: unknown;
|
|
3111
|
-
};
|
|
1742
|
+
attrs: import("vue").Attrs;
|
|
3112
1743
|
slots: Readonly<{
|
|
3113
|
-
[name: string]:
|
|
1744
|
+
[name: string]: import("vue").Slot<any> | undefined;
|
|
3114
1745
|
}>;
|
|
3115
1746
|
emit: ((event: "blur", ev: FocusEvent) => void) & ((event: "change", value: T | D) => void) & ((event: "update:modelValue", value: T | D) => void) & ((event: "update:errors", errors: FormNodeError[]) => void) & ((event: "focus", ev: FocusEvent) => void);
|
|
3116
1747
|
expose: <Exposed extends Record<string, any> = Record<string, any>>(exposed?: Exposed) => void;
|
|
@@ -3324,7 +1955,7 @@ interface VWysiwygEditorAPI {
|
|
|
3324
1955
|
readonly editor: Editor | undefined;
|
|
3325
1956
|
readonly control: TextableControl;
|
|
3326
1957
|
}
|
|
3327
|
-
declare const VWysiwygEditor:
|
|
1958
|
+
declare const VWysiwygEditor: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
3328
1959
|
extensions: {
|
|
3329
1960
|
type: PropType<RawWysiwygExtension[]>;
|
|
3330
1961
|
default: () => never[];
|
|
@@ -3351,12 +1982,12 @@ declare const VWysiwygEditor: vue2.DefineComponent<vue2.ExtractPropTypes<{
|
|
|
3351
1982
|
endAdornment?: (() => VNodeChild) | undefined;
|
|
3352
1983
|
}>;
|
|
3353
1984
|
size: {
|
|
3354
|
-
type: PropType<
|
|
1985
|
+
type: PropType<import("@fastkit/vui").ControlSize>;
|
|
3355
1986
|
validator: (value: any) => boolean;
|
|
3356
1987
|
};
|
|
3357
1988
|
loading: BooleanConstructor;
|
|
3358
1989
|
variant: {
|
|
3359
|
-
type: PropType<
|
|
1990
|
+
type: PropType<import("@fastkit/vui").ControlFieldVariant>;
|
|
3360
1991
|
validator: (value: any) => boolean;
|
|
3361
1992
|
};
|
|
3362
1993
|
startAdornment: PropType<VNodeChildOrSlot>;
|
|
@@ -3388,11 +2019,11 @@ declare const VWysiwygEditor: vue2.DefineComponent<vue2.ExtractPropTypes<{
|
|
|
3388
2019
|
limit: BooleanConstructor;
|
|
3389
2020
|
autocomplete: {
|
|
3390
2021
|
type: PropType<FormAutoComplete | boolean>;
|
|
3391
|
-
default: () => boolean | "
|
|
2022
|
+
default: () => boolean | "name" | "email" | "tel" | "url" | "off" | "on" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "photo" | undefined;
|
|
3392
2023
|
};
|
|
3393
2024
|
name: StringConstructor;
|
|
3394
2025
|
tag: StringConstructor;
|
|
3395
|
-
modelValue:
|
|
2026
|
+
modelValue: import("vue").Prop<any, any>;
|
|
3396
2027
|
autofocus: BooleanConstructor;
|
|
3397
2028
|
disabled: BooleanConstructor;
|
|
3398
2029
|
readonly: BooleanConstructor;
|
|
@@ -3416,13 +2047,13 @@ declare const VWysiwygEditor: vue2.DefineComponent<vue2.ExtractPropTypes<{
|
|
|
3416
2047
|
default: undefined;
|
|
3417
2048
|
};
|
|
3418
2049
|
detach: BooleanConstructor;
|
|
3419
|
-
}>, () =>
|
|
2050
|
+
}>, () => import("vue/jsx-runtime").JSX.Element, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
|
|
3420
2051
|
'update:modelValue': (value: string) => boolean;
|
|
3421
2052
|
'update:errors': (errors: FormNodeError[]) => boolean;
|
|
3422
2053
|
change: (value: string) => boolean;
|
|
3423
2054
|
focus: (ev: FocusEvent) => boolean;
|
|
3424
2055
|
blur: (ev: FocusEvent) => boolean;
|
|
3425
|
-
}, string,
|
|
2056
|
+
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
3426
2057
|
extensions: {
|
|
3427
2058
|
type: PropType<RawWysiwygExtension[]>;
|
|
3428
2059
|
default: () => never[];
|
|
@@ -3449,12 +2080,12 @@ declare const VWysiwygEditor: vue2.DefineComponent<vue2.ExtractPropTypes<{
|
|
|
3449
2080
|
endAdornment?: (() => VNodeChild) | undefined;
|
|
3450
2081
|
}>;
|
|
3451
2082
|
size: {
|
|
3452
|
-
type: PropType<
|
|
2083
|
+
type: PropType<import("@fastkit/vui").ControlSize>;
|
|
3453
2084
|
validator: (value: any) => boolean;
|
|
3454
2085
|
};
|
|
3455
2086
|
loading: BooleanConstructor;
|
|
3456
2087
|
variant: {
|
|
3457
|
-
type: PropType<
|
|
2088
|
+
type: PropType<import("@fastkit/vui").ControlFieldVariant>;
|
|
3458
2089
|
validator: (value: any) => boolean;
|
|
3459
2090
|
};
|
|
3460
2091
|
startAdornment: PropType<VNodeChildOrSlot>;
|
|
@@ -3486,11 +2117,11 @@ declare const VWysiwygEditor: vue2.DefineComponent<vue2.ExtractPropTypes<{
|
|
|
3486
2117
|
limit: BooleanConstructor;
|
|
3487
2118
|
autocomplete: {
|
|
3488
2119
|
type: PropType<FormAutoComplete | boolean>;
|
|
3489
|
-
default: () => boolean | "
|
|
2120
|
+
default: () => boolean | "name" | "email" | "tel" | "url" | "off" | "on" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "photo" | undefined;
|
|
3490
2121
|
};
|
|
3491
2122
|
name: StringConstructor;
|
|
3492
2123
|
tag: StringConstructor;
|
|
3493
|
-
modelValue:
|
|
2124
|
+
modelValue: import("vue").Prop<any, any>;
|
|
3494
2125
|
autofocus: BooleanConstructor;
|
|
3495
2126
|
disabled: BooleanConstructor;
|
|
3496
2127
|
readonly: BooleanConstructor;
|
|
@@ -3521,6 +2152,7 @@ declare const VWysiwygEditor: vue2.DefineComponent<vue2.ExtractPropTypes<{
|
|
|
3521
2152
|
"onUpdate:modelValue"?: ((value: string) => any) | undefined;
|
|
3522
2153
|
"onUpdate:errors"?: ((errors: FormNodeError[]) => any) | undefined;
|
|
3523
2154
|
}>, {
|
|
2155
|
+
clearable: boolean;
|
|
3524
2156
|
error: boolean;
|
|
3525
2157
|
floatingToolbar: boolean;
|
|
3526
2158
|
disabledMinHeight: boolean;
|
|
@@ -3539,38 +2171,37 @@ declare const VWysiwygEditor: vue2.DefineComponent<vue2.ExtractPropTypes<{
|
|
|
3539
2171
|
readonly: boolean;
|
|
3540
2172
|
viewonly: boolean;
|
|
3541
2173
|
spellcheck: boolean;
|
|
3542
|
-
clearable: boolean;
|
|
3543
2174
|
validateTiming: ValidateTiming;
|
|
3544
2175
|
rules: RecursiveVerifiableRuleOrFn;
|
|
3545
2176
|
showOwnErrors: boolean;
|
|
3546
2177
|
detach: boolean;
|
|
3547
2178
|
}, DefinedSlots<{
|
|
3548
|
-
[x: `error:${string}`]: (error: FormNodeError) =>
|
|
2179
|
+
[x: `error:${string}`]: (error: FormNodeError) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
3549
2180
|
[key: string]: any;
|
|
3550
2181
|
}>[];
|
|
3551
|
-
label?: ((wrapper: FormNodeWrapper) =>
|
|
2182
|
+
label?: ((wrapper: FormNodeWrapper) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
3552
2183
|
[key: string]: any;
|
|
3553
2184
|
}>[]) | undefined;
|
|
3554
|
-
hint?: ((wrapper: FormNodeWrapper) =>
|
|
2185
|
+
hint?: ((wrapper: FormNodeWrapper) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
3555
2186
|
[key: string]: any;
|
|
3556
2187
|
}>[]) | undefined;
|
|
3557
|
-
infoAppends?: ((wrapper: FormNodeWrapper) =>
|
|
2188
|
+
infoAppends?: ((wrapper: FormNodeWrapper) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
3558
2189
|
[key: string]: any;
|
|
3559
2190
|
}>[]) | undefined;
|
|
3560
|
-
error?: ((error: FormNodeError) =>
|
|
2191
|
+
error?: ((error: FormNodeError) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
3561
2192
|
[key: string]: any;
|
|
3562
2193
|
}>[]) | undefined;
|
|
3563
2194
|
} & {
|
|
3564
|
-
default?: (() =>
|
|
2195
|
+
default?: (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
3565
2196
|
[key: string]: any;
|
|
3566
2197
|
}>[]) | undefined;
|
|
3567
|
-
startAdornment?: (() =>
|
|
2198
|
+
startAdornment?: (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
3568
2199
|
[key: string]: any;
|
|
3569
2200
|
}>[]) | undefined;
|
|
3570
|
-
endAdornment?: (() =>
|
|
2201
|
+
endAdornment?: (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
3571
2202
|
[key: string]: any;
|
|
3572
2203
|
}>[]) | undefined;
|
|
3573
|
-
}>, {}, {}, string,
|
|
2204
|
+
}>, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
|
|
3574
2205
|
//#endregion
|
|
3575
2206
|
export { CreateWysiwygColorToolOptions, CreatedWysiwygExtension, RawWysiwygEditorTool, RawWysiwygExtension, ResolvedWysiwygEditorSettings, VUI_WYSIWYG_EDITOR_SYMBOL, VWysiwygEditor, VWysiwygEditorAPI, WYSIWYG_TEXT_ALIGN_VALUES, WysiwygBulletListTool, WysiwygColorExtension, WysiwygColorItem, WysiwygColorOptions, WysiwygCustomTagExtension, WysiwygCustomTagSettings, WysiwygCustomTagToolSettings, WysiwygEditorContext, WysiwygEditorEvent, WysiwygEditorEventsBucket, WysiwygEditorEventsOptions, WysiwygEditorInitializeContext, WysiwygEditorPrefixedEvent, WysiwygEditorTool, WysiwygEditorToolFactory, WysiwygEditorToolIcon, WysiwygExtensionFactory, WysiwygExtensionSource, WysiwygFormatBoldTool, WysiwygFormatItalicTool, WysiwygFormatUnderlineTool, WysiwygHistoryTool, WysiwygLinkTool, WysiwygLinter, WysiwygLinterBadWords, WysiwygLinterHeadingLevel, type WysiwygLinterOptions, WysiwygLinterPlugin, WysiwygLinterPunctuation, WysiwygOrderedListTool, WysiwygTextAlignOptions, WysiwygTextAlignTool, WysiwygTextAlignValue, createWysiwygColorTool, createWysiwygCustomTagMark, createWysiwygCustomTagTool, createWysiwygExtension, resolveRawWysiwygEditorTools, resolveRawWysiwygExtensions };
|
|
3576
2207
|
//# sourceMappingURL=vui-wysiwyg.d.mts.map
|