@next-core/next-docs 1.2.555 → 1.2.556

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

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

package/dist/brick-types.brickeventsmap.md

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

package/dist/brick-types.bricklifecycle.md

@@ -0,0 +1,56 @@
+---
+id: brick-types.bricklifecycle
+title: BrickLifeCycle
+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; [BrickLifeCycle](./brick-types.bricklifecycle.md)
+
+## BrickLifeCycle interface
+
+构件生命周期配置。
+
+**Signature:**
+
+```typescript
+export interface BrickLifeCycle
+```
+
+## Remarks
+
+构件在自身渲染和页面渲染的各个时刻可以执行相关的动作。
+
+其生命周期包含的阶段及其顺序如下：
+
+当页面进入时：
+
+1. `useResolves`
+
+2. `onBeforePageLoad`
+
+3. `onPageLoad`
+
+4. `onAnchorLoad` or `onAnchorUnload`
+
+当页面离开时：
+
+1. `onBeforePageLeave`
+
+2. `onPageLeave`
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [onAnchorLoad](./brick-types.bricklifecycle.onanchorload.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 定义构件在页面渲染完成后，当页面 URL 中包含非空的 anchor（URL hash 去掉前缀 \#）时，需要处理的动作。 |
+|  [onAnchorUnload](./brick-types.bricklifecycle.onanchorunload.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 定义构件在页面渲染完成后，当页面 URL 中不包含非空的 anchor（URL hash 去掉前缀 \#）时，需要处理的动作。 |
+|  [onBeforePageLeave](./brick-types.bricklifecycle.onbeforepageleave.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 定义构件在页面离开前要执行的动作。 |
+|  [onBeforePageLoad](./brick-types.bricklifecycle.onbeforepageload.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 定义构件在页面加载前要执行的动作。 |
+|  [onMediaChange](./brick-types.bricklifecycle.onmediachange.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 定义构件在页面渲染完成后，当求值占位符的 MEDIA 全局对象改变时，需要处理的动作。 |
+|  [onPageLoad](./brick-types.bricklifecycle.onpageload.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 定义构件在页面加载完成后的动作。 |
+|  [onScrollIntoView](./brick-types.bricklifecycle.onscrollintoview.md) | [ScrollIntoViewConf](./brick-types.scrollintoviewconf.md) | 定义构件与窗口视图交集大小超过阈值（threshold）规定的大小时候执行的动作 |
+|  [useResolves](./brick-types.bricklifecycle.useresolves.md) | [ResolveConf](./brick-types.resolveconf.md)<!-- -->\[\] | 定义在构件装载前需要进行的异步数据处理，计算结果将作为属性表赋值给构件。 |
+

package/dist/brick-types.bricklifecycle.onanchorload.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.bricklifecycle.onanchorload
+title: BrickLifeCycle.onAnchorLoad
+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; [BrickLifeCycle](./brick-types.bricklifecycle.md) &gt; [onAnchorLoad](./brick-types.bricklifecycle.onanchorload.md)
+
+## BrickLifeCycle.onAnchorLoad property
+
+定义构件在页面渲染完成后，当页面 URL 中包含非空的 anchor（URL hash 去掉前缀 \#）时，需要处理的动作。
+
+**Signature:**
+
+```typescript
+onAnchorLoad?: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

package/dist/brick-types.bricklifecycle.onanchorunload.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.bricklifecycle.onanchorunload
+title: BrickLifeCycle.onAnchorUnload
+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; [BrickLifeCycle](./brick-types.bricklifecycle.md) &gt; [onAnchorUnload](./brick-types.bricklifecycle.onanchorunload.md)
+
+## BrickLifeCycle.onAnchorUnload property
+
+定义构件在页面渲染完成后，当页面 URL 中不包含非空的 anchor（URL hash 去掉前缀 \#）时，需要处理的动作。
+
+**Signature:**
+
+```typescript
+onAnchorUnload?: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

package/dist/brick-types.bricklifecycle.onbeforepageleave.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.bricklifecycle.onbeforepageleave
+title: BrickLifeCycle.onBeforePageLeave
+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; [BrickLifeCycle](./brick-types.bricklifecycle.md) &gt; [onBeforePageLeave](./brick-types.bricklifecycle.onbeforepageleave.md)
+
+## BrickLifeCycle.onBeforePageLeave property
+
+定义构件在页面离开前要执行的动作。
+
+**Signature:**
+
+```typescript
+onBeforePageLeave?: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

package/dist/brick-types.bricklifecycle.onbeforepageload.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.bricklifecycle.onbeforepageload
+title: BrickLifeCycle.onBeforePageLoad
+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; [BrickLifeCycle](./brick-types.bricklifecycle.md) &gt; [onBeforePageLoad](./brick-types.bricklifecycle.onbeforepageload.md)
+
+## BrickLifeCycle.onBeforePageLoad property
+
+定义构件在页面加载前要执行的动作。
+
+**Signature:**
+
+```typescript
+onBeforePageLoad?: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

package/dist/brick-types.bricklifecycle.onmediachange.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.bricklifecycle.onmediachange
+title: BrickLifeCycle.onMediaChange
+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; [BrickLifeCycle](./brick-types.bricklifecycle.md) &gt; [onMediaChange](./brick-types.bricklifecycle.onmediachange.md)
+
+## BrickLifeCycle.onMediaChange property
+
+定义构件在页面渲染完成后，当求值占位符的 MEDIA 全局对象改变时，需要处理的动作。
+
+**Signature:**
+
+```typescript
+onMediaChange?: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

package/dist/brick-types.bricklifecycle.onpageload.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.bricklifecycle.onpageload
+title: BrickLifeCycle.onPageLoad
+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; [BrickLifeCycle](./brick-types.bricklifecycle.md) &gt; [onPageLoad](./brick-types.bricklifecycle.onpageload.md)
+
+## BrickLifeCycle.onPageLoad property
+
+定义构件在页面加载完成后的动作。
+
+**Signature:**
+
+```typescript
+onPageLoad?: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

package/dist/brick-types.bricklifecycle.onscrollintoview.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.bricklifecycle.onscrollintoview
+title: BrickLifeCycle.onScrollIntoView
+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; [BrickLifeCycle](./brick-types.bricklifecycle.md) &gt; [onScrollIntoView](./brick-types.bricklifecycle.onscrollintoview.md)
+
+## BrickLifeCycle.onScrollIntoView property
+
+定义构件与窗口视图交集大小超过阈值（threshold）规定的大小时候执行的动作
+
+**Signature:**
+
+```typescript
+onScrollIntoView?: ScrollIntoViewConf;
+```
+
+**Reference:** [ScrollIntoViewConf](./brick-types.scrollintoviewconf.md)
+

package/dist/brick-types.bricklifecycle.useresolves.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.bricklifecycle.useresolves
+title: BrickLifeCycle.useResolves
+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; [BrickLifeCycle](./brick-types.bricklifecycle.md) &gt; [useResolves](./brick-types.bricklifecycle.useresolves.md)
+
+## BrickLifeCycle.useResolves property
+
+定义在构件装载前需要进行的异步数据处理，计算结果将作为属性表赋值给构件。
+
+**Signature:**
+
+```typescript
+useResolves?: ResolveConf[];
+```
+
+**Reference:** [ResolveConf](./brick-types.resolveconf.md)
+

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

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

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

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

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

@@ -0,0 +1,45 @@
+---
+id: brick-types.brickmenuconf.lifecycle
+title: BrickMenuConf.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; [BrickMenuConf](./brick-types.brickmenuconf.md) &gt; [lifeCycle](./brick-types.brickmenuconf.lifecycle.md)
+
+## BrickMenuConf.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.brickmenuconf.md

@@ -0,0 +1,31 @@
+---
+id: brick-types.brickmenuconf
+title: BrickMenuConf
+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; [BrickMenuConf](./brick-types.brickmenuconf.md)
+
+## BrickMenuConf interface
+
+使用构件做数据代理的菜单配置。
+
+**Signature:**
+
+```typescript
+export interface BrickMenuConf
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [brick](./brick-types.brickmenuconf.brick.md) | string | 构件名。 |
+|  [events](./brick-types.brickmenuconf.events.md) | [BrickEventsMap](./brick-types.brickeventsmap.md) | 构件的事件配置表。 |
+|  [lifeCycle](./brick-types.brickmenuconf.lifecycle.md) | [BrickLifeCycle](./brick-types.bricklifecycle.md) | 构件生命周期配置。 |
+|  [properties](./brick-types.brickmenuconf.properties.md) | Record&lt;string, unknown&gt; | 构件属性。 |
+|  [type](./brick-types.brickmenuconf.type.md) | "brick" |  |
+

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

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

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

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

package/dist/brick-types.builtinbrickeventhandler.action.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.builtinbrickeventhandler.action
+title: BuiltinBrickEventHandler.action
+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; [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md) &gt; [action](./brick-types.builtinbrickeventhandler.action.md)
+
+## BuiltinBrickEventHandler.action property
+
+处理动作名。
+
+**Signature:**
+
+```typescript
+action: "history.push" | "history.replace" | "history.goBack" | "history.goForward" | "history.reload" | "history.pushQuery" | "history.replaceQuery" | "history.pushAnchor" | "history.block" | "history.unblock" | "segue.push" | "segue.replace" | "alias.push" | "alias.replace" | "localStorage.setItem" | "localStorage.removeItem" | "sessionStorage.setItem" | "sessionStorage.removeItem" | "legacy.go" | "location.reload" | "location.assign" | "window.open" | "window.close" | "event.preventDefault" | "event.stopPropagation" | "console.log" | "console.error" | "console.warn" | "console.info" | "message.success" | "message.error" | "message.info" | "message.warn" | "handleHttpError" | "context.assign" | "context.replace" | "context.refresh" | "context.load" | "state.update" | "state.refresh" | "state.load" | "tpl.dispatchEvent" | "message.subscribe" | "message.unsubscribe" | "theme.setDarkTheme" | "theme.setLightTheme" | "theme.setTheme" | "mode.setDashboardMode" | "mode.setDefaultMode" | "menu.clearMenuTitleCache" | "menu.clearMenuCache" | "preview.debug" | "analytics.event" | "formstate.update";
+```
+

package/dist/brick-types.builtinbrickeventhandler.args.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.builtinbrickeventhandler.args
+title: BuiltinBrickEventHandler.args
+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; [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md) &gt; [args](./brick-types.builtinbrickeventhandler.args.md)
+
+## BuiltinBrickEventHandler.args property
+
+传递的参数列表
+
+**Signature:**
+
+```typescript
+args?: unknown[];
+```
+

package/dist/brick-types.builtinbrickeventhandler.batch.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.builtinbrickeventhandler.batch
+title: BuiltinBrickEventHandler.batch
+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; [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md) &gt; [batch](./brick-types.builtinbrickeventhandler.batch.md)
+
+## BuiltinBrickEventHandler.batch property
+
+是否批量变更
+
+**Signature:**
+
+```typescript
+batch?: boolean;
+```
+

package/dist/brick-types.builtinbrickeventhandler.callback.md

@@ -0,0 +1,27 @@
+---
+id: brick-types.builtinbrickeventhandler.callback
+title: BuiltinBrickEventHandler.callback
+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; [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md) &gt; [callback](./brick-types.builtinbrickeventhandler.callback.md)
+
+## BuiltinBrickEventHandler.callback property
+
+事件处理回调。
+
+**Signature:**
+
+```typescript
+callback?: BrickEventHandlerCallback;
+```
+
+**Reference:** [BrickEventHandlerCallback](./brick-types.brickeventhandlercallback.md)
+
+## Remarks
+
+事件处理过程将当做异步函数看待，当成功、失败时分别执行 `success` 和 `error` 动作， 无论成功与否，最终再执行 `finally` 动作。
+

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

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

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

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

package/dist/brick-types.builtinbrickeventhandler.md

@@ -0,0 +1,32 @@
+---
+id: brick-types.builtinbrickeventhandler
+title: BuiltinBrickEventHandler
+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; [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md)
+
+## BuiltinBrickEventHandler interface
+
+系统内置的事件处理器。
+
+**Signature:**
+
+```typescript
+export interface BuiltinBrickEventHandler
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [action](./brick-types.builtinbrickeventhandler.action.md) | "history.push" \| "history.replace" \| "history.goBack" \| "history.goForward" \| "history.reload" \| "history.pushQuery" \| "history.replaceQuery" \| "history.pushAnchor" \| "history.block" \| "history.unblock" \| "segue.push" \| "segue.replace" \| "alias.push" \| "alias.replace" \| "localStorage.setItem" \| "localStorage.removeItem" \| "sessionStorage.setItem" \| "sessionStorage.removeItem" \| "legacy.go" \| "location.reload" \| "location.assign" \| "window.open" \| "window.close" \| "event.preventDefault" \| "event.stopPropagation" \| "console.log" \| "console.error" \| "console.warn" \| "console.info" \| "message.success" \| "message.error" \| "message.info" \| "message.warn" \| "handleHttpError" \| "context.assign" \| "context.replace" \| "context.refresh" \| "context.load" \| "state.update" \| "state.refresh" \| "state.load" \| "tpl.dispatchEvent" \| "message.subscribe" \| "message.unsubscribe" \| "theme.setDarkTheme" \| "theme.setLightTheme" \| "theme.setTheme" \| "mode.setDashboardMode" \| "mode.setDefaultMode" \| "menu.clearMenuTitleCache" \| "menu.clearMenuCache" \| "preview.debug" \| "analytics.event" \| "formstate.update" | 处理动作名。 |
+|  [args](./brick-types.builtinbrickeventhandler.args.md) | unknown\[\] | 传递的参数列表 |
+|  [batch](./brick-types.builtinbrickeventhandler.batch.md) | boolean | 是否批量变更 |
+|  [callback](./brick-types.builtinbrickeventhandler.callback.md) | [BrickEventHandlerCallback](./brick-types.brickeventhandlercallback.md) | 事件处理回调。 |
+|  [else](./brick-types.builtinbrickeventhandler.else.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 不满足条件分支 |
+|  [if](./brick-types.builtinbrickeventhandler.if.md) | string \| boolean | 根据条件决定是否执行该动作。 |
+