snail.vue 2.0.23 → 2.0.25

package/dist/snail.vue.d.ts

@@ -1,7 +1,7 @@
 import * as snail_core from 'snail.core';
 import { DateFormat, DateValue, TimeValue, IScope, RunResult, IAsyncScope } from 'snail.core';
 import * as snail_view from 'snail.view';
-import { ScrollbarOptions, ScrollStatus, BaseStyle, HeightStyle, FlexBoxStyle, WidthStyle, BorderStyle, PaddingStyle, CSSClassOptions, MarginStyle } from 'snail.view';
+import { ScrollbarOptions, ScrollStatus, CSSClassOptions, BaseStyle, HeightStyle, FlexBoxStyle, WidthStyle, BorderStyle, PaddingStyle, MarginStyle } from 'snail.view';
 import * as vue from 'vue';
 import { Component, ShallowRef, Ref, WatchSource, App } from 'vue';
 
@@ -439,7 +439,7 @@ type ScrollEvents = {
 /**
  * 包裹组件 相关实体
  */
-type WrapperOptions = ReadonlyOptions & {
+type WrapperOptions = {
     /**
      * 是否是弹窗模式
      */
@@ -448,18 +448,18 @@ type WrapperOptions = ReadonlyOptions & {
      * Header组件配置
      * - 不传入，则不需要 Header组件
      */
-    header?: HeaderOptions & DisabledOptions;
+    header?: Partial<HeaderOptions> & DisabledOptions & CSSClassOptions;
     /**
      * 内容组件配置
      * - 滚动相关配置
      * - 不传入则无需滚动
      */
-    content?: ScrollOptions;
+    content?: ScrollOptions & CSSClassOptions;
     /**
      * Footer组件配置
      * - 不传入，则不需要 Footer 组件
      */
-    footer?: FooterOptions & DisabledOptions;
+    footer?: FooterOptions & DisabledOptions & CSSClassOptions;
 };
 /**
  * 包裹组件 事件
@@ -1019,12 +1019,12 @@ type ComponentBindOptions<Props = void, Model = void> = {
  */
 type LayoutOptions = {
     /**
-     * 布局模式
+     * 布局方向
      * - horizontal 水平布局：左中右
      * - vertical 垂直布局：上中下
      * - 默认为 `horizontal`
      */
-    mode?: "horizontal" | "vertical";
+    direction?: "horizontal" | "vertical";
     /**
      * 主内容区域配置
      * - 对应插槽名：main；主要内容显示区域，处于布局中的【中】区域
@@ -2166,7 +2166,15 @@ type ReactiveVar<T> = ShallowRef<T> | Ref<T>;
 /**
  * 开关组件 配置选项
  */
-type SwitchOptions = ReadonlyOptions & {};
+type SwitchOptions = ReadonlyOptions & {
+    /**
+     * 类型，决定开启/关闭状态的渲染效果
+     * - switch     开关类型，默认效果
+     * - radio      单选框效果，圆角边框
+     * - checkbox   复选框效果，矩形边框
+     */
+    type?: "switch" | "radio" | "checkbox";
+};
 /**
  * 开关 事件
  */
@@ -2480,6 +2488,11 @@ type PopupDescriptor<Options extends PopupOptions, ExtOptions> = PopupStatusOpti
  * @see ComponentBindOptions 了解 Props、Model 泛型参数的含义
  */
 type DialogOptions<Props = void, Model = void> = PopupOptions<Props, Model> & {
+    /**
+     * 包裹器配置
+     * - 若传入配置，则启用弹窗包裹；弹窗打开时使用`Wrapper`包裹弹窗内容组件
+     */
+    wrapper?: Pick<WrapperOptions, "header" | "content" | "footer">;
     /**
      * 禁用【遮罩层】
      * - 目前没实现，先忽略
@@ -2508,9 +2521,21 @@ type DialogHandle<T> = PopupHandle<T> & {
     /**
      * 注册监听【弹窗关闭】事件方法
      * - 仅支持注册一次，多次注册以最后一次的为准
-     * @param fn 关闭时执行的钩子函数，支持异步，返回false时将阻止弹窗关闭
+     * @param fn 关闭时执行的钩子函数，支持异步；；调用后若返回false时将阻止弹窗关闭
      */
-    onBeforeClose(fn: () => false | undefined | Promise<false | undefined>): void;
+    onBeforeClose(fn: (data?: T) => false | undefined | Promise<false | undefined>): void;
+};
+/**
+ * 弹窗包裹器操作句柄
+ */
+type DialogWrapperHandle<T> = {
+    /**
+     * 注册【构建数据】事件方法
+     * - 仅在Dialog为使用了wrapper模式时生效，用于在【确认】按钮点击时，构建实际内容组件中的数据
+     * - 仅支持注册一次，多次注册以最后一次的为准
+     * @param fn 取数据时执行的钩子函数，支持异步；若需要阻止弹窗关闭则`fn`方法直接报错即可
+     */
+    onBuildData(fn: () => T | Promise<T>): void;
 };
 
 /**
@@ -3040,11 +3065,15 @@ declare const components: {
         };
     });
     Switch: vue.DefineComponent<ReadonlyOptions & {
+        type?: "switch" | "radio" | "checkbox";
+    } & {
         modelValue?: boolean;
     }, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
         change: (value: boolean) => any;
         "update:modelValue": (value: boolean) => any;
     }, string, vue.PublicProps, Readonly<ReadonlyOptions & {
+        type?: "switch" | "radio" | "checkbox";
+    } & {
         modelValue?: boolean;
     }> & Readonly<{
         onChange?: (value: boolean) => any;
@@ -3653,4 +3682,4 @@ declare const components: {
 };
 
 export { MOTION, components, getBuiltinIcon, mount, onAppCreated, triggerAppCreated, usePicker, usePopup, useReactive, useTreeContext };
-export type { ActionEvents, ActionItem, ActionItemsOptions, ActionOptions, ButtonOptions, ChangeEvents, ChooseEvents, ChooseItem, ChooseOptions, ClickEvents, CloseEvents, ComponentBindOptions, ComponentOptions, ConfirmAreaOptions, ConfirmOptions, DatePickerDayItem, DatePickerMonthItem, DatePickerOptions, DatePickerYearItem, DatetimeDisabledOptions, DatetimePickerEvents, DeleteEvents, DialogHandle, DialogOptions, DisabledOptions, DragVerifyInfo, DragVerifyOptions, ElasticEvents, ElasticExpose, ElasticOptions, ElasticSpringStatus, EmitterType, EmptyOptions, EventsType, FlexOptions, FoldEvents, FoldOptions, FoldSlotHandle, FoldStatus, FollowElectResult, FollowExtend, FollowHandle, FollowOptions, FollowPositionOptions, FollowStrategy, FollowStrategyOptions, FooterEvents, FooterOptions, HeaderEvents, HeaderOptions, INumberFormatter, IPickerManager, IPopupManager, IReactiveManager, ISelectContext, ITreeBaseContext, IconOptions, IconType, InputEvents, InputOptions, LayoutAraeOptions, LayoutAreaItem, LayoutOptions, LoadingOptions, MessageOptions, MotionEffectOptions, MotionOptions, MoveEvents, NumberBaseOptions, NumberEvents, NumberFormatResult, NumberOptions, PickerExtend, PickerPopupOptions, PlaceholderOptions, PopupDescriptor, PopupHandle, PopupOptions, PopupStatus, PopupStatusOptions, PropsType, ReactiveVar, ReadonlyOptions, ScrollEvents, ScrollExpose, ScrollOptions, SearchEvents, SearchOptions, SelectBaseEvents, SelectBaseOptions, SelectEvents, SelectItem, SelectNodeEvents, SelectNodeOptions, SelectOptions, SelectPopupEvents, SelectPopupExtend, SelectPopupOptions, SelectSlotOptions, SlotsType, SortEvent, SortEvents, SortGroupHook, SortGroupOptions, SortOptions, SwitchEvents, SwitchOptions, TableColOptions, TableOptions, TableRowOptions, TextareaEvents, TextareaOptions, TimePickerHourItem, TimePickerMinuteItem, TimePickerOptions, TimePickerSecondItem, TitleOptions, ToastOptions, TreeEvents, TreeNode, TreeNodeEvents, TreeNodeExtend, TreeNodeModel, TreeNodeOptions, TreeNodeRenderOptions, TreeNodeSlotOptions, TreeOptions, TreeSearchResult, ValueOptions, WrapperEvents, WrapperOptions };
+export type { ActionEvents, ActionItem, ActionItemsOptions, ActionOptions, ButtonOptions, ChangeEvents, ChooseEvents, ChooseItem, ChooseOptions, ClickEvents, CloseEvents, ComponentBindOptions, ComponentOptions, ConfirmAreaOptions, ConfirmOptions, DatePickerDayItem, DatePickerMonthItem, DatePickerOptions, DatePickerYearItem, DatetimeDisabledOptions, DatetimePickerEvents, DeleteEvents, DialogHandle, DialogOptions, DialogWrapperHandle, DisabledOptions, DragVerifyInfo, DragVerifyOptions, ElasticEvents, ElasticExpose, ElasticOptions, ElasticSpringStatus, EmitterType, EmptyOptions, EventsType, FlexOptions, FoldEvents, FoldOptions, FoldSlotHandle, FoldStatus, FollowElectResult, FollowExtend, FollowHandle, FollowOptions, FollowPositionOptions, FollowStrategy, FollowStrategyOptions, FooterEvents, FooterOptions, HeaderEvents, HeaderOptions, INumberFormatter, IPickerManager, IPopupManager, IReactiveManager, ISelectContext, ITreeBaseContext, IconOptions, IconType, InputEvents, InputOptions, LayoutAraeOptions, LayoutAreaItem, LayoutOptions, LoadingOptions, MessageOptions, MotionEffectOptions, MotionOptions, MoveEvents, NumberBaseOptions, NumberEvents, NumberFormatResult, NumberOptions, PickerExtend, PickerPopupOptions, PlaceholderOptions, PopupDescriptor, PopupHandle, PopupOptions, PopupStatus, PopupStatusOptions, PropsType, ReactiveVar, ReadonlyOptions, ScrollEvents, ScrollExpose, ScrollOptions, SearchEvents, SearchOptions, SelectBaseEvents, SelectBaseOptions, SelectEvents, SelectItem, SelectNodeEvents, SelectNodeOptions, SelectOptions, SelectPopupEvents, SelectPopupExtend, SelectPopupOptions, SelectSlotOptions, SlotsType, SortEvent, SortEvents, SortGroupHook, SortGroupOptions, SortOptions, SwitchEvents, SwitchOptions, TableColOptions, TableOptions, TableRowOptions, TextareaEvents, TextareaOptions, TimePickerHourItem, TimePickerMinuteItem, TimePickerOptions, TimePickerSecondItem, TitleOptions, ToastOptions, TreeEvents, TreeNode, TreeNodeEvents, TreeNodeExtend, TreeNodeModel, TreeNodeOptions, TreeNodeRenderOptions, TreeNodeSlotOptions, TreeOptions, TreeSearchResult, ValueOptions, WrapperEvents, WrapperOptions };