snail.vue 2.0.10 → 2.0.11

package/dist/snail.vue.d.ts

@@ -265,18 +265,6 @@ type ScrollOptions = {
      * - none ：无，不显示滚动条，但仍然能够滚动
      */
     barSize?: "normal" | "small" | "mini" | "none";
-    /**
-     * 滚动条模式
-     * - auto（默认值）：自动，内容溢出时自动显示滚动条
-     * - hover：鼠标进入时才显示滚动条
-     */
-    barMode?: "auto" | "hover";
-    /**
-     * 滚动条防抖处理
-     * - 垂直滚动条在【有-无】之间变化时，会导致内容width变化，从而产生抖动
-     * - 为true时，会给滚动条方向一个处理padding值，从而实现防抖效果
-     */
-    debounce?: boolean;
 };
 /**
  * 滚动视图事件
@@ -905,54 +893,6 @@ type SortEvent = {
     newIndex: number | undefined;
 };
 
-/**
- * 布局组件 数据结构
- */
-
-/**
- * 布局组件配置选项
- */
-type LayoutOptions = {
-    /**
-     * 布局模式：水平，还是垂直
-     */
-    mode: "horizontal" | "vertical";
-    /**
-     * 滚动相关配置
-     * - 中部区域的配置
-     */
-    scroll?: ScrollOptions;
-};
-
-/**
- * 折叠面板配置选项
- * - title          折叠面板标题
- * - disabled       禁用折叠效果，始终展开
- */
-type FoldOptions = DisabledOptions & TitleOptions & {
-    /**
-     * 副标题
-     * - 跟随在title后
-     */
-    subtitle?: string;
-};
-/**
- * 折叠状态
- * - expand ： 展开状态
- * - fold   ： 折叠状态
- */
-type FoldStatus = "expand" | "fold";
-/**
- * 折叠面板事件
- */
-type FoldEvents = {
-    /**
-     * 折叠状态发生改变时
-     * @param status 折叠状态
-     */
-    change: [status: FoldStatus];
-};
-
 /**
  * 组件配置选项
  */
@@ -989,6 +929,12 @@ type PropsType<Props> = Props extends Record<string, any> ? Props : undefined;
 type EmitterType<Events extends Record<string, any[]>> = {
     <K extends keyof Events>(event: K, ...payload: Events[K]): any;
 };
+/**
+ * 提取【组件插槽】类型
+ */
+type SlotsType<Slots extends Record<string, any>> = {
+    [key in keyof Slots]: (props: Slots[key]) => any;
+};
 /**
  * 提取【组件事件】类型
  * - 将【组件事件】中的key首字母小写，追加上on前缀；key对应的value为监听函数参数
@@ -1018,6 +964,113 @@ type ComponentBindOptions<Props = void, Model = void> = {
     model?: Model extends (void | never | null | undefined) ? undefined : (ShallowRef<Model> | Ref<Model>);
 };
 
+/**
+ * 布局组件 数据结构
+ */
+
+/**
+ * 布局组件 配置选项
+ */
+type LayoutOptions = {
+    /**
+     * 布局模式
+     * - horizontal 水平布局：左中右
+     * - vertical 垂直布局：上中下
+     * - 默认为 `horizontal`
+     */
+    mode?: "horizontal" | "vertical";
+    /**
+     * 内容区域配置
+     * - 对应插槽名：default；主要内容显示区域，处于布局中的【中】区域
+     * - 配置主内容区域的滚动条配置
+     */
+    default?: Pick<LayoutAraeOptions<void>, "scroll">;
+    /**
+     * 【左侧】区域配置
+     * - 对应插槽名`left` ；`mode` 为 `horizontal` 时生效
+     * - 配置滚动条和宽度；宽度不配置时，默认 `fit-content`
+     * -
+     */
+    left?: LayoutAraeOptions<WidthStyle>;
+    /**
+     * 【右测】区域配置
+     * - 对应插槽名`right` ；`mode` 为 `horizontal` 时生效
+     * - 配置滚动条和宽度；宽度不配置时，默认 `fit-content`
+     */
+    right?: LayoutAraeOptions<WidthStyle>;
+    /**
+     * 【顶部】区域配置
+     * - 对应插槽名`top`；`mode` 为 `vertical` 时生效
+     * - 配置滚动条和高度；高度不配置时，默认 `fit-content`
+     * -
+     */
+    top?: LayoutAraeOptions<HeightStyle>;
+    /**
+     * 【底部】区域配置
+     * - 对应插槽名`bottom`；`mode` 为 `vertical` 时生效
+     * - 配置滚动条和高度；高度不配置时，默认 `fit-content`
+     */
+    bottom?: LayoutAraeOptions<HeightStyle>;
+};
+/**
+ * 布局组件子区域 配置选项
+ */
+type LayoutAraeOptions<Style extends WidthStyle | HeightStyle | void> = Style & {
+    /**
+     * 滚动视图配置
+     * - 视图属性：滚动条大小、显示时机
+     * - 滚动事件：滚动条显隐、滚动到顶部、底部、、、
+     * - 不传入则当前区域`overflow:hidden`溢出隐藏
+     */
+    scroll?: ScrollOptions & EventsType<ScrollEvents>;
+};
+/**
+ * 布局组件的子区域项目 描述
+ */
+type LayoutAreaItem = {
+    /**
+     * 是否可滚动
+     */
+    scrollable: boolean;
+    /**
+     * 内容区域元素的类样式名
+     */
+    class: string;
+    /**
+     * css样式
+     */
+    style: Record<string, string>;
+};
+
+/**
+ * 折叠面板配置选项
+ * - title          折叠面板标题
+ * - disabled       禁用折叠效果，始终展开
+ */
+type FoldOptions = DisabledOptions & TitleOptions & {
+    /**
+     * 副标题
+     * - 跟随在title后
+     */
+    subtitle?: string;
+};
+/**
+ * 折叠状态
+ * - expand ： 展开状态
+ * - fold   ： 折叠状态
+ */
+type FoldStatus = "expand" | "fold";
+/**
+ * 折叠面板事件
+ */
+type FoldEvents = {
+    /**
+     * 折叠状态发生改变时
+     * @param status 折叠状态
+     */
+    change: [status: FoldStatus];
+};
+
 /**
  * 选项菜单 基础配置选项
  */
@@ -2771,7 +2824,7 @@ declare const components: {
         };
     });
     Layout: {
-        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<LayoutOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {}, false, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
+        new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<LayoutOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, vue.PublicProps, {}, true, {}, {}, vue.GlobalComponents, vue.GlobalDirectives, string, {}, any, vue.ComponentProvideOptions, {
             P: {};
             B: {};
             D: {};
@@ -2783,13 +2836,7 @@ declare const components: {
         __isTeleport?: never;
         __isSuspense?: never;
     } & vue.ComponentOptionsBase<Readonly<LayoutOptions> & Readonly<{}>, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, {}, {}, string, {}, vue.GlobalComponents, vue.GlobalDirectives, string, vue.ComponentProvideOptions> & vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps & (new () => {
-        $slots: {
-            start?: (props: {}) => any;
-        } & {
-            default?: (props: {}) => any;
-        } & {
-            end?: (props: {}) => any;
-        };
+        $slots: SlotsType<Pick<LayoutOptions, "default" | "left" | "right" | "bottom" | "top">>;
     });
     Scroll: {
         new (...args: any[]): vue.CreateComponentPublicInstanceWithMixins<Readonly<ScrollOptions> & Readonly<{
@@ -3142,4 +3189,4 @@ declare const components: {
 };
 
 export { components, getSvgDraw, mount, onAppCreated, triggerAppCreated, usePicker, usePopup, useReactive, useTreeContext };
-export type { ButtonOptions, ChangeEvents, ChooseEvents, ChooseItem, ChooseOptions, ClickEvents, CloseEvents, ComponentBindOptions, ComponentOptions, ConfirmAreaOptions, ConfirmOptions, DatePickerEvents, DatepickerOptions, DatetimePickerEvents, DeleteEvents, DialogHandle, DialogOptions, DisabledOptions, DragVerifyInfo, DragVerifyOptions, EmitterType, EmptyOptions, EventsType, FoldEvents, FoldOptions, FoldStatus, FollowElectResult, FollowExtend, FollowHandle, FollowOptions, FollowStrategy, FollowStrategyOptions, FooterEvents, FooterOptions, HeaderEvents, HeaderOptions, INumberFormatter, IPickerManager, IPopupManager, IReactiveManager, ISelectContext, ITreeBaseContext, IconOptions, IconType, InputEvents, InputOptions, LayoutOptions, LoadingOptions, MessageOptions, MoveEvents, NumberBaseOptions, NumberEvents, NumberFormatResult, NumberOptions, PlaceholderOptions, PopupDescriptor, PopupHandle, PopupOptions, PopupStatus, PopupStatusOptions, PropsType, ReactiveVar, ReadonlyOptions, ScrollEvents, ScrollOptions, ScrollStatus, SearchEvents, SearchOptions, SelectBaseEvents, SelectBaseOptions, SelectEvents, SelectItem, SelectNodeEvents, SelectNodeOptions, SelectOptions, SelectPopupEvents, SelectPopupExtend, SelectPopupOptions, SelectSlotOptions, SortEvent, SortEvents, SortGroupHook, SortGroupOptions, SortOptions, SwitchEvents, SwitchOptions, TableColOptions, TableOptions, TableRowOptions, TextareaEvents, TextareaOptions, TimePickerOptions, TitleOptions, ToastOptions, TransitionEffectOptions, TransitionOptions, TreeEvents, TreeNode, TreeNodeEvents, TreeNodeExtend, TreeNodeModel, TreeNodeOptions, TreeNodeRenderOptions, TreeNodeSlotOptions, TreeOptions, TreeSearchResult, ValueOptions, WrapperEvents, WrapperOptions };
+export type { ButtonOptions, ChangeEvents, ChooseEvents, ChooseItem, ChooseOptions, ClickEvents, CloseEvents, ComponentBindOptions, ComponentOptions, ConfirmAreaOptions, ConfirmOptions, DatePickerEvents, DatepickerOptions, DatetimePickerEvents, DeleteEvents, DialogHandle, DialogOptions, DisabledOptions, DragVerifyInfo, DragVerifyOptions, EmitterType, EmptyOptions, EventsType, FoldEvents, FoldOptions, FoldStatus, FollowElectResult, FollowExtend, FollowHandle, FollowOptions, FollowStrategy, FollowStrategyOptions, FooterEvents, FooterOptions, HeaderEvents, HeaderOptions, INumberFormatter, IPickerManager, IPopupManager, IReactiveManager, ISelectContext, ITreeBaseContext, IconOptions, IconType, InputEvents, InputOptions, LayoutAraeOptions, LayoutAreaItem, LayoutOptions, LoadingOptions, MessageOptions, MoveEvents, NumberBaseOptions, NumberEvents, NumberFormatResult, NumberOptions, PlaceholderOptions, PopupDescriptor, PopupHandle, PopupOptions, PopupStatus, PopupStatusOptions, PropsType, ReactiveVar, ReadonlyOptions, ScrollEvents, ScrollOptions, ScrollStatus, 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, TimePickerOptions, TitleOptions, ToastOptions, TransitionEffectOptions, TransitionOptions, TreeEvents, TreeNode, TreeNodeEvents, TreeNodeExtend, TreeNodeModel, TreeNodeOptions, TreeNodeRenderOptions, TreeNodeSlotOptions, TreeOptions, TreeSearchResult, ValueOptions, WrapperEvents, WrapperOptions };