@next-core/next-docs 1.2.574 → 1.2.577

package/dist/brick-types.conditionaleventhandler.else.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.conditionaleventhandler.else
+title: ConditionalEventHandler.else
+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; [ConditionalEventHandler](./brick-types.conditionaleventhandler.md) &gt; [else](./brick-types.conditionaleventhandler.else.md)
+
+## ConditionalEventHandler.else property
+
+不满足条件分支
+
+**Signature:**
+
+```typescript
+else?: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

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

@@ -0,0 +1,21 @@
+---
+id: brick-types.conditionaleventhandler.if
+title: ConditionalEventHandler.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; [ConditionalEventHandler](./brick-types.conditionaleventhandler.md) &gt; [if](./brick-types.conditionaleventhandler.if.md)
+
+## ConditionalEventHandler.if property
+
+根据条件决定是否执行该动作。
+
+**Signature:**
+
+```typescript
+if?: string | boolean;
+```
+

package/dist/brick-types.conditionaleventhandler.md

@@ -0,0 +1,27 @@
+---
+id: brick-types.conditionaleventhandler
+title: ConditionalEventHandler
+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; [ConditionalEventHandler](./brick-types.conditionaleventhandler.md)
+
+## ConditionalEventHandler interface
+
+**Signature:**
+
+```typescript
+export interface ConditionalEventHandler
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [else](./brick-types.conditionaleventhandler.else.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 不满足条件分支 |
+|  [if](./brick-types.conditionaleventhandler.if.md) | string \| boolean | 根据条件决定是否执行该动作。 |
+|  [then](./brick-types.conditionaleventhandler.then.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 满足条件分支 |
+

package/dist/brick-types.conditionaleventhandler.then.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.conditionaleventhandler.then
+title: ConditionalEventHandler.then
+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; [ConditionalEventHandler](./brick-types.conditionaleventhandler.md) &gt; [then](./brick-types.conditionaleventhandler.then.md)
+
+## ConditionalEventHandler.then property
+
+满足条件分支
+
+**Signature:**
+
+```typescript
+then: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

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

@@ -0,0 +1,21 @@
+---
+id: brick-types.contextconf.if
+title: ContextConf.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; [ContextConf](./brick-types.contextconf.md) &gt; [if](./brick-types.contextconf.if.md)
+
+## ContextConf.if property
+
+条件配置，根据 `if` 的计算结果来决定是否启用该上下文。不适用于绑定构件属性的数据。
+
+**Signature:**
+
+```typescript
+if?: string | boolean;
+```
+

package/dist/brick-types.contextconf.md

@@ -0,0 +1,78 @@
+---
+id: brick-types.contextconf
+title: ContextConf
+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; [ContextConf](./brick-types.contextconf.md)
+
+## ContextConf interface
+
+上下文（数据）配置
+
+**Signature:**
+
+```typescript
+export interface ContextConf
+```
+
+## Remarks
+
+上下文类似于编程语言中的\*变量\*的概念，提前声明，按需赋值或修改，然后在需要的地方读取它。
+
+## Example
+
+定义方式一（自由变量）：
+
+```yaml
+context:
+  - name: myContext
+    # 初始 `value` 可以使用占位符。
+    value:
+      quality: good
+
+  # 初始 `value` 是可选的。
+  - name: myAnotherContext
+```
+
+定义方式二（异步 Resolve 的自由变量）：
+
+```yaml
+context:
+  - name: myAsyncContext
+    resolve:
+      useProvider: my.any-provider
+      # 默认将使用 Provider 返回的数据作为该 Context 的值（brick_next >= 1.25.2 支持）。
+      # 如果需要转换数据，注意需使用 transform 后的 value 值。
+      transform:
+        # `CTX.myAsyncContext` 的值将是 `DATA.hostname`。
+        value: '<% DATA.hostname %>'
+```
+
+定义方式三（绑定构件属性）：
+
+```yaml
+bricks:
+  - brick: my.source-brick
+    context:
+      - name: myContextRelatedToProp
+        # 绑定构件属性的方式实际存储的是引用关系，在消费时实时获取。
+        property: sourceProp
+```
+
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [if](./brick-types.contextconf.if.md) | string \| boolean | 条件配置，根据 <code>if</code> 的计算结果来决定是否启用该上下文。不适用于绑定构件属性的数据。 |
+|  [name](./brick-types.contextconf.name.md) | string | 上下文（数据）名称。 |
+|  [onChange](./brick-types.contextconf.onchange.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 当数据发生变化时触发的事件。注意，该事件仅适用于自由变量或异步处理的数据，不适用于绑定构件属性的数据。 |
+|  [property](./brick-types.contextconf.property.md) | string | 要绑定的构件属性名。 |
+|  [resolve](./brick-types.contextconf.resolve.md) | [ContextResolveConf](./brick-types.contextresolveconf.md) | 异步处理配置。如需 transform，将使用转换后的结果的 <code>value</code> 字段作为值。 |
+|  [track](./brick-types.contextconf.track.md) | boolean | 是否自动跟踪自己依赖的上下文数据，当它们变化时自动计算获得新的值。 |
+|  [value](./brick-types.contextconf.value.md) | unknown | 自由变量类型的上下文的值。 |
+

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

@@ -0,0 +1,21 @@
+---
+id: brick-types.contextconf.name
+title: ContextConf.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; [ContextConf](./brick-types.contextconf.md) &gt; [name](./brick-types.contextconf.name.md)
+
+## ContextConf.name property
+
+上下文（数据）名称。
+
+**Signature:**
+
+```typescript
+name: string;
+```
+

package/dist/brick-types.contextconf.onchange.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.contextconf.onchange
+title: ContextConf.onChange
+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; [ContextConf](./brick-types.contextconf.md) &gt; [onChange](./brick-types.contextconf.onchange.md)
+
+## ContextConf.onChange property
+
+当数据发生变化时触发的事件。注意，该事件仅适用于自由变量或异步处理的数据，不适用于绑定构件属性的数据。
+
+**Signature:**
+
+```typescript
+onChange?: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

package/dist/brick-types.contextconf.property.md

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

package/dist/brick-types.contextconf.resolve.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.contextconf.resolve
+title: ContextConf.resolve
+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; [ContextConf](./brick-types.contextconf.md) &gt; [resolve](./brick-types.contextconf.resolve.md)
+
+## ContextConf.resolve property
+
+异步处理配置。如需 transform，将使用转换后的结果的 `value` 字段作为值。
+
+**Signature:**
+
+```typescript
+resolve?: ContextResolveConf;
+```
+
+**Reference:** [ContextResolveConf](./brick-types.contextresolveconf.md)
+

package/dist/brick-types.contextconf.track.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contextconf.track
+title: ContextConf.track
+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; [ContextConf](./brick-types.contextconf.md) &gt; [track](./brick-types.contextconf.track.md)
+
+## ContextConf.track property
+
+是否自动跟踪自己依赖的上下文数据，当它们变化时自动计算获得新的值。
+
+**Signature:**
+
+```typescript
+track?: boolean;
+```
+

package/dist/brick-types.contextconf.value.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contextconf.value
+title: ContextConf.value
+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; [ContextConf](./brick-types.contextconf.md) &gt; [value](./brick-types.contextconf.value.md)
+
+## ContextConf.value property
+
+自由变量类型的上下文的值。
+
+**Signature:**
+
+```typescript
+value?: unknown;
+```
+

package/dist/brick-types.contextresolveconf.md

@@ -0,0 +1,27 @@
+---
+id: brick-types.contextresolveconf
+title: ContextResolveConf
+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; [ContextResolveConf](./brick-types.contextresolveconf.md)
+
+## ContextResolveConf interface
+
+用于 Context 的异步数据处理配置。
+
+**Signature:**
+
+```typescript
+export declare type ContextResolveConf = ResolveConf & {
+    async?: boolean;
+    lazy?: boolean;
+    trigger?: ContextResolveTriggerBrickLifeCycle;
+};
+```
+
+**Reference:** [ResolveConf](./brick-types.resolveconf.md)<!-- -->, [ContextResolveTriggerBrickLifeCycle](./brick-types.contextresolvetriggerbricklifecycle.md)
+

package/dist/brick-types.contextresolvetriggerbricklifecycle.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contextresolvetriggerbricklifecycle
+title: ContextResolveTriggerBrickLifeCycle
+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; [ContextResolveTriggerBrickLifeCycle](./brick-types.contextresolvetriggerbricklifecycle.md)
+
+## ContextResolveTriggerBrickLifeCycle interface
+
+Context 的异步数据处理配置为 `trigger` 时支持的生命周期
+
+**Signature:**
+
+```typescript
+export declare type ContextResolveTriggerBrickLifeCycle = "onBeforePageLoad" | "onPageLoad" | "onBeforePageLeave" | "onPageLeave" | "onAnchorLoad" | "onAnchorUnload";
+```
+

package/dist/brick-types.contract.endpoint.md

@@ -0,0 +1,25 @@
+---
+id: brick-types.contract.endpoint
+title: Contract.endpoint
+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; [Contract](./brick-types.contract.md) &gt; [endpoint](./brick-types.contract.endpoint.md)
+
+## Contract.endpoint property
+
+**Signature:**
+
+```typescript
+endpoint: {
+        method: "POST" | "post" | "PUT" | "put" | "GET" | "get" | "DELETE" | "delete" | "LIST" | "list" | "PATCH" | "patch" | "HEAD" | "head";
+        uri: string;
+        ext_fields?: ExtField[];
+    };
+```
+
+**Reference:** [ExtField](./brick-types.extfield.md)
+

package/dist/brick-types.contract.md

@@ -0,0 +1,31 @@
+---
+id: brick-types.contract
+title: Contract
+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; [Contract](./brick-types.contract.md)
+
+## Contract interface
+
+**Signature:**
+
+```typescript
+export interface Contract
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [endpoint](./brick-types.contract.endpoint.md) | { method: "POST" \| "post" \| "PUT" \| "put" \| "GET" \| "get" \| "DELETE" \| "delete" \| "LIST" \| "list" \| "PATCH" \| "patch" \| "HEAD" \| "head"; uri: string; ext\_fields?: [ExtField](./brick-types.extfield.md)<!-- -->\[\]; } |  |
+|  [name](./brick-types.contract.name.md) | string |  |
+|  [namespaceId](./brick-types.contract.namespaceid.md) | string |  |
+|  [request](./brick-types.contract.request.md) | [ContractRequest](./brick-types.contractrequest.md) |  |
+|  [response](./brick-types.contract.response.md) | [ContractResponse](./brick-types.contractresponse.md) |  |
+|  [serviceName](./brick-types.contract.servicename.md) | string |  |
+|  [version](./brick-types.contract.version.md) | string |  |
+

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

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

package/dist/brick-types.contract.namespaceid.md

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

package/dist/brick-types.contract.request.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contract.request
+title: Contract.request
+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; [Contract](./brick-types.contract.md) &gt; [request](./brick-types.contract.request.md)
+
+## Contract.request property
+
+**Signature:**
+
+```typescript
+request?: ContractRequest;
+```
+
+**Reference:** [ContractRequest](./brick-types.contractrequest.md)
+

package/dist/brick-types.contract.response.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contract.response
+title: Contract.response
+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; [Contract](./brick-types.contract.md) &gt; [response](./brick-types.contract.response.md)
+
+## Contract.response property
+
+**Signature:**
+
+```typescript
+response?: ContractResponse;
+```
+
+**Reference:** [ContractResponse](./brick-types.contractresponse.md)
+

package/dist/brick-types.contract.servicename.md

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

package/dist/brick-types.contract.version.md

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

package/dist/brick-types.contractfield.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contractfield
+title: ContractField
+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; [ContractField](./brick-types.contractfield.md)
+
+## ContractField interface
+
+**Signature:**
+
+```typescript
+export declare type ContractField = ContractFieldItem | ContractFieldRefItem;
+```
+
+**Reference:** [ContractFieldItem](./brick-types.contractfielditem.md)<!-- -->, [ContractFieldRefItem](./brick-types.contractfieldrefitem.md)
+

package/dist/brick-types.contractfielditem.description.md

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

package/dist/brick-types.contractfielditem.fields.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contractfielditem.fields
+title: ContractFieldItem.fields
+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; [ContractFieldItem](./brick-types.contractfielditem.md) &gt; [fields](./brick-types.contractfielditem.fields.md)
+
+## ContractFieldItem.fields property
+
+**Signature:**
+
+```typescript
+fields?: (ContractFieldItem | ContractFieldRefItem)[];
+```
+
+**Reference:** [ContractFieldItem](./brick-types.contractfielditem.md)<!-- -->, [ContractFieldRefItem](./brick-types.contractfieldrefitem.md)
+

package/dist/brick-types.contractfielditem.md

@@ -0,0 +1,28 @@
+---
+id: brick-types.contractfielditem
+title: ContractFieldItem
+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; [ContractFieldItem](./brick-types.contractfielditem.md)
+
+## ContractFieldItem interface
+
+**Signature:**
+
+```typescript
+export interface ContractFieldItem
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [description](./brick-types.contractfielditem.description.md) | string |  |
+|  [fields](./brick-types.contractfielditem.fields.md) | ([ContractFieldItem](./brick-types.contractfielditem.md) \| [ContractFieldRefItem](./brick-types.contractfieldrefitem.md)<!-- -->)\[\] |  |
+|  [name](./brick-types.contractfielditem.name.md) | string |  |
+|  [type](./brick-types.contractfielditem.type.md) | string |  |
+