@ng-nest/ui 17.0.11 → 18.0.0

package/core/config/config.d.ts

@@ -1,13 +1,29 @@
-import { XSize, XBoolean, XType, XEffect, XNumber, XPositionLeftRight, XJustify, XShape, XFit, XShadow, XTrigger, XDisplayDirection, XCorner, XDirection, XPlace, XPosition, XPlacement, XPositionTopBottom, XStatus, XAlign, XTemplate } from '../interfaces';
 import { InjectionToken } from '@angular/core';
-import { XTheme } from '../theme';
+import type { XTheme } from '../theme';
+import type { XSize, XType, XEffect, XNumber, XPositionLeftRight, XJustify, XShape, XFit, XShadow, XTrigger, XDisplayDirection, XCorner, XDirection, XPlace, XPosition, XPlacement, XPositionTopBottom, XStatus, XAlign, XTemplate, XStyleMap } from '../interfaces';
+/**
+ * @zh_CN 组件和主题全局配置信息
+ * @en_US Component and theme global configuration information
+ */
 export interface XConfig {
+    /**
+     * @zh_CN 组件配置信息
+     * @en_US Component configuration information
+     */
     components?: XComponentConfig;
+    /**
+     * @zh_CN 主题全配置信息
+     * @en_US theme configuration information
+     */
     theme?: XTheme;
 }
 export type XConfigKey = keyof XConfig;
 export type XComponentConfigKey = keyof XComponentConfig;
 export declare const X_CONFIG: InjectionToken<XConfig>;
+/**
+ * @zh_CN 组件全局配置
+ * @en_US Global configuration of the component
+ */
 export interface XComponentConfig {
     affix?: XAffixConfig;
     alert?: XAlertConfig;
@@ -102,16 +118,19 @@ export interface XAffixConfig {
 }
 export interface XAlertConfig {
     effect?: XEffect;
-    hideClose?: XBoolean;
-    showIcon?: XBoolean;
-    disabledAnimation?: XBoolean;
-    draggable?: XBoolean;
-    resizable?: XBoolean;
-    dragHandleTitle?: XBoolean;
-    duration?: XNumber;
+    hideClose?: boolean;
+    showIcon?: boolean;
+    disabledAnimation?: boolean;
+    draggable?: boolean;
+    resizable?: boolean;
+    dragHandleTitle?: boolean;
+    duration?: number;
+    minWidth?: string;
+    minHeight?: string;
 }
 export interface XAnchorConfig {
     affixTop?: string;
+    affixBottom?: string;
     affixWidth?: string;
     layout?: XPositionLeftRight;
     justify?: XJustify;
@@ -120,7 +139,7 @@ export interface XAvatarConfig {
     size?: XSize;
     shape?: XShape;
     fit?: XFit;
-    gap?: number;
+    gap?: string;
     backgroundColor?: string;
 }
 export interface XAutoCompleteConfig {
@@ -134,7 +153,7 @@ export interface XAutoCompleteConfig {
 export interface XBackTopConfig {
     right?: string;
     bottom?: string;
-    visibilityHeight?: XNumber;
+    visibilityHeight?: number;
 }
 export interface XBadgeConfgig {
     type?: XType;
@@ -142,14 +161,18 @@ export interface XBadgeConfgig {
 export interface XButtonConfig {
     size?: XSize;
     type?: XType;
-    plain?: XBoolean;
-    round?: XBoolean;
-    circle?: XBoolean;
+    plain?: boolean;
+    round?: boolean;
+    circle?: boolean;
+    flat?: boolean;
+    text?: boolean;
     attrType?: 'submit' | 'button' | 'reset';
 }
 export interface XButtonsConfig {
-    space?: XNumber;
-    hiddenBorder?: XBoolean;
+    space?: string;
+    hiddenBorder?: boolean;
+    boxShadow?: boolean;
+    round?: boolean;
 }
 export interface XCalendarConfig {
 }
@@ -167,55 +190,58 @@ export interface XCascadeConfig {
     size?: XSize;
     bordered?: boolean;
     nodeTrigger?: XTrigger;
-    nodeHoverDelay?: XNumber;
+    nodeHoverDelay?: number;
 }
 export interface XCheckboxConfig {
     size?: XSize;
 }
 export interface XCollapseConfig {
-    showIcon?: Boolean;
-    ghost?: Boolean;
+    showIcon?: boolean;
+    ghost?: boolean;
     iconPosition?: 'left' | 'right';
-    bordered?: Boolean;
+    bordered?: boolean;
 }
 export interface XColorConfig {
     merge?: string;
-    amounts?: string;
+    amounts?: number[];
 }
 export interface XColorPickerConfig {
     placement?: XCorner;
+    size?: XSize;
+    bordered?: boolean;
 }
 export interface XCommentConfig {
     contentMax?: number;
+    maxlength?: number;
 }
 export interface XContainerConfig {
     direction?: XDirection;
 }
 export interface XHeaderConfig {
-    height?: number;
+    height?: string;
 }
 export interface XAsideConfig {
-    width?: number;
+    width?: string;
 }
 export interface XFooterConfig {
-    height?: number;
+    height?: string;
 }
 export interface XCrumbComfig {
     separator?: string;
 }
 export interface XDatePickerConfig {
     format?: string;
-    clearable?: XBoolean;
+    clearable?: boolean;
     placement?: XCorner;
     size?: XSize;
     bordered?: boolean;
 }
 export interface XDateRangeConfig {
     format?: string;
-    clearable?: XBoolean;
+    clearable?: boolean;
     placement?: XCorner;
     size?: XSize;
-    bordered?: XBoolean;
+    bordered?: boolean;
 }
 export interface XDialogConfig {
     placement?: XPlace;
@@ -223,32 +249,35 @@ export interface XDialogConfig {
     width?: string;
     minWidth?: string;
     minHeight?: string;
+    maxWidth?: string;
+    maxHeight?: string;
     effect?: XEffect;
-    showCancel?: XBoolean;
+    showCancel?: boolean;
     cancelText?: string;
-    showConfirm?: XBoolean;
+    showConfirm?: boolean;
     confirmText?: string;
-    backdropClose?: XBoolean;
-    draggable?: XBoolean;
-    resizable?: XBoolean;
-    maximize?: XBoolean;
-    hasBackdrop?: XBoolean;
+    backdropClose?: boolean;
+    draggable?: boolean;
+    resizable?: boolean;
+    maximize?: boolean;
+    hasBackdrop?: boolean;
     className?: string;
-    buttonsCenter?: XBoolean;
+    buttonsCenter?: boolean;
 }
 export interface XDrawerConfig {
     placement?: XPosition;
     size?: string;
-    backdropClose?: XBoolean;
-    hasBackdrop?: XBoolean;
+    backdropClose?: boolean;
+    hasBackdrop?: boolean;
     className?: string;
 }
 export interface XDropdownConfig {
     trigger?: XTrigger;
     placement?: XPlacement;
+    size?: XSize;
 }
 export interface XDescriptionConfig {
-    bordered?: XBoolean;
+    bordered?: boolean;
     size?: XSize;
 }
 export interface XEmptyConfig {
@@ -257,22 +286,22 @@ export interface XEmptyConfig {
 }
 export interface XFindConfig {
     size?: XSize;
-    bordered?: XBoolean;
+    bordered?: boolean;
     columnLabel?: string;
     dialogTitle?: string;
     dialogCheckboxLabel?: string;
-    dialogCheckboxWidth?: number;
+    dialogCheckboxWidth?: string;
     dialogEmptyContent?: string;
-    dialogButtonsCenter?: XBoolean;
+    dialogButtonsCenter?: boolean;
     tableIndex?: number;
     tableSize?: number;
-    tableLoading?: XBoolean;
+    tableLoading?: boolean;
     tableVirtualScroll?: boolean;
-    tableRowHeight?: XNumber;
-    treeExpandedLevel?: XNumber;
+    tableRowHeight?: number;
+    treeExpandedLevel?: number;
 }
 export interface XFormConfig {
-    space?: XNumber;
+    space?: string;
     labelSuffix?: string;
     width?: string;
 }
@@ -285,22 +314,22 @@ export interface XInnerConfig {
     padding?: string;
 }
 export interface XInputConfig {
-    clearable?: XBoolean;
+    clearable?: boolean;
     iconLayout?: XPositionLeftRight;
     size?: XSize;
-    bordered?: XBoolean;
-    inputPadding?: XNumber;
+    bordered?: boolean;
+    inputPadding?: string;
     inputIconPadding?: XNumber;
 }
 export interface XInputGroupConfig {
     size?: XSize;
-    bordered?: XBoolean;
-    compact?: XBoolean;
+    bordered?: boolean;
+    compact?: boolean;
 }
 export interface XInputNumberConfig {
     size?: XSize;
-    bordered?: XBoolean;
-    hiddenButton?: XBoolean;
+    bordered?: boolean;
+    hiddenButton?: boolean;
 }
 export interface XImageConfig {
     previewText?: string;
@@ -313,21 +342,24 @@ export interface XRippleConfig {
     type?: XType;
 }
 export interface XLinkConfig {
-    underline?: XBoolean;
-    iconRight?: XBoolean;
-    preventDefault?: XBoolean;
+    underline?: boolean;
+    iconRight?: boolean;
+    preventDefault?: boolean;
 }
 export interface XListConfig {
     selectAllText?: string;
     loadMoreText?: string;
     loadingMoreText?: string;
     caseSensitive?: boolean;
+    virtualScroll?: boolean;
+    scrollHeight?: number;
+    size?: XSize;
 }
 export interface XListOptionConfig {
     size?: XSize;
 }
 export interface XLoadingConfig {
-    size?: XSize;
+    size?: XSize | number;
     text?: string;
     icon?: string;
     color?: string;
@@ -360,38 +392,43 @@ export interface XPageHeaderConfig {
     backText?: string;
 }
 export interface XPaginationConfig {
-    index?: XNumber;
-    size?: XNumber;
-    space?: XNumber;
-    pageLinkSize?: XNumber;
+    index?: number;
+    size?: number;
+    space?: string;
+    pageLinkSize?: number;
     hiddenBorder?: boolean;
     showEllipsis?: boolean;
     showTotal?: boolean;
     showSize?: boolean;
-    sizeWidth?: number;
+    showBackground?: boolean;
+    sizeWidth?: string;
     sizeData?: number[];
     showInputSize?: boolean;
     inputSizeWidth?: number;
     showJump?: boolean;
-    jumpWidth?: number;
+    jumpWidth?: string;
     simple?: boolean;
-    simpleIndexWidth?: number;
+    simpleIndexWidth?: string;
 }
 export interface XPatternConfig {
 }
 export interface XPopconfirmConfig {
     placement?: XPlacement;
     trigger?: XTrigger;
-    width?: string;
     icon?: string;
     iconColor?: string;
     cancelText?: string;
     confirmText?: string;
+    width?: string;
+    maxWidth?: string;
+    minWidth?: string;
 }
 export interface XPopoverConfig {
     placement?: XPlacement;
     trigger?: XTrigger;
     width?: string;
+    minWidth?: string;
+    maxWidth?: string;
 }
 export interface XPortalConfig {
 }
@@ -411,25 +448,27 @@ export interface XResultConfig {
 }
 export interface XSelectConfig {
     placement?: XPositionTopBottom;
-    clearable?: XBoolean;
+    clearable?: boolean;
     size?: XSize;
-    bordered?: XBoolean;
+    bordered?: boolean;
     portalMaxHeight?: string;
     selectAllText?: string;
-    search?: XBoolean;
-    caseSensitive?: XBoolean;
+    search?: boolean;
+    caseSensitive?: boolean;
     debounceTime?: number;
     maxTagCount?: number;
-    virtualScroll?: XBoolean;
+    maxTagContent?: XTemplate;
+    virtualScroll?: boolean;
 }
 export interface XSkeletonConfig {
 }
 export interface XSliderConfig {
-    animated?: XBoolean;
+    animated?: boolean;
     size?: XSize;
-    showExpand?: XBoolean;
-    autoShowArrow?: XBoolean;
+    showExpand?: boolean;
+    autoShowArrow?: boolean;
     trigger?: XTrigger;
+    expandMaxHeight?: string;
 }
 export interface XSliderSelectConfig {
 }
@@ -446,40 +485,57 @@ export interface XSwitchConfig {
 export interface XTableConfig {
     index?: number;
     size?: number;
-    loading?: XBoolean;
-    showHeader?: XBoolean;
+    loading?: boolean;
+    showHeader?: boolean;
+    headerPosition?: 'top' | 'bottom' | 'top-bottom';
     virtualScroll?: boolean;
-    rowHeight?: XNumber;
-    itemSize?: XNumber;
-    bordered?: XNumber;
-    allowSelectRow?: XBoolean;
-    allowCheckRow?: XBoolean;
+    rowHeight?: number;
+    itemSize?: number;
+    bordered?: boolean;
+    allowSelectRow?: boolean;
+    allowCheckRow?: boolean;
     rowSize?: XSize;
-    showPagination?: XBoolean;
-    treeTable?: XBoolean;
-    expandedAll?: XBoolean;
-    expandedLevel?: XNumber;
-    hiddenPaginationBorder?: XBoolean;
-    hiddenWrapBorder?: XBoolean;
-    showEmpty?: XBoolean;
+    showPagination?: boolean;
+    treeTable?: boolean;
+    expandedAll?: boolean;
+    expandedLevel?: number;
+    hiddenPaginationBorder?: boolean;
+    hiddenWrapBorder?: boolean;
+    showEmpty?: boolean;
     emptyImg?: XTemplate;
     emptyContent?: XTemplate;
+    space?: string;
+    pageLinkSize?: number;
+    hiddenBorder?: boolean;
+    showEllipsis?: boolean;
+    showTotal?: boolean;
+    showSize?: boolean;
+    showBackground?: boolean;
+    sizeWidth?: string;
+    sizeData?: number[];
+    showInputSize?: boolean;
+    inputSizeWidth?: number;
+    showJump?: boolean;
+    jumpWidth?: string;
+    simple?: boolean;
+    simpleIndexWidth?: string;
 }
 export interface XTabsConfig {
     size?: XSize;
     trigger?: XTrigger;
+    expandMaxHeight?: string;
 }
 export interface XTagConfig {
     size?: XSize;
-    bordered?: XBoolean;
-    closable?: XBoolean;
-    dark?: XBoolean;
+    bordered?: boolean;
+    closable?: boolean;
+    dark?: boolean;
 }
 export interface XTextRetractConfig {
-    max?: XNumber;
+    max?: number;
 }
 export interface XThemeConfig {
-    amounts?: XNumber[];
+    amounts?: number[];
 }
 export interface XTimeAgoConfig {
 }
@@ -487,57 +543,67 @@ export interface XTimePickerConfig {
     format?: string;
     placement?: XCorner;
     size?: XSize;
-    bordered?: XBoolean;
-    use12Hours?: XBoolean;
-    defaultNow?: XBoolean;
+    bordered?: boolean;
+    use12Hours?: boolean;
+    defaultNow?: boolean;
+    hourStep?: number;
+    minuteStep?: number;
+    secondStep?: number;
 }
 export interface XTimeRangeConfig {
 }
 export interface XTimelineConfig {
     size?: XSize;
+    mode?: 'left' | 'right' | 'alternate';
 }
 export interface XTooltipConfig {
     placement?: XPlacement;
 }
 export interface XTransferConfig {
     titles?: string[];
-    drag?: XBoolean;
-    virtualScroll?: XBoolean;
+    drag?: boolean;
+    virtualScroll?: boolean;
+    type?: 'list' | 'table' | 'tree';
+    listStyle: XStyleMap | XStyleMap[];
 }
 export interface XTreeConfig {
-    spacing?: XNumber;
-    nodeHeight?: XNumber;
+    spacing?: string;
+    nodeHeight?: string;
     nodeAlignItems?: XAlign;
     virtualScroll?: boolean;
     onlyLeaf?: boolean;
     showLine?: boolean;
+    virtualScrollHeight?: string;
+    itemSize?: number;
+    caseSensitive?: boolean;
 }
 export interface XTextareaConfig {
-    clearable?: XBoolean;
+    clearable?: boolean;
     iconLayout?: XPositionLeftRight;
 }
 export interface XTreeFileConfig {
-    maxHeight?: XNumber;
-    spacing?: XNumber;
+    maxHeight?: string;
+    spacing?: string;
 }
 export interface XTreeSelectConfig {
     placement?: XPositionTopBottom;
-    clearable?: XBoolean;
+    clearable?: boolean;
     size?: XSize;
-    bordered?: XBoolean;
+    bordered?: boolean;
     portalMaxHeight?: string;
     selectAllText?: string;
-    search?: XBoolean;
-    caseSensitive?: XBoolean;
+    search?: boolean;
+    caseSensitive?: boolean;
     debounceTime?: number;
     maxTagCount?: number;
-    virtualScroll?: XBoolean;
-    showPath?: XBoolean;
+    maxTagContent?: XTemplate;
+    virtualScroll?: boolean;
+    showPath?: boolean;
     separator?: string;
     onlyLeaf?: boolean;
 }
 export interface XUploadConfig {
-    download?: XBoolean;
+    download?: boolean;
     multipleModel?: 'cover' | 'add';
 }
 export interface XKeywordConfig {

package/core/config/config.service.d.ts

@@ -1,6 +1,7 @@
 import { Observable } from 'rxjs';
-import { XComponentConfigKey, XComponentConfig } from './config';
-import { XThemeService, XTheme } from '../theme';
+import { XThemeService } from '../theme';
+import type { XTheme } from '../theme';
+import type { XComponentConfigKey, XComponentConfig } from './config';
 import * as i0 from "@angular/core";
 export declare class XConfigService {
     private componentConfigUpdated$;
@@ -11,12 +12,11 @@ export declare class XConfigService {
     getConfigForComponent<T extends XComponentConfigKey>(componentName: T): XComponentConfig[T];
     getConfigChangeEventForComponent(componentName: XComponentConfigKey): Observable<void>;
     set<T extends XComponentConfigKey>(componentName: T, value: XComponentConfig[T]): void;
-    setDarkTheme(theme?: XTheme): void;
-    setLightTheme(theme?: XTheme): void;
+    setDarkTheme(): import("../theme").XColorsTheme;
+    setLightTheme(): import("../theme").XColorsTheme;
     setTheme(theme?: XTheme): void;
     setInitialTheme(theme?: XTheme): void;
     getTheme(includesAll?: boolean): XTheme;
     static ɵfac: i0.ɵɵFactoryDeclaration<XConfigService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<XConfigService>;
 }
-export declare function XWithConfig<T>(componentName: XComponentConfigKey, innerDefaultValue?: T): (target: any, propName: any, originalDescriptor?: TypedPropertyDescriptor<T>) => any;

package/core/config/index.d.ts

@@ -0,0 +1 @@
+export * from './public-api';

package/core/functions/chunk.d.ts

@@ -1 +1,12 @@
-export declare function XChunk<T>(array: T[], size?: number): T[][];
+/**
+ * @zh_CN 该函数用于将给定的数组拆分成多个小数组
+ * 每个小数组的长度由函数的第二个参数指定，默认为 1。
+ * 如果给定的数组为空或者小数组长度小于等于 0，则函数返回一个空数组。
+ * 函数通过循环遍历给定的数组，并使用 slice 方法将数组拆分成小数组，然后将小数组添加到结果数组中，最后返回结果数组。
+ * @en_US This function is used to split the given array into multiple decimal arrays
+ * The length of each decimal array is specified by the second parameter of the function, and the default is 1.
+ * If the given array is empty or the length of the decimal array is less than equal to 0, the function returns a empty array.
+ * The function traverses the given array by circulating, and uses the Slice method to split the array into a decimal array,
+ * then add the decimal array to the result array, and finally return the result array.
+ */
+export declare function XChunk<T>(array: Array<T>, size?: number): Array<Array<T>>;

package/core/functions/clone-deep.d.ts

@@ -1 +1,17 @@
+/**
+ * @zh_CN 该函数是一个深拷贝函数，用于克隆一个对象或数组
+ * 它会递归地复制对象的所有属性，包括嵌套对象和数组，生成一个全新的独立副本。
+ * 对于非对象和非数组类型的值，直接返回该值。
+ * 函数接受一个参数 value，表示需要进行深拷贝的值。
+ * 首先创建一个空的结果对象 result，如果 value 是数组，则 result 也是一个空数组。
+ * 遍历 value 的所有属性，如果属性是对象，则递归调用 XCloneDeep 函数进行深拷贝，并将结果赋值给 result 对应的属性。
+ * 最后返回 result，即深拷贝后的对象或数组。
+ * @en_US This function is a deep copy function that is used for a cloning object or array
+ * It will recover all the attributes of the object, including nested objects and array, and generate a new independent copy.
+ * For non object and non -array type values, return that value directly.
+ * The function accepts a parameter Value, indicating that the value of deep copy needs to be performed.
+ * First create a empty result object Result. If Value is an array, Result is also an empty array.
+ * It traverses all the attributes of Value. If the attribute is an object, the recursively calls the XCLONEDEEP function for deep copy, and assign the result to the corresponding attributes corresponding to Result.
+ * Finally return to Result, that is, the object or array after the deep copy.
+ */
 export declare function XCloneDeep(value: any): any;