@next-core/next-docs 1.2.553 → 1.2.555

package/dist/brick-types.extendedhistory.md

@@ -1,33 +0,0 @@
----
-id: brick-types.extendedhistory
-title: ExtendedHistory
-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)
-
-## ExtendedHistory interface
-
-扩展的系统会话对象。
-
-**Signature:**
-
-```typescript
-export interface ExtendedHistory
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [push](./brick-types.extendedhistory.push.md) | (location: LocationDescriptor&lt;PluginHistoryState&gt;, state?: PluginHistoryState, callback?: (blocked: boolean) =&gt; void) =&gt; void | 推入一条记录。 |
-|  [pushAnchor](./brick-types.extendedhistory.pushanchor.md) | [UpdateAnchorFunction](./brick-types.updateanchorfunction.md) | 设置指定的 anchor （URL hash）地址，此方法默认不会触发页面重新渲染。 往浏览器会话历史栈中推入一条新记录。 |
-|  [pushQuery](./brick-types.extendedhistory.pushquery.md) | [UpdateQueryFunction](./brick-types.updatequeryfunction.md) | 更新指定的 query 参数，会保留当前其它 query 参数，往浏览器会话历史栈中推入一条新记录。 |
-|  [reload](./brick-types.extendedhistory.reload.md) | (callback?: (blocked: boolean) =&gt; void) =&gt; void | 重载当前会话，即触发页面重新渲染。与 location.reload() 不同，它不会触发浏览器页面的重载。 |
-|  [replace](./brick-types.extendedhistory.replace.md) | (location: LocationDescriptor&lt;PluginHistoryState&gt;, state?: PluginHistoryState, callback?: (blocked: boolean) =&gt; void) =&gt; void | 替换一条记录。 |
-|  [replaceQuery](./brick-types.extendedhistory.replacequery.md) | [UpdateQueryFunction](./brick-types.updatequeryfunction.md) | 更新指定的 query 参数，会保留当前其它 query 参数，替换浏览器会话历史栈中最新的一条记录。 |
-|  [unblock](./brick-types.extendedhistory.unblock.md) | () =&gt; void | 取消之前设置的阻止页面离开信息的设置。 |
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.extendedhistory.push
-title: ExtendedHistory.push
-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; [push](./brick-types.extendedhistory.push.md)
-
-## ExtendedHistory.push property
-
-推入一条记录。
-
-**Signature:**
-
-```typescript
-push?: (location: LocationDescriptor<PluginHistoryState>, state?: PluginHistoryState, callback?: (blocked: boolean) => void) => void;
-```
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.extendedhistory.pushanchor
-title: ExtendedHistory.pushAnchor
-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; [pushAnchor](./brick-types.extendedhistory.pushanchor.md)
-
-## ExtendedHistory.pushAnchor property
-
-设置指定的 anchor （URL hash）地址，此方法默认不会触发页面重新渲染。 往浏览器会话历史栈中推入一条新记录。
-
-**Signature:**
-
-```typescript
-pushAnchor: UpdateAnchorFunction;
-```
-
-**Reference:** [UpdateAnchorFunction](./brick-types.updateanchorfunction.md)
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.extendedhistory.pushquery
-title: ExtendedHistory.pushQuery
-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; [pushQuery](./brick-types.extendedhistory.pushquery.md)
-
-## ExtendedHistory.pushQuery property
-
-更新指定的 query 参数，会保留当前其它 query 参数，往浏览器会话历史栈中推入一条新记录。
-
-**Signature:**
-
-```typescript
-pushQuery: UpdateQueryFunction;
-```
-
-**Reference:** [UpdateQueryFunction](./brick-types.updatequeryfunction.md)
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.extendedhistory.reload
-title: ExtendedHistory.reload
-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; [reload](./brick-types.extendedhistory.reload.md)
-
-## ExtendedHistory.reload property
-
-重载当前会话，即触发页面重新渲染。与 location.reload() 不同，它不会触发浏览器页面的重载。
-
-**Signature:**
-
-```typescript
-reload: (callback?: (blocked: boolean) => void) => void;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.extendedhistory.replace
-title: ExtendedHistory.replace
-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; [replace](./brick-types.extendedhistory.replace.md)
-
-## ExtendedHistory.replace property
-
-替换一条记录。
-
-**Signature:**
-
-```typescript
-replace?: (location: LocationDescriptor<PluginHistoryState>, state?: PluginHistoryState, callback?: (blocked: boolean) => void) => void;
-```
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.extendedhistory.replacequery
-title: ExtendedHistory.replaceQuery
-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; [replaceQuery](./brick-types.extendedhistory.replacequery.md)
-
-## ExtendedHistory.replaceQuery property
-
-更新指定的 query 参数，会保留当前其它 query 参数，替换浏览器会话历史栈中最新的一条记录。
-
-**Signature:**
-
-```typescript
-replaceQuery: UpdateQueryFunction;
-```
-
-**Reference:** [UpdateQueryFunction](./brick-types.updatequeryfunction.md)
-

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

@@ -1,21 +0,0 @@
----
-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

@@ -1,26 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,30 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,31 +0,0 @@
----
-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

@@ -1,23 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,29 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,23 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,27 +0,0 @@
----
-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

@@ -1,27 +0,0 @@
----
-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

@@ -1,23 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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
-```
-