@next-core/next-docs 1.2.555 → 1.2.557

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

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

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

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

package/dist/brick-types.contractfieldrefitem.md

@@ -0,0 +1,25 @@
+---
+id: brick-types.contractfieldrefitem
+title: ContractFieldRefItem
+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; [ContractFieldRefItem](./brick-types.contractfieldrefitem.md)
+
+## ContractFieldRefItem interface
+
+**Signature:**
+
+```typescript
+export interface ContractFieldRefItem
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [ref](./brick-types.contractfieldrefitem.ref.md) | string |  |
+

package/dist/brick-types.contractfieldrefitem.ref.md

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

package/dist/brick-types.contractrequest.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.contractrequest
+title: ContractRequest
+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; [ContractRequest](./brick-types.contractrequest.md)
+
+## ContractRequest interface
+
+**Signature:**
+
+```typescript
+export declare type ContractRequest = Omit<ContractResponse, "wrapper">;
+```
+
+**Reference:** [ContractResponse](./brick-types.contractresponse.md)
+

package/dist/brick-types.contractresponse.default.md

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

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

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

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

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

package/dist/brick-types.contractresponse.md

@@ -0,0 +1,30 @@
+---
+id: brick-types.contractresponse
+title: ContractResponse
+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; [ContractResponse](./brick-types.contractresponse.md)
+
+## ContractResponse interface
+
+**Signature:**
+
+```typescript
+export interface ContractResponse
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [default](./brick-types.contractresponse.default.md) | Record&lt;string, any&gt; |  |
+|  [description](./brick-types.contractresponse.description.md) | string |  |
+|  [fields](./brick-types.contractresponse.fields.md) | [ContractField](./brick-types.contractfield.md)<!-- -->\[\] |  |
+|  [required](./brick-types.contractresponse.required.md) | string\[\] |  |
+|  [type](./brick-types.contractresponse.type.md) | "file" \| "object" |  |
+|  [wrapper](./brick-types.contractresponse.wrapper.md) | boolean |  |
+

package/dist/brick-types.contractresponse.required.md

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

package/dist/brick-types.contractresponse.type.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.contractresponse.type
+title: ContractResponse.type
+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; [ContractResponse](./brick-types.contractresponse.md) &gt; [type](./brick-types.contractresponse.type.md)
+
+## ContractResponse.type property
+
+**Signature:**
+
+```typescript
+type?: "file" | "object";
+```
+

package/dist/brick-types.contractresponse.wrapper.md

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

package/dist/brick-types.custombrickeventhandler.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.custombrickeventhandler
+title: CustomBrickEventHandler
+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; [CustomBrickEventHandler](./brick-types.custombrickeventhandler.md)
+
+## CustomBrickEventHandler interface
+
+使用指定构件进行事件处理的配置。
+
+**Signature:**
+
+```typescript
+export declare type CustomBrickEventHandler = ExecuteCustomBrickEventHandler | SetPropsCustomBrickEventHandler;
+```
+
+**Reference:** [ExecuteCustomBrickEventHandler](./brick-types.executecustombrickeventhandler.md)<!-- -->, [SetPropsCustomBrickEventHandler](./brick-types.setpropscustombrickeventhandler.md)
+

package/dist/brick-types.customtemplate.bricks.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.customtemplate.bricks
+title: CustomTemplate.bricks
+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; [CustomTemplate](./brick-types.customtemplate.md) &gt; [bricks](./brick-types.customtemplate.bricks.md)
+
+## CustomTemplate.bricks property
+
+自定义模板渲染的构件配置列表。
+
+**Signature:**
+
+```typescript
+bricks: BrickConfInTemplate[];
+```
+
+**Reference:** [BrickConfInTemplate](./brick-types.brickconfintemplate.md)
+

package/dist/brick-types.customtemplate.contracts.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.customtemplate.contracts
+title: CustomTemplate.contracts
+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; [CustomTemplate](./brick-types.customtemplate.md) &gt; [contracts](./brick-types.customtemplate.contracts.md)
+
+## CustomTemplate.contracts property
+
+契约的定义，只有 widget 才有该字段
+
+**Signature:**
+
+```typescript
+contracts?: Contract[];
+```
+
+**Reference:** [Contract](./brick-types.contract.md)
+

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

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

package/dist/brick-types.customtemplate.md

@@ -0,0 +1,32 @@
+---
+id: brick-types.customtemplate
+title: CustomTemplate
+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; [CustomTemplate](./brick-types.customtemplate.md)
+
+## CustomTemplate interface
+
+自定义模板配置。
+
+**Signature:**
+
+```typescript
+export interface CustomTemplate
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [bricks](./brick-types.customtemplate.bricks.md) | [BrickConfInTemplate](./brick-types.brickconfintemplate.md)<!-- -->\[\] | 自定义模板渲染的构件配置列表。 |
+|  [contracts](./brick-types.customtemplate.contracts.md) | [Contract](./brick-types.contract.md)<!-- -->\[\] | 契约的定义，只有 widget 才有该字段 |
+|  [iid](./brick-types.customtemplate.iid.md) | string | 构件编排 ID |
+|  [name](./brick-types.customtemplate.name.md) | string | 自定义模板的名称。 |
+|  [proxy](./brick-types.customtemplate.proxy.md) | [CustomTemplateProxy](./brick-types.customtemplateproxy.md) | 自定义模板的代理配置。 |
+|  [state](./brick-types.customtemplate.state.md) | [CustomTemplateState](./brick-types.customtemplatestate.md)<!-- -->\[\] | 状态数据配置列表。 |
+

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

@@ -0,0 +1,21 @@
+---
+id: brick-types.customtemplate.name
+title: CustomTemplate.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; [CustomTemplate](./brick-types.customtemplate.md) &gt; [name](./brick-types.customtemplate.name.md)
+
+## CustomTemplate.name property
+
+自定义模板的名称。
+
+**Signature:**
+
+```typescript
+name: string;
+```
+

package/dist/brick-types.customtemplate.proxy.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.customtemplate.proxy
+title: CustomTemplate.proxy
+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; [CustomTemplate](./brick-types.customtemplate.md) &gt; [proxy](./brick-types.customtemplate.proxy.md)
+
+## CustomTemplate.proxy property
+
+自定义模板的代理配置。
+
+**Signature:**
+
+```typescript
+proxy?: CustomTemplateProxy;
+```
+
+**Reference:** [CustomTemplateProxy](./brick-types.customtemplateproxy.md)
+

package/dist/brick-types.customtemplate.state.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.customtemplate.state
+title: CustomTemplate.state
+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; [CustomTemplate](./brick-types.customtemplate.md) &gt; [state](./brick-types.customtemplate.state.md)
+
+## CustomTemplate.state property
+
+状态数据配置列表。
+
+**Signature:**
+
+```typescript
+state?: CustomTemplateState[];
+```
+
+**Reference:** [CustomTemplateState](./brick-types.customtemplatestate.md)
+

package/dist/brick-types.customtemplateconstructor.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.customtemplateconstructor
+title: CustomTemplateConstructor
+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; [CustomTemplateConstructor](./brick-types.customtemplateconstructor.md)
+
+## CustomTemplateConstructor interface
+
+自定义模板构造声明。
+
+**Signature:**
+
+```typescript
+export declare type CustomTemplateConstructor = Omit<CustomTemplate, "name">;
+```
+
+**Reference:** [CustomTemplate](./brick-types.customtemplate.md)
+

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

@@ -0,0 +1,27 @@
+---
+id: brick-types.customtemplateproxy.events
+title: CustomTemplateProxy.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; [CustomTemplateProxy](./brick-types.customtemplateproxy.md) &gt; [events](./brick-types.customtemplateproxy.events.md)
+
+## CustomTemplateProxy.events property
+
+自定义模板的事件代理配置表。
+
+**Signature:**
+
+```typescript
+events?: CustomTemplateProxyEvents;
+```
+
+**Reference:** [CustomTemplateProxyEvents](./brick-types.customtemplateproxyevents.md)
+
+## Remarks
+
+配置表中的键为自定义模板对外的事件类型名，值为代理配置。
+

package/dist/brick-types.customtemplateproxy.md

@@ -0,0 +1,30 @@
+---
+id: brick-types.customtemplateproxy
+title: CustomTemplateProxy
+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; [CustomTemplateProxy](./brick-types.customtemplateproxy.md)
+
+## CustomTemplateProxy interface
+
+自定义模板的代理配置。
+
+**Signature:**
+
+```typescript
+export interface CustomTemplateProxy
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [events](./brick-types.customtemplateproxy.events.md) | [CustomTemplateProxyEvents](./brick-types.customtemplateproxyevents.md) | 自定义模板的事件代理配置表。 |
+|  [methods](./brick-types.customtemplateproxy.methods.md) | [CustomTemplateProxyMethods](./brick-types.customtemplateproxymethods.md) | 自定义模板的方法代理配置表。 |
+|  [properties](./brick-types.customtemplateproxy.properties.md) | [CustomTemplateProxyProperties](./brick-types.customtemplateproxyproperties.md) | 自定义模板的属性代理配置表。 |
+|  [slots](./brick-types.customtemplateproxy.slots.md) | [CustomTemplateProxySlots](./brick-types.customtemplateproxyslots.md) | 自定义模板的插槽代理配置表。 |
+

package/dist/brick-types.customtemplateproxy.methods.md

@@ -0,0 +1,27 @@
+---
+id: brick-types.customtemplateproxy.methods
+title: CustomTemplateProxy.methods
+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; [CustomTemplateProxy](./brick-types.customtemplateproxy.md) &gt; [methods](./brick-types.customtemplateproxy.methods.md)
+
+## CustomTemplateProxy.methods property
+
+自定义模板的方法代理配置表。
+
+**Signature:**
+
+```typescript
+methods?: CustomTemplateProxyMethods;
+```
+
+**Reference:** [CustomTemplateProxyMethods](./brick-types.customtemplateproxymethods.md)
+
+## Remarks
+
+配置表中的键为自定义模板对外的方法名，值为代理配置。
+

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

@@ -0,0 +1,27 @@
+---
+id: brick-types.customtemplateproxy.properties
+title: CustomTemplateProxy.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; [CustomTemplateProxy](./brick-types.customtemplateproxy.md) &gt; [properties](./brick-types.customtemplateproxy.properties.md)
+
+## CustomTemplateProxy.properties property
+
+自定义模板的属性代理配置表。
+
+**Signature:**
+
+```typescript
+properties?: CustomTemplateProxyProperties;
+```
+
+**Reference:** [CustomTemplateProxyProperties](./brick-types.customtemplateproxyproperties.md)
+
+## Remarks
+
+配置表中的键为自定义模板对外的属性名，值为代理配置。
+

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

@@ -0,0 +1,27 @@
+---
+id: brick-types.customtemplateproxy.slots
+title: CustomTemplateProxy.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; [CustomTemplateProxy](./brick-types.customtemplateproxy.md) &gt; [slots](./brick-types.customtemplateproxy.slots.md)
+
+## CustomTemplateProxy.slots property
+
+自定义模板的插槽代理配置表。
+
+**Signature:**
+
+```typescript
+slots?: CustomTemplateProxySlots;
+```
+
+**Reference:** [CustomTemplateProxySlots](./brick-types.customtemplateproxyslots.md)
+
+## Remarks
+
+配置表中的键为自定义模板对外的插槽名，值为代理配置。
+

package/dist/brick-types.customtemplateproxybasicproperty.md

@@ -0,0 +1,29 @@
+---
+id: brick-types.customtemplateproxybasicproperty
+title: CustomTemplateProxyBasicProperty
+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; [CustomTemplateProxyBasicProperty](./brick-types.customtemplateproxybasicproperty.md)
+
+## CustomTemplateProxyBasicProperty interface
+
+自定义模板的基本属性代理配置。
+
+**Signature:**
+
+```typescript
+export interface CustomTemplateProxyBasicProperty extends CustomTemplateProxyWithExtra
+```
+
+**Extends:** [CustomTemplateProxyWithExtra](./brick-types.customtemplateproxywithextra.md)
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [refProperty](./brick-types.customtemplateproxybasicproperty.refproperty.md) | string | 要代理的构件的属性名。 |
+