🤖 Merge PR DefinitelyTyped#74646 feat(types/layui): Update typings to v2.13.4 by @Sight-wcg

Author: Sight-wcg

types/layui/index.d.ts

@@ -1,20 +1,26 @@
 /// <reference types="jquery" />
+/// <reference path="modules/breadcrumb.d.ts" />
 /// <reference path="modules/carousel.d.ts" />
 /// <reference path="modules/code.d.ts" />
+/// <reference path="modules/collapse.d.ts" />
 /// <reference path="modules/colorpicker.d.ts" />
 /// <reference path="modules/component.d.ts" />
 /// <reference path="modules/dropdown.d.ts" />
 /// <reference path="modules/element.d.ts" />
 /// <reference path="modules/flow.d.ts" />
 /// <reference path="modules/form.d.ts" />
+/// <reference path="modules/i18n.d.ts" />
 /// <reference path="modules/lay.d.ts" />
 /// <reference path="modules/laydate.d.ts" />
 /// <reference path="modules/layedit.d.ts" />
 /// <reference path="modules/layer.d.ts" />
 /// <reference path="modules/laypage.d.ts" />
 /// <reference path="modules/laytpl.d.ts" />
+/// <reference path="modules/nav.d.ts" />
+/// <reference path="modules/progress.d.ts" />
 /// <reference path="modules/rate.d.ts" />
 /// <reference path="modules/slider.d.ts" />
+/// <reference path="modules/tab.d.ts" />
 /// <reference path="modules/table.d.ts" />
 /// <reference path="modules/tabs.d.ts" />
 /// <reference path="modules/transfer.d.ts" />
@@ -28,19 +34,11 @@
 declare const layui: Layui;
 declare const lay: Layui.LayStatic;
 declare const layer: Layui.Layer;
-/**
- * 动态加载等特殊场景设置 layui 目录
- * @since 2.6.6
- */
-declare const LAYUI_GLOBAL: { dir: string };
+declare const LAYUI_GLOBAL: Layui.GlobalProperties;
 
 interface Window {
     layui: Layui;
     lay: Layui.LayStatic;
     layer: Layui.Layer;
-    /**
-     * 动态加载等特殊场景设置 layui 目录
-     * @since 2.6.6
-     */
-    LAYUI_GLOBAL: { dir: string };
+    LAYUI_GLOBAL: Layui.GlobalProperties;
 }

types/layui/misc.d.ts

@@ -18,12 +18,33 @@ declare namespace Layui {
     };
     type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
     type LiteralStringUnion<T> = LiteralUnion<T, string>;
+    type ObjectPathLeaf = Primitive | AnyFn | Date | Array<any>;
+    type DeepPath<T, Prefix extends string = ""> = {
+        [K in keyof T & string]: T[K] extends ObjectPathLeaf ? `${Prefix}${K}`
+            : T[K] extends object ? DeepPath<T[K], `${Prefix}${K}.`>
+            : never;
+    }[keyof T & string];
+    type DeepType<T, Path extends string> = Path extends `${infer Key}.${infer Rest}`
+        ? Key extends keyof T ? DeepType<T[Key], Rest>
+        : T extends any[] ? DeepType<T[number], Rest>
+        : never
+        : Path extends keyof T ? T[Path]
+        : T extends any[] ? T[number]
+        : never;
+    type DeepPartial<T> = T extends AnyFn ? T
+        : T extends Date ? T
+        : T extends Array<infer U> ? Array<DeepPartial<U>>
+        : T extends Map<infer K, infer V> ? Map<K, DeepPartial<V>>
+        : T extends Set<infer U> ? Set<DeepPartial<U>>
+        : T extends object ? { [P in keyof T]?: DeepPartial<T[P]> }
+        : T;
 
     type Selector = string;
     type ExportsCallback = (this: Layui, fn: (app: string, exports: object) => void) => void;
 
     /**
-     * 全局属性
+     * 全局配置选项
+     * layui.config(options)
      */
     interface GlobalConfigOptions {
         /**
@@ -44,6 +65,22 @@ declare namespace Layui {
         base?: string;
     }
 
+    /**
+     * window.LAYUI_GLOBAL
+     */
+    interface GlobalProperties {
+        /**
+         * 动态加载等特殊场景设置 layui 目录
+         * @since 2.6.6
+         */
+        dir?: string;
+        /**
+         * 国际化消息对象
+         * @since 2.13.0
+         */
+        i18n?: I18nMessages;
+    }
+
     /**
      * 缓存的所有数据
      */
@@ -98,6 +135,12 @@ declare namespace Layui {
          * @internal
          */
         all: any;
+        /**
+         * 面包屑
+         * @see https://layui.dev/docs/2/nav/#separator
+         * @since 2.13.0
+         */
+        breadcrumb: Breadcrumb;
         /**
          * 轮播
          * @see https://layui.dev/docs/2/carousel/
@@ -108,6 +151,12 @@ declare namespace Layui {
          * @see https://layui.dev/docs/2/code/
          */
         code: Code;
+        /**
+         * 折叠面板
+         * @see https://layui.dev/docs/2/panel/
+         * @since 2.13.0
+         */
+        collapse: Collapse;
         /**
          * 颜色选择器
          * @see https://layui.dev/docs/2/colorpicker/
@@ -132,7 +181,7 @@ declare namespace Layui {
          * @see https://layui.dev/docs/2/progress/ - 进度条
          * @see https://layui.dev/docs/2/nav/#separator - 面包屑
          */
-        element: Element;
+        element: LayElement;
         /**
          * 流加载
          * @see https://layui.dev/docs/2/flow/
@@ -181,6 +230,18 @@ declare namespace Layui {
          * @internal
          */
         "layui.all": string;
+        /**
+         * 导航栏
+         * @see https://layui.dev/docs/2/nav/
+         * @since 2.13.0
+         */
+        nav: Nav;
+        /**
+         * 进度条
+         * @see https://layui.dev/docs/2/progress/
+         * @since 2.13.0
+         */
+        progress: Progress;
         /**
          * 评分
          * @see https://layui.dev/docs/2/rate/
@@ -192,6 +253,13 @@ declare namespace Layui {
          * @see https://layui.dev/docs/2/slider/
          */
         slider: Slider;
+        /**
+         * 选项卡
+         * @see https://layui.dev/docs/2/tab/
+         * @since 2.13.0
+         * @deprecated 已废弃，使用 {@link Tabs}
+         */
+        tab: Tab;
         /**
          * 表格
          * @see https://layui.dev/docs/2/table
@@ -230,6 +298,12 @@ declare namespace Layui {
          * @see https://layui.dev/docs/2/util/
          */
         util: Util;
+        /**
+         * 国际化
+         * @see https://layui.dev/docs/2/i18n/
+         * @since 2.12.0
+         */
+        i18n: I18n;
     }
 
     /**

types/layui/modules/breadcrumb.d.ts

@@ -0,0 +1,24 @@
+declare namespace Layui {
+    interface BreadcrumbOptions {
+        /**
+         * 组件渲染指定的目标元素选择器或 DOM 对象
+         */
+        elem: string | HTMLElement | JQuery;
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-empty-interface
+    class BreadcrumbClass extends Component<BreadcrumbOptions> {
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-empty-interface
+    interface BreadcrumbReturn extends ComponentReturn<BreadcrumbOptions> {
+    }
+
+    interface Breadcrumb extends ComponentInterface<BreadcrumbOptions, BreadcrumbClass, BreadcrumbReturn> {
+        /**
+         * 渲染面包屑组件
+         * @param options 面包屑组件的配置选项
+         */
+        render(options: BreadcrumbOptions): BreadcrumbReturn;
+    }
+}

types/layui/modules/carousel.d.ts

@@ -91,7 +91,7 @@ declare namespace Layui {
         item: JQuery;
     }
 
-    interface CarouselClass {
+    class CarouselClass extends Component<CarouselOptions> {
         /**
          * 配置属性
          */
@@ -175,28 +175,34 @@ declare namespace Layui {
         goto(index: number): void;
     }
 
+    interface CarouselReturn extends ComponentReturn<CarouselOptions> {
+        /**
+         * 切换到指定的索引
+         * @param index 轮播下标，从 0 开始计算
+         * @since 2.8.0
+         */
+        goto(index: number): void;
+        elemInd: any;
+        elemItem: any;
+        timer: any;
+    }
+
     /**
      * 轮播
      * @see https://layui.dev/docs/2/carousel/
+     * @since 2.13.0 之后继承自 Component 组件
      */
-    interface Carousel {
-        config: Required<CarouselOptions>;
+    interface Carousel extends ComponentInterface<CarouselOptions, CarouselClass, CarouselReturn> {
         /**
          * 渲染方法
          * @param options 基础参数
-         * @return 实例对象，包含操作当前实例的相关成员方法
          */
-        render(options: CarouselOptions): CarouselClass;
+        render(options: CarouselOptions): CarouselReturn;
         /**
          * 绑定切换事件
          * @param event  事件
          * @param callback  回调
          */
         on(event: string, callback: (this: CarouselClass, obj: CarouselItem) => any): any;
-        /**
-         * 设置轮播组件的全局参数
-         * @param options 基础参数
-         */
-        set(options: Partial<CarouselOptions>): this;
     }
 }

types/layui/modules/code.d.ts

@@ -196,6 +196,55 @@ declare namespace Layui {
          * @since 2.8.18
          */
         code?: string;
+        /**
+         * 设置行高亮
+         * @since 2.12.0
+         */
+        highlightLine?: {
+            /**
+             * 高亮
+             */
+            hl?: CodeHighlightLineOptions;
+            /**
+             * diff++
+             */
+            "++"?: CodeHighlightLineOptions;
+            /**
+             * diff--
+             */
+            "--"?: CodeHighlightLineOptions;
+            /**
+             * 聚焦
+             */
+            focus?: CodeHighlightLineOptions;
+        } & Record<string, CodeHighlightLineOptions>;
+    }
+
+    interface CodeHighlightLineOptions {
+        /**
+         * 高亮范围，不可全局设置值
+         * @example
+         * '1,3-5,8'
+         */
+        range: string;
+        /**
+         * 是否解析行内的特定高亮注释。出于性能考虑，不建议全局开启。
+         *
+         * 注释格式：`[!code <type>:<lines>]`
+         * - `<type>` : `highlightLine` 的可选项，如 `hl, focus` 等
+         * - `<lines>` : 行数（含本行）
+         */
+        comment?: boolean;
+        /**
+         * 添加到高亮行上的类
+         * @internal
+         */
+        classActiveLine?: string;
+        /**
+         * 有高亮行时向根元素添加的类
+         * @internal
+         */
+        classActivePre?: string;
     }
 
     interface CodeReturn {

types/layui/modules/collapse.d.ts

@@ -0,0 +1,34 @@
+declare namespace Layui {
+    interface CollapseOptions {
+        /**
+         * 组件渲染指定的目标元素选择器或 DOM 对象
+         */
+        elem: string | HTMLElement | JQuery;
+    }
+
+    interface CollapseEventMap {
+        /**
+         * 折叠面板点击事件
+         * @param data 事件对象
+         * - `title` 折叠面板标题元素
+         * - `content` 折叠面板内容元素
+         * - `show` 折叠面板是否展开，true 为展开状态，false 为收起状态
+         */
+        collapse(this: HTMLElement, data: { title: JQuery; content: JQuery; show: boolean }): void;
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-empty-interface
+    class CollapseClass extends Component<CollapseOptions> {
+    }
+    // eslint-disable-next-line @typescript-eslint/no-empty-interface
+    interface CollapseReturn extends ComponentReturn<CollapseOptions> {
+    }
+
+    interface Collapse extends ComponentInterface<CollapseOptions, CollapseClass, CollapseReturn> {
+        /**
+         * 渲染折叠面板组件
+         * @param options 折叠面板组件的配置选项
+         */
+        render(options: CollapseOptions): CollapseReturn;
+    }
+}

types/layui/modules/colorpicker.d.ts

@@ -71,25 +71,16 @@ declare namespace Layui {
     /**
      * 颜色选择器
      * @see https://layui.dev/docs/2/colorpicker/
+     * @since 2.13.0 之后继承自 Component 组件
      */
-    interface ColorPicker {
-        config: Record<string, any>;
-        index: number;
+    interface ColorPicker
+        extends
+            ComponentInterface<ColorPickerOptions, Component<ColorPickerOptions>, ComponentReturn<ColorPickerOptions>>
+    {
         /**
          * colorpicker 组件渲染方法
          * @param option 属性选项
          */
-        render(option: ColorPickerOptions): ColorPicker;
-        /**
-         * 全局设置
-         * @param option 属性选项
-         */
-        set(option: ColorPickerOptions): ColorPicker;
-        /**
-         * 绑定切换事件
-         * @param event 事件名
-         * @param callback 回调函数
-         */
-        on(event: string, callback: (this: Layui, params: any) => any): any;
+        render(option: ColorPickerOptions): ComponentReturn<ColorPickerOptions>;
     }
 }