@next-core/next-docs 1.2.548 → 1.2.550

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

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

package/dist/brick-types.useprovidereventhandler.md

@@ -1,33 +0,0 @@
----
-id: brick-types.useprovidereventhandler
-title: UseProviderEventHandler
-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; [UseProviderEventHandler](./brick-types.useprovidereventhandler.md)
-
-## UseProviderEventHandler interface
-
-使用 Provider 构件进行事件处理的配置。
-
-**Signature:**
-
-```typescript
-export interface UseProviderEventHandler
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [args](./brick-types.useprovidereventhandler.args.md) | unknown\[\] | 传递的参数列表 |
-|  [callback](./brick-types.useprovidereventhandler.callback.md) | [BrickEventHandlerCallback](./brick-types.brickeventhandlercallback.md) | 事件处理回调。 |
-|  [else](./brick-types.useprovidereventhandler.else.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 不满足条件分支 |
-|  [if](./brick-types.useprovidereventhandler.if.md) | string \| boolean | 根据条件决定是否执行该动作。 |
-|  [method](./brick-types.useprovidereventhandler.method.md) | "resolve" \| "saveAs" |  |
-|  [poll](./brick-types.useprovidereventhandler.poll.md) | [ProviderPollOptions](./brick-types.providerpolloptions.md) | 使用 Provider 进行轮询时的选项配置。 |
-|  [useProvider](./brick-types.useprovidereventhandler.useprovider.md) | string | 指定要使用的构件名。 |
-

package/dist/brick-types.useprovidereventhandler.method.md

@@ -1,19 +0,0 @@
----
-id: brick-types.useprovidereventhandler.method
-title: UseProviderEventHandler.method
-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; [UseProviderEventHandler](./brick-types.useprovidereventhandler.md) &gt; [method](./brick-types.useprovidereventhandler.method.md)
-
-## UseProviderEventHandler.method property
-
-**Signature:**
-
-```typescript
-method?: "resolve" | "saveAs";
-```
-

package/dist/brick-types.useprovidereventhandler.poll.md

@@ -1,23 +0,0 @@
----
-id: brick-types.useprovidereventhandler.poll
-title: UseProviderEventHandler.poll
-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; [UseProviderEventHandler](./brick-types.useprovidereventhandler.md) &gt; [poll](./brick-types.useprovidereventhandler.poll.md)
-
-## UseProviderEventHandler.poll property
-
-使用 Provider 进行轮询时的选项配置。
-
-**Signature:**
-
-```typescript
-poll?: ProviderPollOptions;
-```
-
-**Reference:** [ProviderPollOptions](./brick-types.providerpolloptions.md)
-

package/dist/brick-types.useprovidereventhandler.useprovider.md

@@ -1,21 +0,0 @@
----
-id: brick-types.useprovidereventhandler.useprovider
-title: UseProviderEventHandler.useProvider
-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; [UseProviderEventHandler](./brick-types.useprovidereventhandler.md) &gt; [useProvider](./brick-types.useprovidereventhandler.useprovider.md)
-
-## UseProviderEventHandler.useProvider property
-
-指定要使用的构件名。
-
-**Signature:**
-
-```typescript
-useProvider: string;
-```
-

package/dist/brick-types.useproviderresolveconf.md

@@ -1,29 +0,0 @@
----
-id: brick-types.useproviderresolveconf
-title: UseProviderResolveConf
-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; [UseProviderResolveConf](./brick-types.useproviderresolveconf.md)
-
-## UseProviderResolveConf interface
-
-使用 `useProvider` 的异步数据处理配置。
-
-**Signature:**
-
-```typescript
-export interface UseProviderResolveConf extends BaseEntityResolveConf
-```
-
-**Extends:** [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md)
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [useProvider](./brick-types.useproviderresolveconf.useprovider.md) | string | 指定要使用的构件名。 |
-

package/dist/brick-types.useproviderresolveconf.useprovider.md

@@ -1,21 +0,0 @@
----
-id: brick-types.useproviderresolveconf.useprovider
-title: UseProviderResolveConf.useProvider
-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; [UseProviderResolveConf](./brick-types.useproviderresolveconf.md) &gt; [useProvider](./brick-types.useproviderresolveconf.useprovider.md)
-
-## UseProviderResolveConf.useProvider property
-
-指定要使用的构件名。
-
-**Signature:**
-
-```typescript
-useProvider: string;
-```
-

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

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

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

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

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

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

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

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

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

@@ -1,26 +0,0 @@
----
-id: brick-types.usesinglebrickconf.lifecycle
-title: UseSingleBrickConf.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; [UseSingleBrickConf](./brick-types.usesinglebrickconf.md) &gt; [lifeCycle](./brick-types.usesinglebrickconf.lifecycle.md)
-
-## UseSingleBrickConf.lifeCycle property
-
-构件生命周期配置。在 `useBrick` 中仅支持 `useResolves`<!-- -->、`onMount` 和 `onUnmount`<!-- -->。
-
-**Signature:**
-
-```typescript
-lifeCycle?: Pick<BrickLifeCycle, "useResolves"> & {
-        onMount?: BrickEventHandler | BrickEventHandler[];
-        onUnmount?: BrickEventHandler | BrickEventHandler[];
-    };
-```
-
-**Reference:** [BrickLifeCycle](./brick-types.bricklifecycle.md)<!-- -->, [BrickEventHandler](./brick-types.brickeventhandler.md)
-

package/dist/brick-types.usesinglebrickconf.md

@@ -1,36 +0,0 @@
----
-id: brick-types.usesinglebrickconf
-title: UseSingleBrickConf
-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; [UseSingleBrickConf](./brick-types.usesinglebrickconf.md)
-
-## UseSingleBrickConf interface
-
-使用 `useBrick` 自行渲染子构件的配置（单个）。
-
-**Signature:**
-
-```typescript
-export interface UseSingleBrickConf
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [brick](./brick-types.usesinglebrickconf.brick.md) | string | 构件名。 |
-|  [events](./brick-types.usesinglebrickconf.events.md) | [BrickEventsMap](./brick-types.brickeventsmap.md) | 构件的事件配置表。 |
-|  [if](./brick-types.usesinglebrickconf.if.md) | string \| boolean \| [ResolveConf](./brick-types.resolveconf.md) | 条件渲染配置，根据 <code>if</code> 的计算结果来决定是否渲染该构件。 |
-|  [iid](./brick-types.usesinglebrickconf.iid.md) | string | 构件编排 ID |
-|  [lifeCycle](./brick-types.usesinglebrickconf.lifecycle.md) | Pick&lt;[BrickLifeCycle](./brick-types.bricklifecycle.md)<!-- -->, "useResolves"&gt; &amp; { onMount?: [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\]; onUnmount?: [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\]; } | 构件生命周期配置。在 <code>useBrick</code> 中仅支持 <code>useResolves</code>、<code>onMount</code> 和 <code>onUnmount</code>。 |
-|  [properties](./brick-types.usesinglebrickconf.properties.md) | Record&lt;string, unknown&gt; | 构件属性。 |
-|  [ref](./brick-types.usesinglebrickconf.ref.md) | string | 用于在自定义模板内部引用的 ID。 |
-|  [slots](./brick-types.usesinglebrickconf.slots.md) | [UseBrickSlotsConf](./brick-types.usebrickslotsconf.md) | 在 <code>useBrick</code> 中使用的插槽配置表。 |
-|  [transform](./brick-types.usesinglebrickconf.transform.md) | [GeneralTransform](./brick-types.generaltransform.md) | 数据转换配置。 |
-|  [transformFrom](./brick-types.usesinglebrickconf.transformfrom.md) | string \| string\[\] | 使用返回数据的指定字段作为数据源。 |
-

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

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

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

@@ -1,21 +0,0 @@
----
-id: brick-types.usesinglebrickconf.ref
-title: UseSingleBrickConf.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; [UseSingleBrickConf](./brick-types.usesinglebrickconf.md) &gt; [ref](./brick-types.usesinglebrickconf.ref.md)
-
-## UseSingleBrickConf.ref property
-
-用于在自定义模板内部引用的 ID。
-
-**Signature:**
-
-```typescript
-ref?: string;
-```
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.usesinglebrickconf.slots
-title: UseSingleBrickConf.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; [UseSingleBrickConf](./brick-types.usesinglebrickconf.md) &gt; [slots](./brick-types.usesinglebrickconf.slots.md)
-
-## UseSingleBrickConf.slots property
-
-在 `useBrick` 中使用的插槽配置表。
-
-**Signature:**
-
-```typescript
-slots?: UseBrickSlotsConf;
-```
-
-**Reference:** [UseBrickSlotsConf](./brick-types.usebrickslotsconf.md)
-

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

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

package/dist/brick-types.usesinglebrickconf.transformfrom.md

@@ -1,21 +0,0 @@
----
-id: brick-types.usesinglebrickconf.transformfrom
-title: UseSingleBrickConf.transformFrom
-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; [UseSingleBrickConf](./brick-types.usesinglebrickconf.md) &gt; [transformFrom](./brick-types.usesinglebrickconf.transformfrom.md)
-
-## UseSingleBrickConf.transformFrom property
-
-使用返回数据的指定字段作为数据源。
-
-**Signature:**
-
-```typescript
-transformFrom?: string | string[];
-```
-