@next-core/next-docs 1.2.561 → 1.2.562

package/dist/brick-types.breadcrumbconf.md

@@ -1,67 +0,0 @@
----
-id: brick-types.breadcrumbconf
-title: BreadcrumbConf
-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; [BreadcrumbConf](./brick-types.breadcrumbconf.md)
-
-## BreadcrumbConf interface
-
-面包屑配置。
-
-**Signature:**
-
-```typescript
-export interface BreadcrumbConf
-```
-
-## Remarks
-
-每一层路由都可以按需配置零个、一个或多个面包屑，系统将组合这些面包屑显示在页面顶栏中。
-
-通过 `overwrite` 指定是否覆盖上层路由已有的面包屑列表（默认为追加模式）。
-
-注意系统将始终在面包屑起始位置显示当前应用的名字。
-
-## Example
-
-
-```yaml
-routes:
-  - path: "${APP.homepage}/products"
-    menu:
-      breadcrumb:
-        items:
-          text: "Products"
-          to: "${APP.homepage}/products"
-    bricks:
-      - brick: "your.brick"
-        slots:
-          content:
-            type: "routes"
-            routes:
-              - path: "${APP.homepage}/products/:productId"
-                menu:
-                  breadcrumb:
-                    items:
-                      text: "Product Detail"
-                      to: "${APP.homepage}/products/${productId}"
-```
-
-在页面 `/products` 将显示 `Your App > Products` 面包屑。
-
-而在页面 `/products/:productId` 将显示 `Your App > Products > Product Detail` 面包屑。
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [items](./brick-types.breadcrumbconf.items.md) | [BreadcrumbItemConf](./brick-types.breadcrumbitemconf.md)<!-- -->\[\] | 面包屑列表。 |
-|  [noCurrentApp](./brick-types.breadcrumbconf.nocurrentapp.md) | boolean | 是否显示当前AppName |
-|  [overwrite](./brick-types.breadcrumbconf.overwrite.md) | boolean | 是否覆盖上层路由已有的面包屑列表（默认为追加模式）。 |
-|  [useCurrentMenuTitle](./brick-types.breadcrumbconf.usecurrentmenutitle.md) | boolean | 使用当前菜单标题作为面包屑标题 |
-

package/dist/brick-types.breadcrumbconf.nocurrentapp.md

@@ -1,21 +0,0 @@
----
-id: brick-types.breadcrumbconf.nocurrentapp
-title: BreadcrumbConf.noCurrentApp
-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; [BreadcrumbConf](./brick-types.breadcrumbconf.md) &gt; [noCurrentApp](./brick-types.breadcrumbconf.nocurrentapp.md)
-
-## BreadcrumbConf.noCurrentApp property
-
-是否显示当前AppName
-
-**Signature:**
-
-```typescript
-noCurrentApp?: boolean;
-```
-

package/dist/brick-types.breadcrumbconf.overwrite.md

@@ -1,21 +0,0 @@
----
-id: brick-types.breadcrumbconf.overwrite
-title: BreadcrumbConf.overwrite
-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; [BreadcrumbConf](./brick-types.breadcrumbconf.md) &gt; [overwrite](./brick-types.breadcrumbconf.overwrite.md)
-
-## BreadcrumbConf.overwrite property
-
-是否覆盖上层路由已有的面包屑列表（默认为追加模式）。
-
-**Signature:**
-
-```typescript
-overwrite?: boolean;
-```
-

package/dist/brick-types.breadcrumbconf.usecurrentmenutitle.md

@@ -1,21 +0,0 @@
----
-id: brick-types.breadcrumbconf.usecurrentmenutitle
-title: BreadcrumbConf.useCurrentMenuTitle
-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; [BreadcrumbConf](./brick-types.breadcrumbconf.md) &gt; [useCurrentMenuTitle](./brick-types.breadcrumbconf.usecurrentmenutitle.md)
-
-## BreadcrumbConf.useCurrentMenuTitle property
-
-使用当前菜单标题作为面包屑标题
-
-**Signature:**
-
-```typescript
-useCurrentMenuTitle?: boolean;
-```
-

package/dist/brick-types.breadcrumbitemconf.md

@@ -1,28 +0,0 @@
----
-id: brick-types.breadcrumbitemconf
-title: BreadcrumbItemConf
-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; [BreadcrumbItemConf](./brick-types.breadcrumbitemconf.md)
-
-## BreadcrumbItemConf interface
-
-面包屑单项配置。
-
-**Signature:**
-
-```typescript
-export interface BreadcrumbItemConf
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [text](./brick-types.breadcrumbitemconf.text.md) | string | 面包屑文本。 |
-|  [to](./brick-types.breadcrumbitemconf.to.md) | LocationDescriptor&lt;PluginHistoryState&gt; | 面包屑对应的链接。 |
-

package/dist/brick-types.breadcrumbitemconf.text.md

@@ -1,21 +0,0 @@
----
-id: brick-types.breadcrumbitemconf.text
-title: BreadcrumbItemConf.text
-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; [BreadcrumbItemConf](./brick-types.breadcrumbitemconf.md) &gt; [text](./brick-types.breadcrumbitemconf.text.md)
-
-## BreadcrumbItemConf.text property
-
-面包屑文本。
-
-**Signature:**
-
-```typescript
-text: string;
-```
-

package/dist/brick-types.breadcrumbitemconf.to.md

@@ -1,21 +0,0 @@
----
-id: brick-types.breadcrumbitemconf.to
-title: BreadcrumbItemConf.to
-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; [BreadcrumbItemConf](./brick-types.breadcrumbitemconf.md) &gt; [to](./brick-types.breadcrumbitemconf.to.md)
-
-## BreadcrumbItemConf.to property
-
-面包屑对应的链接。
-
-**Signature:**
-
-```typescript
-to?: LocationDescriptor<PluginHistoryState>;
-```
-

package/dist/brick-types.brickconf.bg.md

@@ -1,21 +0,0 @@
----
-id: brick-types.brickconf.bg
-title: BrickConf.bg
-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; [BrickConf](./brick-types.brickconf.md) &gt; [bg](./brick-types.brickconf.bg.md)
-
-## BrickConf.bg property
-
-是否将构件放置到一个不可见的背景容器中，它们通常为 Provider 构件。
-
-**Signature:**
-
-```typescript
-bg?: boolean;
-```
-

package/dist/brick-types.brickconf.brick.md

@@ -1,21 +0,0 @@
----
-id: brick-types.brickconf.brick
-title: BrickConf.brick
-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; [BrickConf](./brick-types.brickconf.md) &gt; [brick](./brick-types.brickconf.brick.md)
-
-## BrickConf.brick property
-
-构件名。
-
-**Signature:**
-
-```typescript
-brick?: string;
-```
-

package/dist/brick-types.brickconf.context.md

@@ -1,23 +0,0 @@
----
-id: brick-types.brickconf.context
-title: BrickConf.context
-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; [BrickConf](./brick-types.brickconf.md) &gt; [context](./brick-types.brickconf.context.md)
-
-## BrickConf.context property
-
-上下文配置列表。
-
-**Signature:**
-
-```typescript
-context?: ContextConf[];
-```
-
-**Reference:** [ContextConf](./brick-types.contextconf.md)
-

package/dist/brick-types.brickconf.events.md

@@ -1,27 +0,0 @@
----
-id: brick-types.brickconf.events
-title: BrickConf.events
-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; [BrickConf](./brick-types.brickconf.md) &gt; [events](./brick-types.brickconf.events.md)
-
-## BrickConf.events property
-
-构件的事件配置表。
-
-**Signature:**
-
-```typescript
-events?: BrickEventsMap;
-```
-
-**Reference:** [BrickEventsMap](./brick-types.brickeventsmap.md)
-
-## Remarks
-
-事件配置表中，键为事件名，值为单个或多个事件处理器配置。
-

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

@@ -1,24 +0,0 @@
----
-id: brick-types.brickconf.if
-title: BrickConf.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; [BrickConf](./brick-types.brickconf.md) &gt; [if](./brick-types.brickconf.if.md)
-
-## BrickConf.if property
-
-条件渲染配置，根据 `if` 的计算结果来决定是否渲染该构件。
-
-
-**Signature:**
-
-```typescript
-if?: string | boolean | ResolveConf;
-```
-
-**Reference:** [ResolveConf](./brick-types.resolveconf.md)
-

package/dist/brick-types.brickconf.iid.md

@@ -1,21 +0,0 @@
----
-id: brick-types.brickconf.iid
-title: BrickConf.iid
-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; [BrickConf](./brick-types.brickconf.md) &gt; [iid](./brick-types.brickconf.iid.md)
-
-## BrickConf.iid property
-
-构件编排 ID
-
-**Signature:**
-
-```typescript
-iid?: string;
-```
-

package/dist/brick-types.brickconf.lifecycle.md

@@ -1,45 +0,0 @@
----
-id: brick-types.brickconf.lifecycle
-title: BrickConf.lifeCycle
-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; [BrickConf](./brick-types.brickconf.md) &gt; [lifeCycle](./brick-types.brickconf.lifecycle.md)
-
-## BrickConf.lifeCycle property
-
-构件生命周期配置。
-
-**Signature:**
-
-```typescript
-lifeCycle?: BrickLifeCycle;
-```
-
-**Reference:** [BrickLifeCycle](./brick-types.bricklifecycle.md)
-
-## Remarks
-
-构件在自身渲染和页面渲染的各个时刻可以执行相关的动作。
-
-其生命周期包含的阶段及其顺序如下：
-
-当页面进入时：
-
-1. `useResolves`
-
-2. `onBeforePageLoad`
-
-3. `onPageLoad`
-
-4. `onAnchorLoad` or `onAnchorUnload`
-
-当页面离开时：
-
-1. `onBeforePageLeave`
-
-2. `onPageLeave`
-

package/dist/brick-types.brickconf.md

@@ -1,39 +0,0 @@
----
-id: brick-types.brickconf
-title: BrickConf
-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; [BrickConf](./brick-types.brickconf.md)
-
-## BrickConf interface
-
-构件配置。
-
-**Signature:**
-
-```typescript
-export interface BrickConf
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [bg](./brick-types.brickconf.bg.md) | boolean | 是否将构件放置到一个不可见的背景容器中，它们通常为 Provider 构件。 |
-|  [brick](./brick-types.brickconf.brick.md) | string | 构件名。 |
-|  [context](./brick-types.brickconf.context.md) | [ContextConf](./brick-types.contextconf.md)<!-- -->\[\] | 上下文配置列表。 |
-|  [events](./brick-types.brickconf.events.md) | [BrickEventsMap](./brick-types.brickeventsmap.md) | 构件的事件配置表。 |
-|  [if](./brick-types.brickconf.if.md) | string \| boolean \| [ResolveConf](./brick-types.resolveconf.md) | 条件渲染配置，根据 <code>if</code> 的计算结果来决定是否渲染该构件。 |
-|  [iid](./brick-types.brickconf.iid.md) | string | 构件编排 ID |
-|  [lifeCycle](./brick-types.brickconf.lifecycle.md) | [BrickLifeCycle](./brick-types.bricklifecycle.md) | 构件生命周期配置。 |
-|  [params](./brick-types.brickconf.params.md) | Record&lt;string, unknown&gt; | （老）模板的参数表。 |
-|  [permissionsPreCheck](./brick-types.brickconf.permissionsprecheck.md) | string\[\] | 预校验的动态权限列表，在编排中可以通过 <code>&lt;% PERMISSIONS.check(&quot;your-action&quot;) %&gt;</code>来校验权限点。 当被校验的权限点为已知字符串，则框架会扫描收集统一校验，不需要在此处声明； 当被校验的权限点需要动态获得，例如通过 <code>QUERY</code>,<code>PATH</code>,<code>CTX</code> 等参数动态计算得到，则需要在 <code>permissionsPreCheck</code> 中提前声明。 如果某个权限点需要在接口中获得，也只需要在 Context 中通过异步 Resolve 提前赋值给 Context 即可。 |
-|  [portal](./brick-types.brickconf.portal.md) | boolean | 标记 <code>portal: true</code> 的构件将被放置到一个“[传送门](https://reactjs.org/docs/portals.html)<!-- -->”容器中，它们通常为 \*Modal\*、\*Drawer\* 等弹窗容器类型的构件。 |
-|  [properties](./brick-types.brickconf.properties.md) | Record&lt;string, unknown&gt; | 构件属性。 |
-|  [slots](./brick-types.brickconf.slots.md) | [SlotsConf](./brick-types.slotsconf.md) | 插槽配置表。 |
-|  [template](./brick-types.brickconf.template.md) | string | （老）模板。 |
-

package/dist/brick-types.brickconf.params.md

@@ -1,26 +0,0 @@
----
-id: brick-types.brickconf.params
-title: BrickConf.params
-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; [BrickConf](./brick-types.brickconf.md) &gt; [params](./brick-types.brickconf.params.md)
-
-## BrickConf.params property
-
-> Warning: This API is now obsolete.
-> 
-> 建议使用[自定义模板](./brick-types.customtemplate.md)<!-- -->代替。
-> 
-
-（老）模板的参数表。
-
-**Signature:**
-
-```typescript
-params?: Record<string, unknown>;
-```
-

package/dist/brick-types.brickconf.permissionsprecheck.md

@@ -1,21 +0,0 @@
----
-id: brick-types.brickconf.permissionsprecheck
-title: BrickConf.permissionsPreCheck
-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; [BrickConf](./brick-types.brickconf.md) &gt; [permissionsPreCheck](./brick-types.brickconf.permissionsprecheck.md)
-
-## BrickConf.permissionsPreCheck property
-
-预校验的动态权限列表，在编排中可以通过 `<% PERMISSIONS.check("your-action") %>`<!-- -->来校验权限点。 当被校验的权限点为已知字符串，则框架会扫描收集统一校验，不需要在此处声明； 当被校验的权限点需要动态获得，例如通过 `QUERY`<!-- -->,`PATH`<!-- -->,`CTX` 等参数动态计算得到，则需要在 `permissionsPreCheck` 中提前声明。 如果某个权限点需要在接口中获得，也只需要在 Context 中通过异步 Resolve 提前赋值给 Context 即可。
-
-**Signature:**
-
-```typescript
-permissionsPreCheck?: string[];
-```
-

package/dist/brick-types.brickconf.portal.md

@@ -1,21 +0,0 @@
----
-id: brick-types.brickconf.portal
-title: BrickConf.portal
-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; [BrickConf](./brick-types.brickconf.md) &gt; [portal](./brick-types.brickconf.portal.md)
-
-## BrickConf.portal property
-
-标记 `portal: true` 的构件将被放置到一个“[传送门](https://reactjs.org/docs/portals.html)<!-- -->”容器中，它们通常为 \*Modal\*、\*Drawer\* 等弹窗容器类型的构件。
-
-**Signature:**
-
-```typescript
-portal?: boolean;
-```
-

package/dist/brick-types.brickconf.properties.md

@@ -1,21 +0,0 @@
----
-id: brick-types.brickconf.properties
-title: BrickConf.properties
-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; [BrickConf](./brick-types.brickconf.md) &gt; [properties](./brick-types.brickconf.properties.md)
-
-## BrickConf.properties property
-
-构件属性。
-
-**Signature:**
-
-```typescript
-properties?: Record<string, unknown>;
-```
-

package/dist/brick-types.brickconf.slots.md

@@ -1,31 +0,0 @@
----
-id: brick-types.brickconf.slots
-title: BrickConf.slots
-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; [BrickConf](./brick-types.brickconf.md) &gt; [slots](./brick-types.brickconf.slots.md)
-
-## BrickConf.slots property
-
-插槽配置表。
-
-**Signature:**
-
-```typescript
-slots?: SlotsConf;
-```
-
-**Reference:** [SlotsConf](./brick-types.slotsconf.md)
-
-## Remarks
-
-对于容器类构件，会有特定的插槽以供插入子构件，容器构件通常会对这些插槽内的子构件有不同的布局及交互处理。
-
-`slots` 为 key-value 键值对配置，其中 key 为插槽名称，value 为插槽配置。
-
-每个插槽配置有两种模式：构件列表和路由列表。 对于构件列表，容器将直接插入这些子构件。 而对于路由构件，系统将根据路由匹配进行渲染。
-

package/dist/brick-types.brickconf.template.md

@@ -1,26 +0,0 @@
----
-id: brick-types.brickconf.template
-title: BrickConf.template
-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; [BrickConf](./brick-types.brickconf.md) &gt; [template](./brick-types.brickconf.template.md)
-
-## BrickConf.template property
-
-> Warning: This API is now obsolete.
-> 
-> 建议使用[自定义模板](./brick-types.customtemplate.md)<!-- -->代替。
-> 
-
-（老）模板。
-
-**Signature:**
-
-```typescript
-template?: string;
-```
-

package/dist/brick-types.brickconfintemplate.md

@@ -1,27 +0,0 @@
----
-id: brick-types.brickconfintemplate
-title: BrickConfInTemplate
-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; [BrickConfInTemplate](./brick-types.brickconfintemplate.md)
-
-## BrickConfInTemplate interface
-
-自定义模板渲染的构件配置。
-
-**Signature:**
-
-```typescript
-export declare type BrickConfInTemplate = Omit<BrickConf, "brick" | "slots" | "template" | "params"> & {
-    brick: string;
-    ref?: string;
-    slots?: SlotsConfInTemplate;
-};
-```
-
-**Reference:** [BrickConf](./brick-types.brickconf.md)<!-- -->, [SlotsConfInTemplate](./brick-types.slotsconfintemplate.md)
-

package/dist/brick-types.brickeventhandler.md

@@ -1,23 +0,0 @@
----
-id: brick-types.brickeventhandler
-title: BrickEventHandler
-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; [BrickEventHandler](./brick-types.brickeventhandler.md)
-
-## BrickEventHandler interface
-
-事件处理器配置。
-
-**Signature:**
-
-```typescript
-export declare type BrickEventHandler = BuiltinBrickEventHandler | UseProviderEventHandler | CustomBrickEventHandler | ConditionalEventHandler;
-```
-
-**Reference:** [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md)<!-- -->, [UseProviderEventHandler](./brick-types.useprovidereventhandler.md)<!-- -->, [CustomBrickEventHandler](./brick-types.custombrickeventhandler.md)<!-- -->, [ConditionalEventHandler](./brick-types.conditionaleventhandler.md)
-

package/dist/brick-types.brickeventhandlercallback.error.md

@@ -1,23 +0,0 @@
----
-id: brick-types.brickeventhandlercallback.error
-title: BrickEventHandlerCallback.error
-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; [BrickEventHandlerCallback](./brick-types.brickeventhandlercallback.md) &gt; [error](./brick-types.brickeventhandlercallback.error.md)
-
-## BrickEventHandlerCallback.error property
-
-事件处理执行失败时要执行的动作。为后续动作传递的事件的 `detail` 为该错误对象。
-
-**Signature:**
-
-```typescript
-error?: BrickEventHandler | BrickEventHandler[];
-```
-
-**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
-