@next-core/next-docs 1.2.569 → 1.2.570

package/dist/brick-kit.abstractruntime.fetchmenu.md

@@ -27,7 +27,7 @@ fetchMenu(menuId: string): Promise<SidebarMenu>;
 
 **Returns:**
 
-Promise&lt;SidebarMenu&gt;
+Promise&lt;[SidebarMenu](./brick-types.sidebarmenu.md)<!-- -->&gt;
 
 The menu data.
 

package/dist/brick-kit.abstractruntime.getcurrentapp.md

@@ -21,5 +21,5 @@ getCurrentApp(): MicroApp;
 
 **Returns:**
 
-MicroApp
+[MicroApp](./brick-types.microapp.md)
 

package/dist/brick-kit.abstractruntime.getcurrentmode.md

@@ -21,7 +21,7 @@ getCurrentMode(): SiteMode;
 
 **Returns:**
 
-SiteMode
+[SiteMode](./brick-types.sitemode.md)
 
 Current mode.
 

package/dist/brick-kit.abstractruntime.getcurrenttheme.md

@@ -21,7 +21,7 @@ getCurrentTheme(): SiteTheme;
 
 **Returns:**
 
-SiteTheme
+[SiteTheme](./brick-types.sitetheme.md)
 
 Current theme.
 

package/dist/brick-kit.abstractruntime.getfeatureflags.md

@@ -21,7 +21,7 @@ getFeatureFlags(): FeatureFlags;
 
 **Returns:**
 
-FeatureFlags
+[FeatureFlags](./brick-types.featureflags.md)
 
 ## Example
 

package/dist/brick-kit.abstractruntime.getmicroapps.md

@@ -27,5 +27,5 @@ getMicroApps(options?: GetMicroAppsOptions): MicroApp[];
 
 **Returns:**
 
-MicroApp\[\]
+[MicroApp](./brick-types.microapp.md)<!-- -->\[\]
 

package/dist/brick-kit.abstractruntime.registercustomtemplate.md

@@ -24,7 +24,7 @@ registerCustomTemplate(tplName: string, tplConstructor: CustomTemplateConstructo
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  tplName | string | 模板名。 |
-|  tplConstructor | CustomTemplateConstructor | 模板构造器。 |
+|  tplConstructor | [CustomTemplateConstructor](./brick-types.customtemplateconstructor.md) | 模板构造器。 |
 |  appId | string | 模板所属应用的 ID。 |
 
 **Returns:**

package/dist/brick-kit.applytheme.md

@@ -21,7 +21,7 @@ export declare function applyTheme(value?: SiteTheme): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  value | SiteTheme |  |
+|  value | [SiteTheme](./brick-types.sitetheme.md) |  |
 
 **Returns:**
 

package/dist/brick-kit.batchsetappslocaltheme.md

@@ -21,7 +21,7 @@ export declare function batchSetAppsLocalTheme(appsTheme: Record<string, SiteThe
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  appsTheme | Record&lt;string, SiteTheme&gt; |  |
+|  appsTheme | Record&lt;string, [SiteTheme](./brick-types.sitetheme.md)<!-- -->&gt; |  |
 
 **Returns:**
 

package/dist/brick-kit.collectdebugcontract.md

@@ -21,7 +21,7 @@ export declare function collectDebugContract(contracts: Contract[] | undefined):
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  contracts | Contract\[\] \| undefined |  |
+|  contracts | [Contract](./brick-types.contract.md)<!-- -->\[\] \| undefined |  |
 
 **Returns:**
 

package/dist/brick-kit.constructeventlistener.md

@@ -21,7 +21,7 @@ export declare function constructEventListener(handler: BrickEventHandler): Even
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  handler | BrickEventHandler |  |
+|  handler | [BrickEventHandler](./brick-types.brickeventhandler.md) |  |
 
 **Returns:**
 

package/dist/brick-kit.debugdatavalue.md

@@ -21,6 +21,6 @@ export interface DebugDataValue
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [resolve](./brick-kit.debugdatavalue.resolve.md) | UseProviderResolveConf |  |
+|  [resolve](./brick-kit.debugdatavalue.resolve.md) | [UseProviderResolveConf](./brick-types.useproviderresolveconf.md) |  |
 |  [value](./brick-kit.debugdatavalue.value.md) | unknown |  |
 

package/dist/brick-kit.debugdatavalue.resolve.md

@@ -17,3 +17,5 @@ custom_edit_url: null
 resolve?: UseProviderResolveConf;
 ```
 
+**Reference:** [UseProviderResolveConf](./brick-types.useproviderresolveconf.md)
+

package/dist/brick-kit.featureflagsprovider.md

@@ -17,3 +17,5 @@ custom_edit_url: null
 FeatureFlagsProvider: React.Provider<FeatureFlagsType>
 ```
 
+**Reference:** [FeatureFlagsType](./brick-types.featureflags.md)
+

package/dist/brick-kit.getcurrenttheme.md

@@ -19,5 +19,5 @@ export declare function getCurrentTheme(): SiteTheme;
 
 **Returns:**
 
-SiteTheme
+[SiteTheme](./brick-types.sitetheme.md)
 

package/dist/brick-kit.gethistory.md

@@ -21,7 +21,7 @@ export declare function getHistory(): PluginHistory;
 
 **Returns:**
 
-PluginHistory
+[PluginHistory](./brick-types.pluginhistory.md)
 
 系统会话历史管理器。
 

package/dist/brick-kit.getruntimemisc.md

@@ -19,5 +19,5 @@ export declare function getRuntimeMisc(): RuntimeMisc;
 
 **Returns:**
 
-RuntimeMisc
+[RuntimeMisc](./brick-types.runtimemisc.md)
 

package/dist/brick-kit.i18ntext.md

@@ -21,7 +21,7 @@ export declare function i18nText(data: I18nData): string;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  data | I18nData |  |
+|  data | [I18nData](./brick-types.i18ndata.md) |  |
 
 **Returns:**
 

package/dist/brick-kit.ifcontainer.else.md

@@ -17,3 +17,5 @@ custom_edit_url: null
 else?: BrickEventHandler | BrickEventHandler[];
 ```
 
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

package/dist/brick-kit.ifcontainer.md

@@ -23,6 +23,6 @@ export interface IfContainer
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [else](./brick-kit.ifcontainer.else.md) | BrickEventHandler \| BrickEventHandler\[\] |  |
+|  [else](./brick-kit.ifcontainer.else.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] |  |
 |  [if](./brick-kit.ifcontainer.if.md) | unknown | 条件判断，可以为表达式字符串。 |
 

package/dist/brick-kit.previewstoryboardpatch.md

@@ -17,3 +17,5 @@ custom_edit_url: null
 export declare type PreviewStoryboardPatch = CustomTemplate | RouteConf | RuntimeSnippet | FormDataProperties;
 ```
 
+**Reference:** [CustomTemplate](./brick-types.customtemplate.md)<!-- -->, [RouteConf](./brick-types.routeconf.md)<!-- -->, [RuntimeSnippet](./brick-types.runtimesnippet.md)
+

package/dist/brick-kit.runtimedatavale.app.md

@@ -17,3 +17,5 @@ custom_edit_url: null
 app?: MicroApp;
 ```
 
+**Reference:** [MicroApp](./brick-types.microapp.md)
+

package/dist/brick-kit.runtimedatavale.md

@@ -17,12 +17,12 @@ custom_edit_url: null
 export interface RuntimeDataVale extends Pick<PluginRuntimeContext, "match" | "sys" | "query">
 ```
 
-**Extends:** Pick&lt;PluginRuntimeContext, "match" \| "sys" \| "query"&gt;
+**Extends:** Pick&lt;[PluginRuntimeContext](./brick-types.pluginruntimecontext.md)<!-- -->, "match" \| "sys" \| "query"&gt;
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [app](./brick-kit.runtimedatavale.app.md) | MicroApp |  |
+|  [app](./brick-kit.runtimedatavale.app.md) | [MicroApp](./brick-types.microapp.md) |  |
 |  [location](./brick-kit.runtimedatavale.location.md) | { href: string; origin: string; hostname: string; host: string; } |  |
 

package/dist/brick-kit.setapplocales.md

@@ -21,7 +21,7 @@ export declare function setAppLocales(app: MicroApp): void;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  app | MicroApp |  |
+|  app | [MicroApp](./brick-types.microapp.md) |  |
 
 **Returns:**
 

package/dist/brick-kit.usecurrentapp.md

@@ -21,7 +21,7 @@ export declare function useCurrentApp(): MicroApp;
 
 **Returns:**
 
-MicroApp
+[MicroApp](./brick-types.microapp.md)
 
 当前所在微应用的信息。
 

package/dist/brick-kit.usecurrentmode.md

@@ -19,5 +19,5 @@ export declare function useCurrentMode(): SiteMode;
 
 **Returns:**
 
-SiteMode
+[SiteMode](./brick-types.sitemode.md)
 

package/dist/brick-kit.usecurrenttheme.md

@@ -19,5 +19,5 @@ export declare function useCurrentTheme(): SiteTheme;
 
 **Returns:**
 
-SiteTheme
+[SiteTheme](./brick-types.sitetheme.md)
 

package/dist/brick-next-pipes.unitformat.md

@@ -18,7 +18,7 @@ custom_edit_url: null
 **Signature:**
 
 ```typescript
-export declare function unitFormat(value: number, unit: string, precision?: number, targetUnit?: string): [string, string];
+export declare function unitFormat(value: number, unit: string, precision?: number, targetUnit?: string, fixedPrecision?: boolean): [string, string];
 ```
 
 ## Parameters
@@ -29,6 +29,7 @@ export declare function unitFormat(value: number, unit: string, precision?: numb
 |  unit | string | 当前单位。 |
 |  precision | number | 精度（默认为 <code>2</code>）。 |
 |  targetUnit | string | 目标单位，若不填则会自动计算。 |
+|  fixedPrecision | boolean |  |
 
 **Returns:**
 

package/dist/brick-types.antdicon.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.antdicon
+title: AntdIcon
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [AntdIcon](./brick-types.antdicon.md)
+
+## AntdIcon interface
+
+Antd 图标配置。
+
+**Signature:**
+
+```typescript
+export declare type AntdIcon = RefinedAntdIcon | LegacyAntdIcon;
+```
+
+**Reference:** [RefinedAntdIcon](./brick-types.refinedantdicon.md)<!-- -->, [LegacyAntdIcon](./brick-types.legacyantdicon.md)
+

package/dist/brick-types.applocale.md

@@ -0,0 +1,27 @@
+---
+id: brick-types.applocale
+title: AppLocale
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [AppLocale](./brick-types.applocale.md)
+
+## AppLocale interface
+
+应用的单个地域的本地化配置。
+
+**Signature:**
+
+```typescript
+export interface AppLocale
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [name](./brick-types.applocale.name.md) | string | 对某地域显示的应用名称。 |
+

package/dist/brick-types.applocale.name.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.applocale.name
+title: AppLocale.name
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [AppLocale](./brick-types.applocale.md) &gt; [name](./brick-types.applocale.name.md)
+
+## AppLocale.name property
+
+对某地域显示的应用名称。
+
+**Signature:**
+
+```typescript
+name?: string;
+```
+

package/dist/brick-types.applocales.md

@@ -0,0 +1,34 @@
+---
+id: brick-types.applocales
+title: AppLocales
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [AppLocales](./brick-types.applocales.md)
+
+## AppLocales interface
+
+应用的基本信息的本地化配置。
+
+**Signature:**
+
+```typescript
+export declare type AppLocales = Record<string, AppLocale>;
+```
+
+**Reference:** [AppLocale](./brick-types.applocale.md)
+
+## Example
+
+
+```yaml
+zh:
+  name: 搜索
+en:
+  name: Search
+```
+
+

package/dist/brick-types.basecustombrickeventhandler.if.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.basecustombrickeventhandler.if
+title: BaseCustomBrickEventHandler.if
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseCustomBrickEventHandler](./brick-types.basecustombrickeventhandler.md) &gt; [if](./brick-types.basecustombrickeventhandler.if.md)
+
+## BaseCustomBrickEventHandler.if property
+
+根据条件决定是否执行该动作。
+
+**Signature:**
+
+```typescript
+if?: string | boolean;
+```
+

package/dist/brick-types.basecustombrickeventhandler.md

@@ -0,0 +1,30 @@
+---
+id: brick-types.basecustombrickeventhandler
+title: BaseCustomBrickEventHandler
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseCustomBrickEventHandler](./brick-types.basecustombrickeventhandler.md)
+
+## BaseCustomBrickEventHandler interface
+
+使用指定构件进行事件处理的基本配置。
+
+**Signature:**
+
+```typescript
+export interface BaseCustomBrickEventHandler
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [if](./brick-types.basecustombrickeventhandler.if.md) | string \| boolean | 根据条件决定是否执行该动作。 |
+|  [multiple](./brick-types.basecustombrickeventhandler.multiple.md) | boolean | 是否使用 <code>target</code> 匹配多个构件。 |
+|  [target](./brick-types.basecustombrickeventhandler.target.md) | string \| unknown | 指定目标构件的 CSS selector。 |
+|  [targetRef](./brick-types.basecustombrickeventhandler.targetref.md) | string \| string\[\] | 在自定义模板中指定 ref 对应的构件。 |
+

package/dist/brick-types.basecustombrickeventhandler.multiple.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.basecustombrickeventhandler.multiple
+title: BaseCustomBrickEventHandler.multiple
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseCustomBrickEventHandler](./brick-types.basecustombrickeventhandler.md) &gt; [multiple](./brick-types.basecustombrickeventhandler.multiple.md)
+
+## BaseCustomBrickEventHandler.multiple property
+
+是否使用 `target` 匹配多个构件。
+
+**Signature:**
+
+```typescript
+multiple?: boolean;
+```
+

package/dist/brick-types.basecustombrickeventhandler.target.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.basecustombrickeventhandler.target
+title: BaseCustomBrickEventHandler.target
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseCustomBrickEventHandler](./brick-types.basecustombrickeventhandler.md) &gt; [target](./brick-types.basecustombrickeventhandler.target.md)
+
+## BaseCustomBrickEventHandler.target property
+
+指定目标构件的 CSS selector。
+
+**Signature:**
+
+```typescript
+target?: string | unknown;
+```
+

package/dist/brick-types.basecustombrickeventhandler.targetref.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.basecustombrickeventhandler.targetref
+title: BaseCustomBrickEventHandler.targetRef
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseCustomBrickEventHandler](./brick-types.basecustombrickeventhandler.md) &gt; [targetRef](./brick-types.basecustombrickeventhandler.targetref.md)
+
+## BaseCustomBrickEventHandler.targetRef property
+
+在自定义模板中指定 ref 对应的构件。
+
+**Signature:**
+
+```typescript
+targetRef?: string | string[];
+```
+

package/dist/brick-types.baseentityresolveconf.args.md

@@ -0,0 +1,22 @@
+---
+id: brick-types.baseentityresolveconf.args
+title: BaseEntityResolveConf.args
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [args](./brick-types.baseentityresolveconf.args.md)
+
+## BaseEntityResolveConf.args property
+
+需要传递给 `method` 的参数列表。
+
+
+**Signature:**
+
+```typescript
+args?: unknown[];
+```
+

package/dist/brick-types.baseentityresolveconf.field.md

@@ -0,0 +1,26 @@
+---
+id: brick-types.baseentityresolveconf.field
+title: BaseEntityResolveConf.field
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [field](./brick-types.baseentityresolveconf.field.md)
+
+## BaseEntityResolveConf.field property
+
+> Warning: This API is now obsolete.
+> 
+> 建议统一使用 `transformFrom`<!-- -->。
+> 
+
+使用返回数据的指定字段作为数据源。
+
+**Signature:**
+
+```typescript
+field?: string | string[];
+```
+

package/dist/brick-types.baseentityresolveconf.if.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.baseentityresolveconf.if
+title: BaseEntityResolveConf.if
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [if](./brick-types.baseentityresolveconf.if.md)
+
+## BaseEntityResolveConf.if property
+
+根据条件决定是否执行该动作。
+
+**Signature:**
+
+```typescript
+if?: string | boolean;
+```
+

package/dist/brick-types.baseentityresolveconf.md

@@ -0,0 +1,35 @@
+---
+id: brick-types.baseentityresolveconf
+title: BaseEntityResolveConf
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md)
+
+## BaseEntityResolveConf interface
+
+实体类的异步数据处理的基本配置信息。
+
+**Signature:**
+
+```typescript
+export interface BaseEntityResolveConf
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [args](./brick-types.baseentityresolveconf.args.md) | unknown\[\] | 需要传递给 <code>method</code> 的参数列表。 |
+|  [field](./brick-types.baseentityresolveconf.field.md) | string \| string\[\] | 使用返回数据的指定字段作为数据源。 |
+|  [if](./brick-types.baseentityresolveconf.if.md) | string \| boolean | 根据条件决定是否执行该动作。 |
+|  [method](./brick-types.baseentityresolveconf.method.md) | string | 将要执行的构件的方法名，默认为 <code>resolve</code>。 |
+|  [name](./brick-types.baseentityresolveconf.name.md) | string | 将数据源直接赋值给指定的这个属性。 |
+|  [onReject](./brick-types.baseentityresolveconf.onreject.md) | [HandleReject](./brick-types.handlereject.md) | 当异步数据处理抛出错误时，使用该错误对象作为数据源进行转换来作为最终结果。 |
+|  [transform](./brick-types.baseentityresolveconf.transform.md) | [GeneralTransform](./brick-types.generaltransform.md) | 数据转换配置。 |
+|  [transformFrom](./brick-types.baseentityresolveconf.transformfrom.md) | string \| string\[\] | 使用返回数据的指定字段作为数据源。 |
+|  [transformMapArray](./brick-types.baseentityresolveconf.transformmaparray.md) | boolean \| "auto" | 设置在数据转换中对数组的映射处理模式。 |
+

package/dist/brick-types.baseentityresolveconf.method.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.baseentityresolveconf.method
+title: BaseEntityResolveConf.method
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [method](./brick-types.baseentityresolveconf.method.md)
+
+## BaseEntityResolveConf.method property
+
+将要执行的构件的方法名，默认为 `resolve`<!-- -->。
+
+**Signature:**
+
+```typescript
+method?: string;
+```
+

package/dist/brick-types.baseentityresolveconf.name.md

@@ -0,0 +1,26 @@
+---
+id: brick-types.baseentityresolveconf.name
+title: BaseEntityResolveConf.name
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [name](./brick-types.baseentityresolveconf.name.md)
+
+## BaseEntityResolveConf.name property
+
+> Warning: This API is now obsolete.
+> 
+> 建议统一使用 `transform`<!-- -->。
+> 
+
+将数据源直接赋值给指定的这个属性。
+
+**Signature:**
+
+```typescript
+name?: string;
+```
+