@ng-nest/ui 17.0.12 → 18.0.0

package/core/functions/convert.d.ts

@@ -1,12 +1,85 @@
-import { XData, XParentIdentityProperty, XBoolean, XClassMap } from '../interfaces';
 import { Observable, Subject } from 'rxjs';
+import { WritableSignal } from '@angular/core';
+import type { XData, XParentIdentityProperty, XBoolean, XClassMap, XNumber, XDataArray } from '../interfaces';
+/**
+ * @zh_CN 转换 value 为 boolean 值
+ * @en_US Convert the value to boolean value
+ */
 export declare function XToBoolean(value: XBoolean): boolean;
+/**
+ * @zh_CN 转换 value 为像素值
+ * @en_US Convert the value to pixels
+ */
+export declare function XToCssPixelValue(value: XNumber): string;
+export declare function XToString(value: XNumber): string;
+/**
+ * @zh_CN 转换 value 为 number 值
+ * @en_US Convert the value to Number value
+ */
+export declare function XToNumber(value: XNumber): number;
+export declare function XToNumber<D>(value: XNumber, fallback: D): number | D;
+/**
+ * @zh_CN 转换 value 为指定的 list 数据 [{ label: any; id: any }, ....]
+ * @en_US Convert value as the specified list data [{ label: any; id: any }, ....]
+ */
 export declare function XToDataConvert<T>(value: XData<T>): XData<T>;
+/**
+ * @zh_CN 转换 value 为指定的 list 数据 [{ label: any; id: any }, ....]
+ * @en_US Convert value as the specified list data [{ label: any; id: any }, ....]
+ */
+export declare function XToDataArray<T>(value: XDataArray<T>): T[];
+/**
+ * @zh_CN 根据 data 的类型获取实际的数据
+ * @en_US Obtain actual data based on the type of data
+ */
 export declare function XSetData<T>(data: XData<T>, unSubject: Subject<void>, toConvert?: boolean, funcParam?: any): Observable<T[]>;
+/**
+ * @zh_CN 根据 id、pid 获取子节点
+ * @en_US Obtain sub-nodes based on ID and PID
+ */
 export declare function XGetChildren<T extends XParentIdentityProperty<T>>(nodes: T[], node: T, level: number): T;
+/**
+ * @zh_CN 将对象键值对反转
+ * @en_US Reversal the key value of the object
+ */
 export declare function XInvertKeyValues(obj: any): Map<any, any>;
+/**
+ * @zh_CN 设置样式名称为 false
+ * @en_US Set style name is false
+ */
 export declare function XClearClass(...classMaps: XClassMap[]): void;
-export declare function XInputBoolean(): any;
-export declare function XInputNumber(): any;
-export declare function XDataConvert(): any;
+/**
+ * @zh_CN 设置样式名称为 false
+ * @en_US Set style name is false
+ */
+export declare function XClearClassSignal(...classMaps: WritableSignal<XClassMap>[]): void;
+/**
+ * @zh_CN 属性装饰器返回类型
+ * @en_US Attribute decorator return type
+ */
+export type XPropDecorator = (target: any, propName: string) => void;
+/**
+ * @zh_CN 创建 XInputBoolean 属性装饰器
+ * @en_US Create XInputBoolean Properties
+ */
+export declare function XInputBoolean(): XPropDecorator;
+/**
+ * @zh_CN 创建 XInputNumber 属性装饰器
+ * @en_US Create XInputNumber Properties
+ */
+export declare function XInputNumber(): XPropDecorator;
+/**
+ * @zh_CN 创建 XInputNumber 属性装饰器
+ * @en_US Create XInputNumber Properties
+ */
+export declare function XInputCssPixelValue(): XPropDecorator;
+/**
+ * @zh_CN 创建 XDataConvert 属性装饰器
+ * @en_US Create XDataConvert Properties
+ */
+export declare function XDataConvert(): XPropDecorator;
+/**
+ * @zh_CN 限制给定数值 value 的范围
+ * @en_US Limit the range of the given value value
+ */
 export declare function XClamp(value: number, min: number, max: number): number;

package/core/functions/csspx.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @zh_CN 转换 csspx 为像素宽度
+ * @en_US Convert CSS PX to pixel width
+ */
+export declare function XToCssPx(csspx: string, fontSize: number): number;

package/core/functions/date.d.ts

@@ -1,14 +1,70 @@
+/**
+ * @zh_CN 日期类型
+ * @en_US Date type
+ */
 export type XDate = string | Date | number;
+/**
+ * @zh_CN 转换 Date
+ * @en_US Convert to date
+ */
 export declare function XToDate(date: XDate): Date;
+/**
+ * @zh_CN 日期添加毫秒数，负数为减少
+ * @en_US Add milliseconds to the date, the negative number is reduced
+ */
 export declare function XAddMilliseconds(date: XDate, amount: number): Date;
+/**
+ * @zh_CN 日期添加秒数，负数为减少
+ * @en_US Date adds seconds, the negative number is reduced
+ */
 export declare function XAddSeconds(date: XDate, amount: number): Date;
+/**
+ * @zh_CN 日期添加分钟数，负数为减少
+ * @en_US Date adds minutes, the negative number is reduced
+ */
 export declare function XAddMinutes(date: XDate, amount: number): Date;
+/**
+ * @zh_CN 日期添加小时数，负数为减少
+ * @en_US Date adds hours, the negative number is reduced
+ */
 export declare function XAddHours(date: XDate, amount: number): Date;
+/**
+ * @zh_CN 日期添加天数，负数为减少
+ * @en_US Date adds days, the negative number is reduced
+ */
 export declare function XAddDays(date: XDate, amount: number): Date;
+/**
+ * @zh_CN 日期添加月数，负数为减少
+ * @en_US Date adds monthly number, negative number is reduced
+ */
 export declare function XAddMonths(date: XDate, amount: number): Date;
+/**
+ * @zh_CN 日期添加年数，负数为减少
+ * @en_US The number of years of date, the negative number is reduced
+ */
 export declare function XAddYears(date: XDate, amount: number): Date;
+/**
+ * @zh_CN 获取给定日期的 ISO 周数
+ * @en_US Get the number of ISO weeks of the given date
+ */
 export declare function XDateWeek(date: XDate): number | undefined;
+/**
+ * @zh_CN 获取指定日期的 ISO 周年份
+ * @en_US Get the ISO anniversary of the specified date
+ */
 export declare function XDateWeekYear(date: XDate): number | undefined;
-export declare function XDateYearWeek(date: XDate): string | undefined;
-export declare function XDateYearQuarter(date: XDate): string | undefined;
-export declare function XDateQuarter(date: XDate): string | undefined;
+/**
+ * @zh_CN 获取指定日期的年份和周数
+ * @en_US Get the year and week of the specified date
+ */
+export declare function XDateYearWeek(date: XDate): string;
+/**
+ * @zh_CN 获取指定日期的年份和季度
+ * @en_US Get the year and quarter of the specified date
+ */
+export declare function XDateYearQuarter(date: XDate): string;
+/**
+ * @zh_CN 获取指定日期所属的季度
+ * @en_US Get the season when the specified date belongs
+ */
+export declare function XDateQuarter(date: XDate): string;

package/core/functions/drop.d.ts

@@ -1 +1,13 @@
-export declare function XDrop<T>(array: Array<T>, n?: number): T[];
+/**
+ * @zh_CN 通过参数 n 来截取数组
+ * 如果 n 未定义或为 0，则返回与原数组相同的数组
+ * 如果原数组长度小于 1 或小于等于 n 的绝对值，则返回一个空数组
+ * 如果 n 大于 0，则截取从第 n 个元素开始到数组末尾的子数组
+ * 如果 n 小于等于 0，则截取从第 0 个元素到倒数第 n 个元素
+ * @en_US Send the array by parameter n
+ * If n is not defined or 0, returns the same array as the original array
+ * If the original array length is less than 1 or less than equal to N, return a empty array
+ * If n is greater than 0, cut off the sub-array starting from the nn element to the end of the array
+ * If n is less than or equal to 0, cut off from the 0th element to the countless nary element
+ */
+export declare function XDrop<T>(array: Array<T>, n?: number): Array<T>;

package/core/functions/flex.d.ts

@@ -1,3 +1,7 @@
 import { Renderer2 } from '@angular/core';
 import { XAlign, XDirection, XJustify } from '../interfaces';
+/**
+ * @zh_CN 用于设置元素的 flex 样式
+ * @en_US Flex style for setting elements
+ */
 export declare function XSetFlex(ele: Element, renderer: Renderer2, justify?: XJustify, align?: XAlign, direction?: XDirection): string[];

package/core/functions/group-by.d.ts

@@ -1 +1,5 @@
-export declare function XGroupBy<T>(array: T[], name: string): T[][];
+/**
+ * @zh_CN 根据属性 name 来对数组分组
+ * @en_US Based on the array according to the attribute name
+ */
+export declare function XGroupBy<T>(array: T[], name: string): Array<Array<T>>;

package/core/functions/guid.d.ts

@@ -1,4 +1,5 @@
 /**
- * 生成 GUID
+ * @zh_CN 生成 GUID
+ * @en_US GUID
  */
 export declare function XGuid(): string;

package/core/functions/has-in.d.ts

@@ -1 +1,5 @@
+/**
+ * @zh_CN 判断一个对象是否包含指定的属性
+ * @en_US Determine whether an object contains the specified attribute
+ */
 export declare function XHasIn(object: Object, key: string): boolean;

package/core/functions/order-by.d.ts

@@ -1 +1,5 @@
-export declare function XOrderBy<T>(collection: Array<T>, iteratees: Array<string>, orders?: Array<'asc' | 'desc'>): T[];
+/**
+ * @zh_CN 根据指定元素来排序
+ * @en_US Sort by specified elements
+ */
+export declare function XOrderBy<T>(collection: Array<T>, iteratees: Array<string>, orders?: Array<'asc' | 'desc'>): Array<T>;

package/core/functions/parent-path.d.ts

@@ -1,2 +1,10 @@
+/**
+ * @zh_CN 获取元素的父节点路径
+ * @en_US The parent node of the element
+ */
 export declare function XParentPath(ele: HTMLElement): string[];
+/**
+ * @zh_CN 获取元素的父元素路径
+ * @en_US The parent element path of obtaining elements
+ */
 export declare function XParents(ele: HTMLElement): HTMLElement[];

package/core/functions/property.d.ts

@@ -1,10 +1,16 @@
-import { XClassMap } from '../interfaces';
+import { XComponentConfigKey } from '../config';
 /**
- * 组件公共属性
+ * @zh_CN 组件公共属性
+ * @en_US Component of public properties
  */
 export declare class XProperty {
-    /**
-     * 样式映射属性
-     */
-    classMap: XClassMap;
 }
+/**
+ * @zh_CN 组件公共属性，通过函数返回，注入全局配置
+ * @en_US Component of public properties, through the function returns, into the global configuration
+ */
+export declare function XPropertyFunction<T extends XComponentConfigKey>(configName: T): {
+    new (): {
+        config: import("../config").XComponentConfig[T];
+    };
+};

package/core/functions/public-api.d.ts

@@ -12,3 +12,4 @@ export * from './group-by';
 export * from './resize';
 export * from './parent-path';
 export * from './property';
+export * from './csspx';

package/core/functions/remove.d.ts

@@ -1 +1,5 @@
-export declare function XRemove<T>(array: Array<T>, predicate?: (value: T) => boolean): T[];
+/**
+ * @zh_CN 从数组中移除满足条件的元素，并返回被移除的元素组成的数组
+ * @en_US Remove elements that meet the conditions from the array and return the array of the removal element
+ */
+export declare function XRemove<T>(array: Array<T>, predicate?: (value: T) => boolean): Array<T>;

package/core/functions/resize.d.ts

@@ -1,7 +1,19 @@
 import { Observable } from 'rxjs';
+/**
+ * @zh_CN 监听元素大小边界尺寸的变化
+ * @en_US Monitoring elements of the size of the boundary size
+ */
 export type XResizeObserver = ResizeObserver | null;
+/**
+ * @zh_CN ResizeObserver 回调函数参数的对象
+ * @en_US Object of ResizeobServer's callback function parameter
+ */
 export type XResizeObserverEntry = ResizeObserverEntry | null;
-export declare const XResize: (...element: Element[]) => Observable<{
+/**
+ * @zh_CN 这个函数的功能是创建一个Observable，用于监听多个元素的尺寸变化
+ * @en_US The function of this function is to create an Observable to monitor the size changes of multiple elements.
+ */
+export declare function XResize(...element: Element[]): Observable<{
     entry: XResizeObserverEntry;
     resizeObserver: XResizeObserver;
 }>;

package/core/interfaces/data.type.d.ts

@@ -1,25 +1,194 @@
 import { Observable } from 'rxjs';
 import { TemplateRef, SimpleChange } from '@angular/core';
+import type { InputSignal } from '@angular/core';
+/**
+ * @zh_CN data 数据类型
+ * 通用的泛型数据类型，一般是指数组、可订阅对象并且流数据为数组类型、函数等
+ * @en_US Data data type
+ * General generic data types, generally is index set,
+ * can subscribe to the object and flow data for the array, function, etc
+ */
 export type XData<T> = T[] | Observable<T[] | any[]> | any[] | Function;
+/**
+ * @zh_CN data 数据类型
+ * 通用的泛型数据类型，一般是指数组
+ * @en_US Data data type
+ * General generic data types, generally is index set
+ */
+export type XDataArray<T> = string | number | (T | string | number)[];
+/**
+ * @zh_CN boolean 数据类型
+ * 此类型作为组件的输入参数，一般会使用 `XToBoolean` 转换函数，转换成 true 或 false
+ * @en_US Boolean data type
+ * This type as a component of the input parameters,
+ * usually with `XToBoolean` decorator to process parameters,
+ * directly into true or false
+ * @example
+ *
+ * ```html
+ * // true
+ * <my-component disabled></my-component>
+ * <my-component disabled="true"></my-component>
+ * <my-component [disabled]="true"></my-component>
+ *
+ * // false
+ * <my-component disabled="false"></my-component>
+ * <my-component [disabled]="false"></my-component>
+ * ```
+ *
+ */
 export type XBoolean = boolean | string;
+/**
+ * @zh_CN number 数据类型
+ * 此类型作为组件的输入参数，一般会使用 `XToNumber` 转换函数，转换成数字类型
+ * 如果是宽高尺寸，会通过 `XToCssPixelValue` 转换函数，转换成字符串尺寸
+ * @en_US Number data type
+ * This type as the input parameters of the component, generally use `XToNumber` conversion function, converted to digital type
+ * If the width of the high is through `XToCssPixelValue` conversion function, convert the string size
+ * @example
+ *
+ * ```html
+ * // XToNumber => num = 10
+ * <my-component max="10"></my-component>
+ * <my-component [max]="10"></my-component>
+ * <my-component [max]="'10'"></my-component>
+ *
+ * // XToCssPixelValue
+ * // width = '200px'
+ * <my-component width="200"></my-component>
+ * <my-component width="200px"></my-component>
+ * <my-component [width]="200"></my-component>
+ * <my-component [width]="'200'"></my-component>
+ * <my-component [width]="'200px'"></my-component>
+ * // width = '20rem'
+ * <my-component width="20rem"></my-component>
+ * <my-component [width]="'20rem'"></my-component>
+ * // width = '50%'
+ * <my-component width="50%"></my-component>
+ * <my-component [width]="'50%'"></my-component>
+ * ```
+ *
+ */
 export type XNumber = number | string;
+/**
+ * @zh_CN 模板类型
+ * 一般会配合 `outlet` 指令来指定一个参数即可为基本数据类型，也可为模板
+ * @en_US Template type
+ * Usually cooperate `outlet` instructions to specify a parameter can be as the basic data types, can also be used as a template
+ * @example
+ *
+ * ```html
+ * // label = "string"
+ * <ng-container *xOutlet="label">{{ label }}</ng-container>
+ *
+ * <ng-container *xOutlet="labelTpl">{{ labelTpl }}</ng-container>
+ * <ng-template #labelTpl>this is a label template</ng-template>
+ * ```
+ *
+ */
 export type XTemplate = string | number | Date | TemplateRef<any>;
-export declare const XIsType: (type: string) => (object: any) => boolean;
-export declare const XIsChange: (...changes: SimpleChange[]) => boolean;
+/**
+ * @zh_CN 函数返回类型
+ * @en_US Function return type
+ */
+export type XTypeFunc = (object: any) => boolean;
+/**
+ * @zh_CN 类型判断
+ * @en_US Type judgment
+ */
+export declare function XIsType(type: string): XTypeFunc;
+/**
+ * @zh_CN 值改变判断
+ * @en_US Value change judgment
+ */
+export declare function XIsChange(...changes: SimpleChange[]): boolean;
+/**
+ * @zh_CN 判断给定的值是否为字符串类型
+ * @en_US Determine whether the given value is a string type
+ */
 export declare function XIsString(value: any): value is string;
-export declare function XIsArray(value: any): value is Array<any>;
+/**
+ * @zh_CN 判断给定的值是否为数组类型
+ * @en_US Determine whether the given value is a array type
+ */
+export declare function XIsArray<T>(value: any): value is Array<T>;
+/**
+ * @zh_CN 判断给定的值是否为数字类型
+ * @en_US Determine whether the given value is a number type
+ */
 export declare function XIsNumber(value: any): value is number;
+/**
+ * @zh_CN 判断给定的值是否为布尔类型
+ * @en_US Determine whether the given value is a boolean type
+ */
 export declare function XIsBoolean(value: any): value is boolean;
+/**
+ * @zh_CN 判断给定的值是否为对象类型
+ * @en_US Determine whether the given value is a object type
+ */
 export declare function XIsObject<T>(value: any): value is T;
+/**
+ * @zh_CN 判断给定的值是否为 null 类型
+ * @en_US Determine whether the given value is a null type
+ */
 export declare function XIsNull(value: any): value is null;
+/**
+ * @zh_CN 判断给定的值是否为函数类型
+ * @en_US Determine whether the given value is a function type
+ */
 export declare function XIsFunction(value: any): value is Function;
+/**
+ * @zh_CN 判断给定的值是否为日期类型
+ * @en_US Determine whether the given value is a date type
+ */
 export declare function XIsDate(value: any): value is Date;
+/**
+ * @zh_CN 判断给定的值是否为正则表达式
+ * @en_US Determine whether the given value is a regular expression
+ */
 export declare function XIsRegExp(value: any): value is RegExp;
+/**
+ * @zh_CN 判断给定的值是否为 undefined
+ * @en_US Determine whether the given value is undefined
+ */
 export declare function XIsUndefined(value: any): value is undefined;
+/**
+ * @zh_CN 判断给定的值是否为字符串、数字、布尔值或日期
+ * @en_US Determine whether the given value is a string, number, Boolean value or date
+ */
 export declare function XIsValue<T>(object: any): object is T;
+/**
+ * @zh_CN 判断一个对象是否为空
+ * @en_US Determine whether an object is empty
+ */
 export declare function XIsEmpty(object: any): boolean;
+/**
+ * @zh_CN 判断给定的对象是否为非空数组
+ * @en_US Determine whether the given object is a non -empty array
+ */
 export declare function XIsValueArray<T>(object: any): object is T;
+/**
+ * @zh_CN 判断给定的对象是否为非空对象数组
+ * @en_US Determine whether the given object is a non -empty object array
+ */
 export declare function XIsObjectArray<T>(object: any): object is T;
+/**
+ * @zh_CN 判断给定的对象是否为 Observable
+ * @en_US Determine whether the given object is observable
+ */
 export declare function XIsObservable<T>(object: any): object is Observable<T>;
+/**
+ * @zh_CN 判断给定的对象是否为 TemplateRef
+ * @en_US Determine whether the given object is TemplateRef
+ */
 export declare function XIsTemplateRef<T>(object: any): object is TemplateRef<T>;
+/**
+ * @zh_CN 判断给定的对象是否为 XTemplateRef
+ * @en_US Determine whether the given object is XTemplateRef
+ */
 export declare function XIsXTemplate(object: any): object is XTemplate;
+/**
+ * @zh_CN 判断给定的对象是否为 InputSignal
+ * @en_US Determine whether a given object for InputSignal
+ */
+export declare function XIsInputSignal(object: any): object is InputSignal<any>;

package/core/interfaces/identify.type.d.ts

@@ -1,18 +1,78 @@
+/**
+ * @zh_CN 标识对象
+ * @en_US Identify object
+ */
 export interface XIdentityProperty {
+    /**
+     * @zh_CN 编码
+     * @en_US Id
+     */
     id?: any;
+    /**
+     * @zh_CN 标签
+     * @en_US Label
+     */
     label?: any;
 }
+/**
+ * @zh_CN 父节点标识对象
+ * @en_US Father node identification object
+ */
 export interface XParentIdentityProperty<T> extends XIdentityProperty {
+    /**
+     * @zh_CN 父节点编码
+     * @en_US Parent Id
+     */
     pid?: any;
+    /**
+     * @zh_CN 层级
+     * @en_US Level
+     */
     level?: number;
+    /**
+     * @zh_CN 叶子节点
+     * @en_US Leaf node
+     */
     leaf?: boolean;
+    /**
+     * @zh_CN 子节点
+     * @en_US Children node
+     */
     children?: T[];
+    /**
+     * @zh_CN 子节点已加载过
+     * @en_US Sub node has been loaded
+     */
     childrenLoaded?: boolean;
+    /**
+     * @zh_CN 选中
+     * @en_US Selected
+     */
     selected?: boolean;
+    /**
+     * @zh_CN 禁用
+     * @en_US Disabled
+     */
     disabled?: boolean;
+    /**
+     * @zh_CN 展开
+     * @en_US open
+     */
     open?: boolean;
 }
+/**
+ * @zh_CN 标识对象
+ * @en_US Identify object
+ */
 export declare class XIdentity {
+    /**
+     * @zh_CN 编码
+     * @en_US Id
+     */
     id?: any;
+    /**
+     * @zh_CN 标签
+     * @en_US Label
+     */
     label?: any;
 }