@astryx-vue/lab 0.3.1 → 0.5.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { VNodeChild } from "vue";
-import { FieldStatusInput, IconSize, PopoverPlacement, SyntaxThemeDefinition } from "@astryx-vue/core";
+import { MaybeRef, VNodeChild } from "vue";
+import { FieldStatusInput, IconSize, PopoverAlignment, PopoverPlacement, SyntaxThemeDefinition, TokenLine } from "@astryx-vue/core";
 //#region src/CircularProgress/types.d.ts
 /** Variants a theme can extend through declaration merging in TypeScript. */
 interface CircularProgressVariantMap {
@@ -63,10 +63,10 @@ interface CircularProgressProps {
 //#endregion
 //#region src/CircularProgress/CircularProgress.vue.d.ts
 declare var __VLS_1$1: {};
-type __VLS_Slots$4 = {} & {
+type __VLS_Slots$6 = {} & {
   default?: (props: typeof __VLS_1$1) => any;
 };
-declare const __VLS_base$4: import("vue").DefineComponent<CircularProgressProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<CircularProgressProps> & Readonly<{}>, {
+declare const __VLS_base$6: import("vue").DefineComponent<CircularProgressProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<CircularProgressProps> & Readonly<{}>, {
   value: number;
   size: CircularProgressSize;
   max: number;
@@ -77,14 +77,47 @@ declare const __VLS_base$4: import("vue").DefineComponent<CircularProgressProps,
   isIndeterminate: boolean;
   isDisabled: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-declare const __VLS_export$9: __VLS_WithSlots$4<typeof __VLS_base$4, __VLS_Slots$4>;
-declare const _default: typeof __VLS_export$9;
-type __VLS_WithSlots$4<T, S> = T & {
+declare const __VLS_export$12: __VLS_WithSlots$6<typeof __VLS_base$6, __VLS_Slots$6>;
+declare const _default: typeof __VLS_export$12;
+type __VLS_WithSlots$6<T, S> = T & {
   new (): {
     $slots: S;
   };
 };
 //#endregion
+//#region src/CodeEditor/types.d.ts
+interface CodeEditorProps {
+  /** 受控文本。 */
+  value: string;
+  /** 高亮语言，默认 plaintext。 */
+  language?: string;
+  /** 可编辑区域的无障碍名称。 */
+  label: string;
+  hasLineNumbers?: boolean;
+  isReadOnly?: boolean;
+  placeholder?: string;
+  maxHeight?: number | string;
+  size?: 'sm' | 'md';
+  tokenizer?: (code: string, language: string) => TokenLine[];
+  /** 告诉读屏用户如何离开 Tab 缩进区域。 */
+  escapeHint?: string;
+}
+interface CodeEditorEmits {
+  change: [value: string];
+}
+//#endregion
+//#region src/CodeEditor/CodeEditor.vue.d.ts
+declare const __VLS_export$11: import("vue").DefineComponent<CodeEditorProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+  change: (value: string) => any;
+}, string, import("vue").PublicProps, Readonly<CodeEditorProps> & Readonly<{
+  onChange?: ((value: string) => any) | undefined;
+}>, {
+  size: "md" | "sm";
+  language: string;
+  escapeHint: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default$1: typeof __VLS_export$11;
+//#endregion
 //#region src/DiffViewer/diffTypes.d.ts
 /**
  * @file diffTypes.ts
@@ -288,8 +321,8 @@ interface DiffViewerSlots {
 }
 //#endregion
 //#region src/DiffViewer/DiffViewer.vue.d.ts
-type __VLS_Slots$3 = DiffViewerSlots;
-declare const __VLS_base$3: import("vue").DefineComponent<DiffViewerProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+type __VLS_Slots$5 = DiffViewerSlots;
+declare const __VLS_base$5: import("vue").DefineComponent<DiffViewerProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
   collapsedChange: (isCollapsed: boolean) => any;
   "update:isCollapsed": (isCollapsed: boolean) => any;
   lineNumberClick: (ref: DiffViewerLineRef, event: MouseEvent) => any;
@@ -300,9 +333,9 @@ declare const __VLS_base$3: import("vue").DefineComponent<DiffViewerProps, {}, {
 }>, {
   label: string;
   maxHeight: string | number;
-  viewMode: DiffViewerViewMode;
   language: string;
   hasLineNumbers: boolean;
+  viewMode: DiffViewerViewMode;
   isWrapped: boolean;
   inlineHighlight: DiffViewerInlineHighlight;
   changeIndicator: DiffViewerChangeIndicator;
@@ -313,9 +346,9 @@ declare const __VLS_base$3: import("vue").DefineComponent<DiffViewerProps, {}, {
   syntaxTheme: import("@astryx-vue/core").SyntaxThemeDefinition;
   renderLineAnnotation: (ref: DiffViewerLineRef) => import("vue").VNodeChild;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-declare const __VLS_export$8: __VLS_WithSlots$3<typeof __VLS_base$3, __VLS_Slots$3>;
-declare const _default$1: typeof __VLS_export$8;
-type __VLS_WithSlots$3<T, S> = T & {
+declare const __VLS_export$10: __VLS_WithSlots$5<typeof __VLS_base$5, __VLS_Slots$5>;
+declare const _default$2: typeof __VLS_export$10;
+type __VLS_WithSlots$5<T, S> = T & {
   new (): {
     $slots: S;
   };
@@ -390,17 +423,17 @@ interface InfoTipProps {
 //#endregion
 //#region src/InfoTip/InfoTip.vue.d.ts
 declare var __VLS_13$1: {};
-type __VLS_Slots$2 = {} & {
+type __VLS_Slots$4 = {} & {
   content?: (props: typeof __VLS_13$1) => any;
 };
-declare const __VLS_base$2: import("vue").DefineComponent<InfoTipProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<InfoTipProps> & Readonly<{}>, {
+declare const __VLS_base$4: import("vue").DefineComponent<InfoTipProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<InfoTipProps> & Readonly<{}>, {
   label: string;
   size: import("@astryx-vue/core").IconSize;
   content: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-declare const __VLS_export$7: __VLS_WithSlots$2<typeof __VLS_base$2, __VLS_Slots$2>;
-declare const _default$2: typeof __VLS_export$7;
-type __VLS_WithSlots$2<T, S> = T & {
+declare const __VLS_export$9: __VLS_WithSlots$4<typeof __VLS_base$4, __VLS_Slots$4>;
+declare const _default$3: typeof __VLS_export$9;
+type __VLS_WithSlots$4<T, S> = T & {
   new (): {
     $slots: S;
   };
@@ -515,7 +548,7 @@ interface ListInputEmits<T> {
 }
 //#endregion
 //#region src/ListInput/ListInput.vue.d.ts
-declare const __VLS_export$6: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal$3<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+declare const __VLS_export$8: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal$3<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
   props: import("vue").PublicProps & __VLS_PrettifyLocal$3<ListInputProps<T> & {
     "onUpdate:modelValue"?: ((value: T[]) => any) | undefined;
     onChange?: ((value: T[], change: ListInputChange<T>) => any) | undefined;
@@ -529,7 +562,7 @@ declare const __VLS_export$6: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_
 }>) => import("vue").VNode & {
   __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
 };
-declare const _default$3: typeof __VLS_export$6;
+declare const _default$4: typeof __VLS_export$8;
 type __VLS_PrettifyLocal$3<T> = (T extends any ? { [K in keyof T]: T[K]; } : { [K in keyof T as K]: T[K]; }) & {};
 //#endregion
 //#region src/LogStream/types.d.ts
@@ -597,12 +630,12 @@ declare var __VLS_2: {
 }, __VLS_13: {
   entry: LogEntry;
 };
-type __VLS_Slots$1 = {} & {
+type __VLS_Slots$3 = {} & {
   entry?: (props: typeof __VLS_2) => any;
 } & {
   detail?: (props: typeof __VLS_13) => any;
 };
-declare const __VLS_base$1: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const __VLS_base$3: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
   "update:isFollowing": (value: boolean) => any;
   followChange: (following: boolean) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
@@ -614,9 +647,9 @@ declare const __VLS_base$1: import("vue").DefineComponent<__VLS_PublicProps, {},
   maxHeight: string | number;
   hasTimestamps: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-declare const __VLS_export$5: __VLS_WithSlots$1<typeof __VLS_base$1, __VLS_Slots$1>;
-declare const _default$4: typeof __VLS_export$5;
-type __VLS_WithSlots$1<T, S> = T & {
+declare const __VLS_export$7: __VLS_WithSlots$3<typeof __VLS_base$3, __VLS_Slots$3>;
+declare const _default$5: typeof __VLS_export$7;
+type __VLS_WithSlots$3<T, S> = T & {
   new (): {
     $slots: S;
   };
@@ -689,7 +722,7 @@ interface MobileTokenizerEmits<T extends SearchableItem = SearchableItem> {
 }
 //#endregion
 //#region src/MobileTokenizer/MobileTokenizer.vue.d.ts
-declare const __VLS_export$4: <T extends SearchableItem>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal$2<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+declare const __VLS_export$6: <T extends SearchableItem>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal$2<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
   props: import("vue").PublicProps & __VLS_PrettifyLocal$2<MobileTokenizerProps<T> & {
     "onUpdate:modelValue"?: ((value: T[]) => any) | undefined;
     onChange?: ((value: T[], change: MobileTokenizerChange<T>) => any) | undefined;
@@ -706,7 +739,7 @@ declare const __VLS_export$4: <T extends SearchableItem>(__VLS_props: NonNullabl
 }>) => import("vue").VNode & {
   __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
 };
-declare const _default$5: typeof __VLS_export$4;
+declare const _default$6: typeof __VLS_export$6;
 type __VLS_PrettifyLocal$2<T> = (T extends any ? { [K in keyof T]: T[K]; } : { [K in keyof T as K]: T[K]; }) & {};
 //#endregion
 //#region src/Stat/types.d.ts
@@ -746,20 +779,20 @@ interface StatProps {
 //#endregion
 //#region src/Stat/Stat.vue.d.ts
 declare var __VLS_1: {}, __VLS_3: {};
-type __VLS_Slots = {} & {
+type __VLS_Slots$2 = {} & {
   default?: (props: typeof __VLS_1) => any;
 } & {
   media?: (props: typeof __VLS_3) => any;
 };
-declare const __VLS_base: import("vue").DefineComponent<StatProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<StatProps> & Readonly<{}>, {
+declare const __VLS_base$2: import("vue").DefineComponent<StatProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<StatProps> & Readonly<{}>, {
   value: string;
   delta: StatDelta;
   description: string;
   size: StatSize;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-declare const __VLS_export$3: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
-declare const _default$7: typeof __VLS_export$3;
-type __VLS_WithSlots<T, S> = T & {
+declare const __VLS_export$5: __VLS_WithSlots$2<typeof __VLS_base$2, __VLS_Slots$2>;
+declare const _default$8: typeof __VLS_export$5;
+type __VLS_WithSlots$2<T, S> = T & {
   new (): {
     $slots: S;
   };
@@ -900,13 +933,13 @@ interface PathPersonality {
 export declare function applyPersonality(d: string, personality: PathPersonality): string;
 //#endregion
 //#region src/SVGIcon/SVGIcon.vue.d.ts
-declare const __VLS_export$2: import("vue").DefineComponent<SVGIconProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<SVGIconProps> & Readonly<{}>, {
+declare const __VLS_export$4: import("vue").DefineComponent<SVGIconProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<SVGIconProps> & Readonly<{}>, {
   size: SVGIconSize;
   strokeWidth: number;
   variation: SVGIconVariation;
   color: SVGIconColor;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-declare const _default$6: typeof __VLS_export$2;
+declare const _default$7: typeof __VLS_export$4;
 //#endregion
 //#region src/SVGIcon/types-xif.d.ts
 /**
@@ -1048,6 +1081,79 @@ export declare const xifStar: XIFIcon;
 export declare const xifBellOverride: XIFIcon;
 export declare const xifExamples: XIFIcon[];
 //#endregion
+//#region src/Tour/context.d.ts
+type TourDismissSource = 'backdrop' | 'escape' | 'close' | 'skip' | 'complete';
+//#endregion
+//#region src/Tour/types.d.ts
+interface TourProps {
+  /** 是否运行。关闭后步骤重置；调用方负责在 dismiss 后把它设为 false。 */
+  isActive: boolean;
+  /** 在目标周围压暗页面，保留目标亮区。 */
+  hasBackdrop?: boolean;
+  /** 显示“第几步 / 总步数”。 */
+  isStepCountShown?: boolean;
+}
+interface TourEmits {
+  dismiss: [source: TourDismissSource];
+}
+interface TourSlots {
+  default?: () => unknown;
+}
+interface TourStepProps {
+  /** 指向步骤目标元素的模板 ref。 */
+  'targetRef': MaybeRef<HTMLElement | null>;
+  /** 步骤标题，同时作为弹层名称。 */
+  'heading': string;
+  'placement'?: PopoverPlacement;
+  'alignment'?: PopoverAlignment;
+  'data-testid'?: string;
+}
+interface TourStepSlots {
+  default?: () => unknown;
+}
+//#endregion
+//#region src/Tour/Tour.vue.d.ts
+type __VLS_Slots$1 = TourSlots;
+declare const __VLS_base$1: import("vue").DefineComponent<TourProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+  dismiss: (source: TourDismissSource) => any;
+}, string, import("vue").PublicProps, Readonly<TourProps> & Readonly<{
+  onDismiss?: ((source: TourDismissSource) => any) | undefined;
+}>, {
+  hasBackdrop: boolean;
+  isStepCountShown: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export$3: __VLS_WithSlots$1<typeof __VLS_base$1, __VLS_Slots$1>;
+declare const _default$9: typeof __VLS_export$3;
+type __VLS_WithSlots$1<T, S> = T & {
+  new (): {
+    $slots: S;
+  };
+};
+//#endregion
+//#region src/Tour/TourStep.vue.d.ts
+type __VLS_Slots = TourStepSlots;
+declare const __VLS_base: any;
+declare const __VLS_export$2: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default$10: typeof __VLS_export$2;
+type __VLS_WithSlots<T, S> = T & {
+  new (): {
+    $slots: S;
+  };
+};
+//#endregion
+//#region src/Tour/useTour.d.ts
+interface UseTourReturn {
+  readonly activeStepIndex: number;
+  readonly stepCount: number;
+  readonly isFirstStep: boolean;
+  readonly isLastStep: boolean;
+  next: () => void;
+  previous: () => void;
+  dismiss: (source: TourDismissSource) => void;
+}
+/** 读取最近的 Tour。没有控制器时返回 null，由调用方决定是否跳过自定义 UI。 */
+export declare function useTour(): UseTourReturn | null;
+//#endregion
 //#region src/TransferList/types.d.ts
 /** 一个可搬运的选项。`value` 唯一，`label` 是可见文字，也是操作名的来源。 */
 interface TransferListOption<T extends string = string> {
@@ -1130,7 +1236,7 @@ declare const __VLS_export$1: <T extends string>(__VLS_props: NonNullable<Awaite
 }>) => import("vue").VNode & {
   __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
 };
-declare const _default$8: typeof __VLS_export$1;
+declare const _default$11: typeof __VLS_export$1;
 type __VLS_PrettifyLocal$1<T> = (T extends any ? { [K in keyof T]: T[K]; } : { [K in keyof T as K]: T[K]; }) & {};
 //#endregion
 //#region src/TransferList/TransferListSelector.vue.d.ts
@@ -1186,7 +1292,7 @@ declare const __VLS_export: <T extends string>(__VLS_props: NonNullable<Awaited<
 }>) => import("vue").VNode & {
   __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
 };
-declare const _default$9: typeof __VLS_export;
+declare const _default$12: typeof __VLS_export;
 type __VLS_PrettifyLocal<T> = (T extends any ? { [K in keyof T]: T[K]; } : { [K in keyof T as K]: T[K]; }) & {};
 //#endregion
-export { _default as CircularProgress, type CircularProgressProps, type CircularProgressSize, type CircularProgressVariant, type CircularProgressVariantMap, type CreateDiffFileOptions, _default$1 as DiffViewer, type DiffViewerChangeIndicator, type DiffViewerEmits, type DiffViewerFile, type DiffViewerFileStatus, type DiffViewerHunk, type DiffViewerInlineHighlight, type DiffViewerLine, type DiffViewerLineKind, type DiffViewerLineRef, type DiffViewerProps, type DiffViewerSide, type DiffViewerSlots, type DiffViewerViewMode, type IconShape, type IconShapeRole, _default$2 as InfoTip, type InfoTipProps, type InfoTipSize, type InlineDiffGranularity, type InlineDiffResult, type InlineRange, _default$3 as ListInput, type ListInputChange, type ListInputColumn, type ListInputColumnWidth, type ListInputEmits, type ListInputProps, type ListInputRenderContext, type ListInputValueContext, type LogEntry, _default$4 as LogStream, type LogStreamEmits, type LogStreamLevel, type LogStreamProps, _default$5 as MobileTokenizer, type MobileTokenizerChange, type MobileTokenizerEmits, type MobileTokenizerProps, type PanelGroup, type PanelRow, type PathPersonality, _default$6 as SVGIcon, type SVGIconColor, type SVGIconDef, type SVGIconProps, type SVGIconSize, type SVGIconVariation, type SearchSource, type SearchableItem, _default$7 as Stat, type StatDelta, type StatDeltaDirection, type StatDeltaSentiment, type StatProps, type StatSize, _default$8 as TransferList, type TransferListEmits, type TransferListOption, type TransferListProps, _default$9 as TransferListSelector, type TransferListSlots, type XIFAnimate, type XIFIcon, type XIFPath, type XIFPersonality, type XIFSlot };
+export { _default as CircularProgress, type CircularProgressProps, type CircularProgressSize, type CircularProgressVariant, type CircularProgressVariantMap, _default$1 as CodeEditor, type CodeEditorEmits, type CodeEditorProps, type CreateDiffFileOptions, _default$2 as DiffViewer, type DiffViewerChangeIndicator, type DiffViewerEmits, type DiffViewerFile, type DiffViewerFileStatus, type DiffViewerHunk, type DiffViewerInlineHighlight, type DiffViewerLine, type DiffViewerLineKind, type DiffViewerLineRef, type DiffViewerProps, type DiffViewerSide, type DiffViewerSlots, type DiffViewerViewMode, type IconShape, type IconShapeRole, _default$3 as InfoTip, type InfoTipProps, type InfoTipSize, type InlineDiffGranularity, type InlineDiffResult, type InlineRange, _default$4 as ListInput, type ListInputChange, type ListInputColumn, type ListInputColumnWidth, type ListInputEmits, type ListInputProps, type ListInputRenderContext, type ListInputValueContext, type LogEntry, _default$5 as LogStream, type LogStreamEmits, type LogStreamLevel, type LogStreamProps, _default$6 as MobileTokenizer, type MobileTokenizerChange, type MobileTokenizerEmits, type MobileTokenizerProps, type PanelGroup, type PanelRow, type PathPersonality, _default$7 as SVGIcon, type SVGIconColor, type SVGIconDef, type SVGIconProps, type SVGIconSize, type SVGIconVariation, type SearchSource, type SearchableItem, _default$8 as Stat, type StatDelta, type StatDeltaDirection, type StatDeltaSentiment, type StatProps, type StatSize, _default$9 as Tour, type TourDismissSource, type TourEmits, type TourProps, type TourSlots, _default$10 as TourStep, type TourStepProps, type TourStepSlots, _default$11 as TransferList, type TransferListEmits, type TransferListOption, type TransferListProps, _default$12 as TransferListSelector, type TransferListSlots, type UseTourReturn, type XIFAnimate, type XIFIcon, type XIFPath, type XIFPersonality, type XIFSlot };