@ng-nest/ui 19.0.13 → 20.0.1

package/description/index.d.ts

@@ -1,5 +1,236 @@
+import * as _angular_core from '@angular/core';
+import { TemplateRef } from '@angular/core';
+import * as _ng_nest_ui_core from '@ng-nest/ui/core';
+import { XTemplate, XBoolean, XSize, XJustify, XAlign, XDirection, XNumber } from '@ng-nest/ui/core';
+
 /**
- * Generated bundle index. Do not edit.
+ * Description
+ * @selector x-description
+ * @decorator component
  */
-/// <amd-module name="@ng-nest/ui/description" />
-export * from './public-api';
+declare const XDescriptionPrefix = "x-description";
+declare const XDescriptionProperty_base: new () => {
+    config: _ng_nest_ui_core.XDescriptionConfig | undefined;
+};
+/**
+ * Description Property
+ */
+declare class XDescriptionProperty extends XDescriptionProperty_base {
+    /**
+     * @zh_CN 描述列表的标题，支持自定义模板
+     * @en_US Describe the title of the list, support custom template
+     * @example
+     *
+     * ```html
+     * <x-description title="Title">
+     *   <x-description-item>name</x-description-item>
+     * </x-description>
+     * <x-description [title]="titleTpl">
+     *   <x-description-item>name</x-description-item>
+     * </x-description>
+     * <ng-template #titleTpl>Title</ng-template>
+     * ```
+     *
+     */
+    readonly title: _angular_core.InputSignal<XTemplate | undefined>;
+    /**
+     * @zh_CN 是否展示边框
+     * @en_US Whether to show column borders
+     * @example
+     *
+     * ```html
+     * <x-description title="Title" bordered>
+     *   <x-description-item>name</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly bordered: _angular_core.InputSignalWithTransform<boolean, XBoolean>;
+    /**
+     * @zh_CN grid 布局下定义列宽度
+     * @en_US Define column width under grid layout
+     * @example
+     *
+     * ```html
+     * <x-description title="Title" bordered gridTemplateColumns="1fr 1fr">
+     *   <x-description-item gridArea="1/1/2/2">name</x-description-item>
+     *   <x-description-item gridArea="1/2/3/2">age</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly gridTemplateColumns: _angular_core.InputSignal<string | undefined>;
+    /**
+     * @zh_CN 尺寸
+     * @en_US Size
+     * @example
+     *
+     * ```html
+     * <x-description title="Title" size="big">
+     *   <x-description-item>name</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly size: _angular_core.InputSignal<XSize>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<XDescriptionProperty, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<XDescriptionProperty, "x-description-property", never, { "title": { "alias": "title"; "required": false; "isSignal": true; }; "bordered": { "alias": "bordered"; "required": false; "isSignal": true; }; "gridTemplateColumns": { "alias": "gridTemplateColumns"; "required": false; "isSignal": true; }; "size": { "alias": "size"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+/**
+ * Description Item
+ * @selector x-description-item
+ * @decorator component
+ */
+declare const XDescriptionItemPrefix = "x-description-item";
+/**
+ * Description Item Property
+ */
+declare class XDescriptionItemProperty {
+    /**
+     * @zh_CN 使用 grid 布局
+     * @en_US Use grid layout to merge cells
+     * @example
+     *
+     * ```html
+     * <x-description>
+     *   <x-description-item gridArea="1/1/2/2">name</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly gridArea: _angular_core.InputSignal<string | undefined>;
+    /**
+     * @zh_CN 内容的描述，支持自定义模板
+     * @en_US Description of content, support custom templates
+     * @example
+     *
+     * ```html
+     * <x-description>
+     *   <x-description-item label="name1">name1</x-description-item>
+     *   <x-description-item [label]="nameTpl">name2</x-description-item>
+     * </x-description>
+     * <ng-template #nameTpl></ng-template>
+     * ```
+     *
+     */
+    readonly label: _angular_core.InputSignal<XTemplate | undefined>;
+    /**
+     * @zh_CN flex 布局下的子元素水平排列方式
+     * @en_US Child element under the horizontal arrangement of the layout flex
+     * @example
+     *
+     * ```html
+     * <x-description>
+     *   <x-description-item justify="end">end</x-description-item>
+     *   <x-description-item justify="center">center</x-description-item>
+     *   <x-description-item justify="start">start</x-description-item>
+     *   <x-description-item justify="space-around">space-around</x-description-item>
+     *   <x-description-item justify="space-between">space-between</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly justify: _angular_core.InputSignal<XJustify>;
+    /**
+     * @zh_CN flex 布局下的子元素垂直排列方式
+     * @en_US Child element under the vertical layout flex arrangement
+     * @example
+     *
+     * ```html
+     * <x-description>
+     *   <x-description-item align="end">end</x-description-item>
+     *   <x-description-item align="center">center</x-description-item>
+     *   <x-description-item align="start">start</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly align: _angular_core.InputSignal<XAlign>;
+    /**
+     * @zh_CN flex 布局下的子元素排列方向
+     * @en_US Child element under the direction of arrangement of the layout flex
+     * @example
+     *
+     * ```html
+     * <x-description>
+     *   <x-description-item direction="column">column</x-description-item>
+     *   <x-description-item direction="column-reverse">column-reverse</x-description-item>
+     *   <x-description-item direction="row">row</x-description-item>
+     *   <x-description-item direction="row-reverse">row-reverse</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly direction: _angular_core.InputSignal<XDirection>;
+    /**
+     * @zh_CN 宽度
+     * @en_US Width
+     * @example
+     *
+     * ```html
+     * <x-description>
+     *   <x-description-item width="100px">width100</x-description-item>
+     *   <x-description-item width="200px">width200</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly width: _angular_core.InputSignalWithTransform<string, XNumber>;
+    /**
+     * @zh_CN flex 比重
+     * @en_US Flex proportion
+     * @example
+     *
+     * ```html
+     * <x-description>
+     *   <x-description-item flex="1">flex1</x-description-item>
+     *   <x-description-item flex="2">flex2</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly flex: _angular_core.InputSignalWithTransform<number, XNumber>;
+    /**
+     * @zh_CN 是否是标题
+     * @en_US Whether it is heading
+     * @example
+     *
+     * ```html
+     * <x-description>
+     *   <x-description-item label="name" heading></x-description-item>
+     *   <x-description-item>name1</x-description-item>
+     * </x-description>
+     * ```
+     *
+     */
+    readonly heading: _angular_core.InputSignalWithTransform<boolean, XBoolean>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<XDescriptionItemProperty, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<XDescriptionItemProperty, "x-description-item-property", never, { "gridArea": { "alias": "gridArea"; "required": false; "isSignal": true; }; "label": { "alias": "label"; "required": false; "isSignal": true; }; "justify": { "alias": "justify"; "required": false; "isSignal": true; }; "align": { "alias": "align"; "required": false; "isSignal": true; }; "direction": { "alias": "direction"; "required": false; "isSignal": true; }; "width": { "alias": "width"; "required": false; "isSignal": true; }; "flex": { "alias": "flex"; "required": false; "isSignal": true; }; "heading": { "alias": "heading"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class XDescriptionItemComponent extends XDescriptionItemProperty {
+    content: _angular_core.Signal<TemplateRef<any>>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<XDescriptionItemComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<XDescriptionItemComponent, "x-description-item", never, {}, {}, never, ["*"], true, never>;
+}
+
+declare class XDescriptionComponent extends XDescriptionProperty {
+    items: _angular_core.Signal<readonly XDescriptionItemComponent[]>;
+    classMap: _angular_core.Signal<{
+        [x: string]: boolean;
+    }>;
+    gridTemplateColumnsSignal: _angular_core.Signal<string>;
+    setFlex(item: XDescriptionItemComponent): {
+        [property: string]: boolean;
+    };
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<XDescriptionComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<XDescriptionComponent, "x-description", never, {}, {}, ["items"], never, true, never>;
+}
+
+declare class XDescriptionModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<XDescriptionModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<XDescriptionModule, never, [typeof XDescriptionComponent, typeof XDescriptionItemComponent], [typeof XDescriptionComponent, typeof XDescriptionItemComponent]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<XDescriptionModule>;
+}
+
+export { XDescriptionComponent, XDescriptionItemComponent, XDescriptionItemPrefix, XDescriptionItemProperty, XDescriptionModule, XDescriptionPrefix, XDescriptionProperty };