@next-core/next-docs 1.2.549 → 1.2.551

package/dist/brick-types.extendedhistory.unblock.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.extendedhistory.unblock
+title: ExtendedHistory.unblock
+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; [ExtendedHistory](./brick-types.extendedhistory.md) &gt; [unblock](./brick-types.extendedhistory.unblock.md)
+
+## ExtendedHistory.unblock property
+
+取消之前设置的阻止页面离开信息的设置。
+
+**Signature:**
+
+```typescript
+unblock: () => void;
+```
+

package/dist/brick-types.extfield.md

@@ -0,0 +1,26 @@
+---
+id: brick-types.extfield
+title: ExtField
+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; [ExtField](./brick-types.extfield.md)
+
+## ExtField interface
+
+**Signature:**
+
+```typescript
+export interface ExtField
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [name](./brick-types.extfield.name.md) | string |  |
+|  [source](./brick-types.extfield.source.md) | "body" \| "query" |  |
+

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

@@ -0,0 +1,19 @@
+---
+id: brick-types.extfield.name
+title: ExtField.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; [ExtField](./brick-types.extfield.md) &gt; [name](./brick-types.extfield.name.md)
+
+## ExtField.name property
+
+**Signature:**
+
+```typescript
+name?: string;
+```
+

package/dist/brick-types.extfield.source.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.extfield.source
+title: ExtField.source
+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; [ExtField](./brick-types.extfield.md) &gt; [source](./brick-types.extfield.source.md)
+
+## ExtField.source property
+
+**Signature:**
+
+```typescript
+source?: "body" | "query";
+```
+

package/dist/brick-types.faicon.color.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.faicon.color
+title: FaIcon.color
+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; [FaIcon](./brick-types.faicon.md) &gt; [color](./brick-types.faicon.color.md)
+
+## FaIcon.color property
+
+**Signature:**
+
+```typescript
+color?: string | GradientColor;
+```
+
+**Reference:** [GradientColor](./brick-types.gradientcolor.md)
+

package/dist/brick-types.faicon.icon.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.faicon.icon
+title: FaIcon.icon
+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; [FaIcon](./brick-types.faicon.md) &gt; [icon](./brick-types.faicon.icon.md)
+
+## FaIcon.icon property
+
+**Signature:**
+
+```typescript
+icon: IconName;
+```
+

package/dist/brick-types.faicon.lib.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.faicon.lib
+title: FaIcon.lib
+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; [FaIcon](./brick-types.faicon.md) &gt; [lib](./brick-types.faicon.lib.md)
+
+## FaIcon.lib property
+
+**Signature:**
+
+```typescript
+lib: "fa";
+```
+

package/dist/brick-types.faicon.md

@@ -0,0 +1,30 @@
+---
+id: brick-types.faicon
+title: FaIcon
+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; [FaIcon](./brick-types.faicon.md)
+
+## FaIcon interface
+
+FontAwesome 图标配置。
+
+**Signature:**
+
+```typescript
+export interface FaIcon
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [color](./brick-types.faicon.color.md) | string \| [GradientColor](./brick-types.gradientcolor.md) |  |
+|  [icon](./brick-types.faicon.icon.md) | IconName |  |
+|  [lib](./brick-types.faicon.lib.md) | "fa" |  |
+|  [prefix](./brick-types.faicon.prefix.md) | IconPrefix |  |
+

package/dist/brick-types.faicon.prefix.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.faicon.prefix
+title: FaIcon.prefix
+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; [FaIcon](./brick-types.faicon.md) &gt; [prefix](./brick-types.faicon.prefix.md)
+
+## FaIcon.prefix property
+
+**Signature:**
+
+```typescript
+prefix?: IconPrefix;
+```
+

package/dist/brick-types.featureflags.md

@@ -0,0 +1,31 @@
+---
+id: brick-types.featureflags
+title: FeatureFlags
+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; [FeatureFlags](./brick-types.featureflags.md)
+
+## FeatureFlags interface
+
+特性开关字典。
+
+**Signature:**
+
+```typescript
+export declare type FeatureFlags = Record<string, boolean>;
+```
+
+## Example
+
+
+```json
+{
+  "next-builder-dynamic-menu": true
+}
+```
+
+

package/dist/brick-types.generaltransform.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.generaltransform
+title: GeneralTransform
+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; [GeneralTransform](./brick-types.generaltransform.md)
+
+## GeneralTransform interface
+
+数据转换配置。
+
+**Signature:**
+
+```typescript
+export declare type GeneralTransform = string | TransformMap | TransformItem[];
+```
+
+**Reference:** [TransformMap](./brick-types.transformmap.md)<!-- -->, [TransformItem](./brick-types.transformitem.md)
+

package/dist/brick-types.gradientcolor.direction.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.gradientcolor.direction
+title: GradientColor.direction
+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; [GradientColor](./brick-types.gradientcolor.md) &gt; [direction](./brick-types.gradientcolor.direction.md)
+
+## GradientColor.direction property
+
+**Signature:**
+
+```typescript
+direction?: "top-to-bottom" | "left-to-right";
+```
+

package/dist/brick-types.gradientcolor.endcolor.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.gradientcolor.endcolor
+title: GradientColor.endColor
+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; [GradientColor](./brick-types.gradientcolor.md) &gt; [endColor](./brick-types.gradientcolor.endcolor.md)
+
+## GradientColor.endColor property
+
+**Signature:**
+
+```typescript
+endColor: string;
+```
+

package/dist/brick-types.gradientcolor.md

@@ -0,0 +1,29 @@
+---
+id: brick-types.gradientcolor
+title: GradientColor
+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; [GradientColor](./brick-types.gradientcolor.md)
+
+## GradientColor interface
+
+渐变颜色配置
+
+**Signature:**
+
+```typescript
+export interface GradientColor
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [direction](./brick-types.gradientcolor.direction.md) | "top-to-bottom" \| "left-to-right" |  |
+|  [endColor](./brick-types.gradientcolor.endcolor.md) | string |  |
+|  [startColor](./brick-types.gradientcolor.startcolor.md) | string |  |
+

package/dist/brick-types.gradientcolor.startcolor.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.gradientcolor.startcolor
+title: GradientColor.startColor
+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; [GradientColor](./brick-types.gradientcolor.md) &gt; [startColor](./brick-types.gradientcolor.startcolor.md)
+
+## GradientColor.startColor property
+
+**Signature:**
+
+```typescript
+startColor: string;
+```
+

package/dist/brick-types.handlereject.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.handlereject
+title: HandleReject
+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; [HandleReject](./brick-types.handlereject.md)
+
+## HandleReject interface
+
+当异步数据处理抛出错误时，使用该错误对象作为数据源进行转换来作为最终结果。
+
+**Signature:**
+
+```typescript
+export declare type HandleReject = HandleRejectByTransform | HandleRejectByCatch;
+```
+
+**Reference:** [HandleRejectByTransform](./brick-types.handlerejectbytransform.md)<!-- -->, [HandleRejectByCatch](./brick-types.handlerejectbycatch.md)
+

package/dist/brick-types.handlerejectbycatch.isolatedcrash.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.handlerejectbycatch.isolatedcrash
+title: HandleRejectByCatch.isolatedCrash
+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; [HandleRejectByCatch](./brick-types.handlerejectbycatch.md) &gt; [isolatedCrash](./brick-types.handlerejectbycatch.isolatedcrash.md)
+
+## HandleRejectByCatch.isolatedCrash property
+
+只让构件报错。
+
+**Signature:**
+
+```typescript
+isolatedCrash: true;
+```
+

package/dist/brick-types.handlerejectbycatch.md

@@ -0,0 +1,27 @@
+---
+id: brick-types.handlerejectbycatch
+title: HandleRejectByCatch
+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; [HandleRejectByCatch](./brick-types.handlerejectbycatch.md)
+
+## HandleRejectByCatch interface
+
+当异步数据处理抛出错误时，捕获它，可以设置只对应的构件报错，而不是页面整体报错。
+
+**Signature:**
+
+```typescript
+export interface HandleRejectByCatch
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [isolatedCrash](./brick-types.handlerejectbycatch.isolatedcrash.md) | true | 只让构件报错。 |
+

package/dist/brick-types.handlerejectbytransform.md

@@ -0,0 +1,27 @@
+---
+id: brick-types.handlerejectbytransform
+title: HandleRejectByTransform
+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; [HandleRejectByTransform](./brick-types.handlerejectbytransform.md)
+
+## HandleRejectByTransform interface
+
+当异步数据处理抛出错误时，使用该错误对象作为数据源进行转换来作为最终结果。
+
+**Signature:**
+
+```typescript
+export interface HandleRejectByTransform
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [transform](./brick-types.handlerejectbytransform.transform.md) | [GeneralTransform](./brick-types.generaltransform.md) | 数据转换配置。 |
+

package/dist/brick-types.handlerejectbytransform.transform.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.handlerejectbytransform.transform
+title: HandleRejectByTransform.transform
+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; [HandleRejectByTransform](./brick-types.handlerejectbytransform.md) &gt; [transform](./brick-types.handlerejectbytransform.transform.md)
+
+## HandleRejectByTransform.transform property
+
+数据转换配置。
+
+**Signature:**
+
+```typescript
+transform: GeneralTransform;
+```
+
+**Reference:** [GeneralTransform](./brick-types.generaltransform.md)
+

package/dist/brick-types.i18ndata.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.i18ndata
+title: I18nData
+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; [I18nData](./brick-types.i18ndata.md)
+
+## I18nData interface
+
+国际化数据，以语言为键、文本内容为值的键值对。
+
+**Signature:**
+
+```typescript
+export interface I18nData
+```
+

package/dist/brick-types.interceptorparams.ignoreloadingbar.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.interceptorparams.ignoreloadingbar
+title: InterceptorParams.ignoreLoadingBar
+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; [InterceptorParams](./brick-types.interceptorparams.md) &gt; [ignoreLoadingBar](./brick-types.interceptorparams.ignoreloadingbar.md)
+
+## InterceptorParams.ignoreLoadingBar property
+
+是否忽略该请求对系统加载进度条的通知。
+
+**Signature:**
+
+```typescript
+ignoreLoadingBar?: boolean;
+```
+

package/dist/brick-types.interceptorparams.md

@@ -0,0 +1,27 @@
+---
+id: brick-types.interceptorparams
+title: InterceptorParams
+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; [InterceptorParams](./brick-types.interceptorparams.md)
+
+## InterceptorParams interface
+
+用于 http 请求的拦截器参数。
+
+**Signature:**
+
+```typescript
+export interface InterceptorParams
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [ignoreLoadingBar](./brick-types.interceptorparams.ignoreloadingbar.md) | boolean | 是否忽略该请求对系统加载进度条的通知。 |
+

package/dist/brick-types.isrouteconfofbricks.md

@@ -0,0 +1,29 @@
+---
+id: brick-types.isrouteconfofbricks
+title: isRouteConfOfBricks()
+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; [isRouteConfOfBricks](./brick-types.isrouteconfofbricks.md)
+
+## isRouteConfOfBricks() function
+
+**Signature:**
+
+```typescript
+export declare function isRouteConfOfBricks(conf: RouteConf): conf is RouteConfOfBricks;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  conf | [RouteConf](./brick-types.routeconf.md) |  |
+
+**Returns:**
+
+conf is [RouteConfOfBricks](./brick-types.routeconfofbricks.md)
+

package/dist/brick-types.isrouteconfofroutes.md

@@ -0,0 +1,29 @@
+---
+id: brick-types.isrouteconfofroutes
+title: isRouteConfOfRoutes()
+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; [isRouteConfOfRoutes](./brick-types.isrouteconfofroutes.md)
+
+## isRouteConfOfRoutes() function
+
+**Signature:**
+
+```typescript
+export declare function isRouteConfOfRoutes(conf: RouteConf): conf is RouteConfOfRoutes;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  conf | [RouteConf](./brick-types.routeconf.md) |  |
+
+**Returns:**
+
+conf is [RouteConfOfRoutes](./brick-types.routeconfofroutes.md)
+

package/dist/brick-types.layouttype.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.layouttype
+title: LayoutType
+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; [LayoutType](./brick-types.layouttype.md)
+
+## LayoutType interface
+
+页面整体布局类型。
+
+**Signature:**
+
+```typescript
+export declare type LayoutType = "console" | "business";
+```
+

package/dist/brick-types.legacyantdicon.color.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.legacyantdicon.color
+title: LegacyAntdIcon.color
+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; [LegacyAntdIcon](./brick-types.legacyantdicon.md) &gt; [color](./brick-types.legacyantdicon.color.md)
+
+## LegacyAntdIcon.color property
+
+**Signature:**
+
+```typescript
+color?: string | GradientColor;
+```
+
+**Reference:** [GradientColor](./brick-types.gradientcolor.md)
+

package/dist/brick-types.legacyantdicon.lib.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.legacyantdicon.lib
+title: LegacyAntdIcon.lib
+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; [LegacyAntdIcon](./brick-types.legacyantdicon.md) &gt; [lib](./brick-types.legacyantdicon.lib.md)
+
+## LegacyAntdIcon.lib property
+
+**Signature:**
+
+```typescript
+lib: "antd";
+```
+