@ng-nest/ui 17.0.12 → 18.0.0

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

@@ -1,61 +1,96 @@
 /**
- * 方位 左右
+ * @zh_CN 方位 左右
+ * @en_US position left, right
  */
 export type XPositionLeftRight = 'left' | 'right';
 /**
- * 方位 上下
+ * @zh_CN 方位 上下
+ * @en_US position top, bottom
  */
 export type XPositionTopBottom = 'top' | 'bottom';
 /**
- * 方位
+ * @zh_CN 方位
+ * @en_US position
  */
 export type XPosition = XPositionTopBottom | XPositionLeftRight;
 /**
- * 颜色类型
+ * @zh_CN 风格类型
+ * - `'initial'` : 默认
+ * - `'primary'` : 主要
+ * - `'success'` : 成功
+ * - `'info'` : 信息
+ * - `'warning'` : 警告
+ * - `'danger'` : 危险
+ * - `'text'` : 文本
+ * @en_US Style type
+ * - `'initial'` : Initial
+ * - `'primary'` : Primary
+ * - `'success'` : Success
+ * - `'info'` : Info
+ * - `'warning'` : Warning
+ * - `'danger'` : Danger
+ * - `'text'` : Text
  */
 export type XType = 'initial' | 'primary' | 'success' | 'info' | 'warning' | 'danger' | 'text';
 /**
- * 状态类型
+ * @zh_CN 状态类型
+ * @en_US Status type
  */
 export type XStatus = 'success' | 'info' | 'warning' | 'error' | 'loading';
 /**
- * 样式名映射类型
+ * @zh_CN 样式名映射类型
+ * @en_US Style name mapping type
  */
 export type XClassMap = {
     [property: string]: boolean;
 };
 /**
- * 样式映射类型
+ * @zh_CN 样式映射类型
+ * @en_US Style mapping type
  */
 export type XStyleMap = {
     [property: string]: any;
 };
 /**
- * 样式主题
+ * @zh_CN 样式主题
+ * @en_US Style theme
  */
 export type XEffect = 'light' | 'dark' | 'white';
 /**
- * 样式属性
+ * @zh_CN 样式属性
+ * @en_US Style attribute
  */
 export type XStyle = {
     [property: string]: any;
 };
 /**
- * 尺寸
- * @value "big" 超大
- * @value "large" 大型
- * @value "medium" 中等
- * @value "samll" 小型
- * @value "mini" 迷你
+ * @zh_CN 尺寸
+ * - `'big'` : 超大
+ * - `'large'` : 大型
+ * - `'medium'` : 中等
+ * - `'small'` : 小型
+ * - `'mini'` : 迷你
+ * @en_US Size
+ * - `'big'` : Big
+ * - `'large'` : Large
+ * - `'medium'` : Medium
+ * - `'small'` : Small
+ * - `'mini'` : Mini
  */
 export type XSize = 'big' | 'large' | 'medium' | 'small' | 'mini';
 /**
- * 响应尺寸
- * @value "xs" <768px
- * @value "sm" ≥768px
- * @value "md" ≥992px
- * @value "lg" ≥1200px
- * @value "xl" ≥1920px
+ * @zh_CN 响应尺寸
+ * - `xs` <768px
+ * - `sm` ≥768px
+ * - `md` ≥992px
+ * - `lg` ≥1200px
+ * - `xl` ≥1920px
+ * @en_US Response size
+ * - `xs` <768px
+ * - `sm` ≥768px
+ * - `md` ≥992px
+ * - `lg` ≥1200px
+ * - `xl` ≥1920px
  */
 export type XResponseSize = {
     xs?: number;
@@ -65,54 +100,70 @@ export type XResponseSize = {
     xl?: number;
 };
 /**
- * flex 布局下的子元素水平排列方式
+ * @zh_CN flex 布局下的子元素水平排列方式
+ * @en_US The level of sub element level arrangement under flex layout
  */
 export type XJustify = 'start' | 'end' | 'center' | 'space-around' | 'space-between';
 /**
- * flex 布局下的子元素水平排列方式
- */
-export type XJustifyContent = 'flex-start' | 'flex-end' | 'center' | 'space-around' | 'space-between';
-/**
- * flex 布局下的子元素垂直排列方式
+ * @zh_CN flex 布局下的子元素垂直排列方式
+ * @en_US Sub element vertical arrangement method under flex layout
  */
 export type XAlign = 'start' | 'center' | 'end';
 /**
- * flex 布局下的子元素排列方向
+ * @zh_CN flex 布局下的子元素排列方向
+ * - `'column'` : 将 flex 项目从上到下垂直排列，就像列一样
+ * - `'column-reverse'` : 与 `'column'` 相反，将 flex 项目从下到上垂直排列
+ * - `'row'` : 将 flex 项目从左到右水平排列，就像行一样
+ * - `'row-reverse'` : 与 `'row'` 相反，将 flex 项目从右到左水平排列
+ * @en_US The direction of the sub element arrangement under flex layout
+ * - `'column'` : Arranges flex items vertically from top to bottom, like columns. This is the default value
+ * - `'column-reverse'` : Opposite of column, arranges flex items vertically from bottom to top
+ * - `'row'` : Arranges flex items horizontally from left to right, like a row
+ * - `'row-reverse'` : Opposite of row, arranges flex items horizontally from right to
  */
 export type XDirection = 'column' | 'column-reverse' | 'row' | 'row-reverse';
 /**
- * 相对与连接元素的位置
+ * @zh_CN 相对与连接元素的位置
+ * @en_US Relatively and connected element position
  */
 export type XPlacement = XPosition | XCorner | 'left-start' | 'left-end' | 'right-start' | 'right-end';
 /**
- * 四个角落
+ * @zh_CN 四个角落
+ * @en_US Four corners
  */
 export type XCorner = 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end';
 /**
- * 九宫格方位
+ * @zh_CN 九宫格方位
+ * @en_US Jiugong grid position
  */
 export type XPlace = XPosition | XCorner | 'center';
 /**
- * 形状
+ * @zh_CN 形状
+ * @en_US Shape
  */
 export type XShape = 'circle' | 'square';
 /**
- * 适应方式
+ * @zh_CN 适应方式
+ * @en_US Adaptation type
  */
 export type XFit = 'fill' | 'contain' | 'cover' | 'none' | 'scale-down';
 /**
- * 阴影显示配置
+ * @zh_CN 阴影显示配置
+ * @en_US Shadow display configuration
  */
 export type XShadow = 'always' | 'hover' | 'never';
 /**
- * 切换方式
+ * @zh_CN 切换方式
+ * @en_US Switching event
  */
 export type XTrigger = 'hover' | 'click';
 /**
- * 展示的方向
+ * @zh_CN 展示的方向
+ * @en_US Direction of display
  */
 export type XDisplayDirection = 'horizontal' | 'vertical';
 /**
- * 文字对齐方向
+ * @zh_CN 文字对齐方向
+ * @en_US Text alignment direction
  */
 export type XTextAlign = 'left' | 'center' | 'right';

package/core/interfaces/result-list.type.d.ts

@@ -1,28 +1,116 @@
+/**
+ * @zh_CN 标识
+ * @en_US Identify
+ */
 export interface XId {
+    /**
+     * @zh_CN 标识
+     * @en_US Identify
+     */
     id?: string | number;
 }
+/**
+ * @zh_CN 列表返回数据
+ * @en_US List back data
+ */
 export interface XResultList<Entity extends XId> {
+    /**
+     * @zh_CN 列表数据
+     * @en_US List data
+     */
     list?: Entity[];
+    /**
+     * @zh_CN 总数
+     * @en_US Total
+     */
     total?: number;
+    /**
+     * @zh_CN 查询条件
+     * @en_US Query conditions
+     */
     query?: XQuery;
 }
+/**
+ * @zh_CN 查询条件
+ * @en_US Query conditions
+ */
 export interface XQuery {
+    /**
+     * @zh_CN 第几页
+     * @en_US which page
+     */
     index?: number;
+    /**
+     * @zh_CN 每页条数
+     * @en_US page number
+     */
     size?: number;
+    /**
+     * @zh_CN 排序规则
+     * @en_US Sorting rules
+     */
     sort?: XSort[];
+    /**
+     * @zh_CN 过滤规则
+     * @en_US Filtering rule
+     */
     filter?: XFilter[];
+    /**
+     * @zh_CN 分组规则
+     * @en_US Packet rules
+     */
     group?: string;
 }
+/**
+ * @zh_CN 过滤规则
+ * @en_US Filtering rule
+ */
 export interface XFilter {
-    field: string;
-    value: string;
+    /**
+     * @zh_CN 过滤属性
+     * @en_US Filtering property
+     */
+    field?: string;
+    /**
+     * @zh_CN 属性值
+     * @en_US Filtering value
+     */
+    value?: string;
+    /**
+     * @zh_CN 比较符号
+     * @en_US Comparative symbol
+     */
     operation?: XOperation;
+    /**
+     * @zh_CN 关联子对象
+     * @en_US Associated object
+     */
     relation?: string;
 }
+/**
+ * @zh_CN 比较符号
+ * @en_US Comparative symbol
+ */
 export type XOperation = '%' | '=' | '>' | '>=' | '<' | '<=';
+/**
+ * @zh_CN 排序规则
+ * @en_US Sorting rules
+ */
 export interface XSort extends XFilter {
 }
+/**
+ * @zh_CN 分组数据
+ * @en_US Group data
+ */
 export interface XGroupItem extends XId {
-    [property: string]: any;
+    /**
+     * @zh_CN 总数
+     * @en_US total
+     */
     count?: number;
+    /**
+     * @zh_CN 属性
+     * @en_US property
+     */
+    [property: string]: any;
 }

package/core/services/http.service.d.ts

@@ -5,46 +5,24 @@ export declare class XHttpService {
     http: HttpClient;
     api: string;
     constructor(http: HttpClient);
-    /**
-     * get请求
-     */
     get(url: string, params?: {
         [property: string]: any;
     }): Observable<any>;
-    /**
-     * get请求
-     */
     post(url: string, params?: {
         [property: string]: any;
     }): Observable<any>;
-    /**
-     * put请求
-     */
     put(url: string, params?: {
         [property: string]: any;
     }): Observable<any>;
-    /**
-     * delete请求
-     */
     delete(url: string, params?: {
         [property: string]: any;
     }): Observable<any>;
-    /**
-     * request通用请求
-     */
     request(method: string, url: string, params?: {
         [property: string]: any;
     }, option?: {
         [property: string]: any;
     }): Observable<any>;
-    /**
-     * 错误处理
-     */
     handleError(error: HttpErrorResponse): Observable<never>;
-    /**
-     * 添加头部信息
-     */
-    private addHeader;
     static ɵfac: i0.ɵɵFactoryDeclaration<XHttpService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<XHttpService>;
 }

package/core/services/repository.service.d.ts

@@ -1,6 +1,6 @@
-import { XId, XQuery, XResultList } from '../interfaces';
 import { XHttpService } from './http.service';
 import { Observable } from 'rxjs';
+import type { XId, XQuery, XResultList } from '../interfaces';
 export interface XRepositoryInput {
     api?: string;
     controller: XController;

package/core/services/reuse-strategy.service.d.ts

@@ -6,34 +6,12 @@ export interface XRouteReuseStorage {
 export declare class XReuseStrategyService implements RouteReuseStrategy {
     static storages: XRouteReuseStorage[];
     private static waitDelete;
-    /**
-     * 表示对所有路由允许复用 如果你有路由不想利用可以在这加一些业务逻辑判断
-     */
     shouldDetach(_route: ActivatedRouteSnapshot): boolean;
-    /**
-     * 当路由离开时会触发。按path作为key存储路由快照&组件当前实例对象
-     */
     store(route: ActivatedRouteSnapshot, handle: DetachedRouteHandle): void;
-    /**
-     * 若 path 在缓存中有的都认为允许还原路由
-     */
     shouldAttach(route: ActivatedRouteSnapshot): boolean;
-    /**
-     * 从缓存中获取快照，若无则返回nul
-     */
     retrieve(route: ActivatedRouteSnapshot): DetachedRouteHandle;
-    /**
-     * 进入路由触发，判断是否同一路由
-     * 解决不同的参数也会认为是同一个路由，导致会将之前的路由拿出来复用
-     */
     shouldReuseRoute(future: ActivatedRouteSnapshot, curr: ActivatedRouteSnapshot): boolean;
-    /**
-     * 解决不同的主路由会存在相同名称的子路由
-     */
     private getRouteUrl;
-    /**
-     * 删除复用的路由
-     */
     static deleteRouteSnapshot(name?: string): void;
     private add;
 }

package/core/services/storage.service.d.ts

@@ -3,33 +3,12 @@ import * as i0 from "@angular/core";
 export declare class XStorageService {
     private platform;
     constructor(platform: Platform);
-    /**
-     * 获取本地值
-     */
     getLocal(key: string): any;
-    /**
-     * 设置本地值
-     */
     setLocal(key: string, value: any): void;
-    /**
-     * 获取当前会话的值
-     */
     getSession(key: string): any;
-    /**
-     * 设置当前会话值
-     */
     setSession(key: string, value: any): void;
-    /**
-     * 移除本地值
-     */
     removeLocal(key: string): void;
-    /**
-     * 移除当前会话
-     */
     removeSession(key: string): void;
-    /**
-     * 生成guid
-     */
     guid(): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<XStorageService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<XStorageService>;

package/core/theme/theme.d.ts

@@ -1,6 +1,8 @@
 import { InjectionToken } from '@angular/core';
 export interface XTheme {
     colors?: XColorsTheme;
+    vars?: XVarsTheme;
+    dark?: boolean;
 }
 export interface XColorsTheme {
     primary?: string;
@@ -13,6 +15,45 @@ export interface XColorsTheme {
     background?: string;
     [property: string]: any;
 }
+export interface XVarsTheme {
+    black?: string;
+    white?: string;
+    fontSize?: string;
+    fontSizeMini?: string;
+    fontSizeSmall?: string;
+    fontSizeMedium?: string;
+    fontSizeLarge?: string;
+    fontSizeBig?: string;
+    fontVariant?: string;
+    fontFamily?: string;
+    fontCodeFamily?: string;
+    lineHeight?: string;
+    heightBig?: string;
+    heightLarge?: string;
+    heightMedium?: string;
+    heightSmall?: string;
+    heightMini?: string;
+    paddingBig?: string;
+    paddingLarge?: string;
+    paddingMedium?: string;
+    paddingSmall?: string;
+    paddingMini?: string;
+    borderStyle?: string;
+    borderRadius?: string;
+    borderSmallRadius?: string;
+    borderWidth?: string;
+    borderDeepWidth?: string;
+    boxShadow?: string;
+    boxShadowHover?: string;
+    boxShadowTop?: string;
+    boxShadowRight?: string;
+    boxShadowBottom?: string;
+    boxShadowLeft?: string;
+    animationDurationSlow?: string;
+    animationDurationBase?: string;
+    animationDurationFast?: string;
+    [property: string]: any;
+}
 export type XThemeKey = keyof XTheme;
 export type XColors = 'primary' | 'success' | 'warning' | 'danger' | 'info';
 export declare const X_THEME: InjectionToken<XTheme>;
@@ -24,6 +65,9 @@ export declare const X_THEME_BACKGROUNDS: number[];
 export declare const X_THEME_TEXTS: number[][];
 export declare const X_THEME_BORDERS: number[][];
 export declare const X_THEME_EXCHANGES: number[][];
-export declare const X_THEME_COLORS: XColorsTheme;
+export declare const X_THEME_LIGHT_COLORS: XColorsTheme;
 export declare const X_THEME_DARK_COLORS: XColorsTheme;
+export declare const X_THEME_COLORS: XColorsTheme;
+export declare const X_THEME_VARS: XVarsTheme;
 export declare const X_THEME_COLOR_KEYS: string[];
+export declare const X_THEME_VARS_KEYS: string[];

package/core/theme/theme.service.d.ts

@@ -1,41 +1,76 @@
 import { RendererFactory2 } from '@angular/core';
-import { XTheme, XColorsTheme } from './theme';
+import { XTheme, XColorsTheme, XVarsTheme } from './theme';
+import { BehaviorSubject } from 'rxjs';
 import * as i0 from "@angular/core";
 export declare class XThemeService {
     private factory;
     private colorsProp;
+    private varsProp;
     private colorsStyleEle;
+    private varsStyleEle;
     private renderer2;
     private declaration;
     private doc;
+    changed: BehaviorSubject<"light" | "dark">;
     constructor(factory: RendererFactory2);
     setInitialTheme(theme?: XTheme): void;
     setTheme(theme?: XTheme): void;
     getTheme(includesAll?: boolean): XTheme;
     setColors(colors?: XColorsTheme): void;
+    setDark(dark?: boolean): XColorsTheme;
+    setDarkColors(colors?: XColorsTheme): void;
     getColors(includes?: boolean, prefix?: string): XColorsTheme;
+    getVars(prefix?: string): XVarsTheme;
     getColorsInProperty(colors?: XColorsTheme, prefix?: string): XColorsTheme;
     getColorsTheme(colors?: XColorsTheme): XColorsTheme;
-    setRoot(color: string, value: string, prefix?: string): XColorsTheme;
-    setDarkRoot(color: string, value: string, prefix?: string): XColorsTheme;
+    setColorRoot(color: string, value: string, prefix?: string): XColorsTheme;
+    setDarkColorRoot(color: string, value: string, prefix?: string): XColorsTheme;
     getDefineColors(colors?: XColorsTheme, prefix?: string, darken?: boolean): XColorsTheme;
     getSuffix(num: number): string;
+    setVarRoot(va: string, value: string, prefix?: string): XVarsTheme;
+    setVars(vars?: XVarsTheme): void;
     createColorsStyle(): void;
+    createVarsStyle(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<XThemeService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<XThemeService>;
 }
-export declare function mixColors(color1: string, color2: string, weight: number): {
+/**
+ * @zh_CN RGB 颜色值
+ * @en_US RGB color value
+ */
+export interface XRGBColor {
+    /**
+     * @zh_CN 红
+     * @en_US Red
+     */
     r: number;
+    /**
+     * @zh_CN 绿
+     * @en_US Green
+     */
     g: number;
+    /**
+     * @zh_CN 蓝
+     * @en_US Blue
+     */
     b: number;
-};
-export declare function toHex(rgb: {
+}
+/**
+ * @zh_CN 根据权重混合2种颜色
+ * @en_US Mix 2 colors according to heavy weights
+ */
+export declare function XMixColors(color1: string, color2: string, weight: number): XRGBColor;
+/**
+ * @zh_CN RGB 颜色转换为 Hex
+ * @en_US RGB color converts to hex
+ */
+export declare function XToHex(rgb: {
     r: number;
     g: number;
     b: number;
 }): string;
-export declare function toRgb(hex: string): {
-    r: number;
-    g: number;
-    b: number;
-};
+/**
+ * @zh_CN Hex 颜色转换为 RGB
+ * @en_US Hex color converts to RGB
+ */
+export declare function XToRgb(hex: string): XRGBColor;

package/core/util/animation.d.ts

@@ -1 +1 @@
-export declare const reqAnimFrame: typeof requestAnimationFrame;
+export declare const XRequestAnimationFrame: typeof requestAnimationFrame;

package/core/util/camel-to-kebab.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @zh_CN 该函数将字符串中的驼峰命名法转换为减号命名法
+ * - 采用正则表达式匹配字符串中每个连续的大小写字母边界
+ * - 将其替换为小写字母和连字符的组合
+ * - 最后将整个字符串转换为小写
+ * - 例如，`XCamelToKebab('helloWorld')` 将返回 `hello-world`
+ * @en_US This function converts string of hump nomenclature kebab nomenclature
+ * - Use regular expression match each successive lowercase letters in the string boundary
+ * - Replace it with a lower case letters and hyphens
+ * - Finally the whole string converted to lowercase
+ * - For example, `XCamelToKebab('helloWorld')` returns the `hello-world`
+ */
+export declare function XCamelToKebab(str: string): string;

package/core/util/check.d.ts

@@ -1,2 +1,10 @@
-export declare function isNotNil<T>(value: T): value is NonNullable<T>;
-export declare function isNil(value: unknown): value is null | undefined;
+/**
+ * @zh_CN 判断值不为 null 或 undefined
+ * @en_US The judgment value is not null or undefined
+ */
+export declare function XIsNotNil<T>(value: T): value is NonNullable<T>;
+/**
+ * @zh_CN 判断值为 null 或 undefined
+ * @en_US The judgment value is null or undefined
+ */
+export declare function XIsNil(value: unknown): value is null | undefined;

package/core/util/computed-style.d.ts

@@ -1,2 +1,10 @@
+/**
+ * @zh_CN 获取元素的指定样式的计算值
+ * @en_US The calculation value of the specified style of the element
+ */
 export declare function XComputedStyle(element: HTMLElement, style: string): string;
+/**
+ * @zh_CN 获取元素的计算样式
+ * @en_US Calculation style of obtaining elements
+ */
 export declare function XComputed(element: HTMLElement): CSSStyleDeclaration;

package/core/util/host.d.ts

@@ -1,4 +1,5 @@
 /**
- * 删除当前标签，保留内容
+ * @zh_CN 删除当前标签，保留内容
+ * @en_US Delete the current label and keep the content
  */
-export declare function removeNgTag(nativeElement: HTMLElement): void;
+export declare function XRemoveNgTag(nativeElement: HTMLElement): void;

package/core/util/html.d.ts

@@ -1,4 +1,5 @@
 /**
- * 去除HTML标签
+ * @zh_CN 去除 HTML 标签
+ * @en_US Remove the html tag
  */
-export declare function stripTags(text: string, ...usefulTags: any[]): string;
+export declare function XStripTags(text: string, ...usefulTags: any[]): string;

package/core/util/kebab-to-camel.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @zh_CN 该函数将字符串中的减号命名法转换为驼峰命名法
+ * - 使用正则表达式匹配所有连字符后的字母 ( `(\w)` )
+ * - 用 `toUpperCase()` 将这些字母转换为大写
+ * - 替换原字符串中的连字符和小写字母为大写字母
+ * - 例如，`XKebabToCamel('hello-world')` 将返回 `helloWorld`
+ * @en_US This function converts string minus nomenclature of hump nomenclature
+ * - Use a regular expression match all the letter after a hyphen ( `(\w)` )
+ * - Use `toUpperCase()` converts these letters to uppercase
+ * - Replace the original string the hyphen and lowercase letters to uppercase
+ * - For example, `XKebabToCamel('hello-world')` returns `helloWorld`
+ */
+export declare function XKebabToCamel(str: string): string;