@next-core/next-docs 1.2.570 → 1.2.572

package/dist/brick-types.snippetcontext.declareparams.md

@@ -1,21 +0,0 @@
----
-id: brick-types.snippetcontext.declareparams
-title: SnippetContext.declareParams
-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; [SnippetContext](./brick-types.snippetcontext.md) &gt; [declareParams](./brick-types.snippetcontext.declareparams.md)
-
-## SnippetContext.declareParams property
-
-**Signature:**
-
-```typescript
-declareParams?: SnippetDeclareParams;
-```
-
-**Reference:** [SnippetDeclareParams](./brick-types.snippetdeclareparams.md)
-

package/dist/brick-types.snippetcontext.inputparams.md

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

package/dist/brick-types.snippetcontext.md

@@ -1,27 +0,0 @@
----
-id: brick-types.snippetcontext
-title: SnippetContext
-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; [SnippetContext](./brick-types.snippetcontext.md)
-
-## SnippetContext interface
-
-**Signature:**
-
-```typescript
-export interface SnippetContext
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [declareParams](./brick-types.snippetcontext.declareparams.md) | [SnippetDeclareParams](./brick-types.snippetdeclareparams.md) |  |
-|  [inputParams](./brick-types.snippetcontext.inputparams.md) | Record&lt;string, unknown&gt; |  |
-|  [rootType](./brick-types.snippetcontext.roottype.md) | string |  |
-

package/dist/brick-types.snippetcontext.roottype.md

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

package/dist/brick-types.snippetdeclareparams.md

@@ -1,19 +0,0 @@
----
-id: brick-types.snippetdeclareparams
-title: SnippetDeclareParams
-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; [SnippetDeclareParams](./brick-types.snippetdeclareparams.md)
-
-## SnippetDeclareParams interface
-
-**Signature:**
-
-```typescript
-export declare type SnippetDeclareParams = Record<string, SnippetParamField>;
-```
-

package/dist/brick-types.staticmenuconf.md

@@ -1,29 +0,0 @@
----
-id: brick-types.staticmenuconf
-title: StaticMenuConf
-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; [StaticMenuConf](./brick-types.staticmenuconf.md)
-
-## StaticMenuConf interface
-
-静态菜单配置。
-
-**Signature:**
-
-```typescript
-export interface StaticMenuConf extends StaticMenuProps
-```
-
-**Extends:** [StaticMenuProps](./brick-types.staticmenuprops.md)
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [type](./brick-types.staticmenuconf.type.md) | "static" |  |
-

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

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

package/dist/brick-types.staticmenuprops.breadcrumb.md

@@ -1,31 +0,0 @@
----
-id: brick-types.staticmenuprops.breadcrumb
-title: StaticMenuProps.breadcrumb
-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; [StaticMenuProps](./brick-types.staticmenuprops.md) &gt; [breadcrumb](./brick-types.staticmenuprops.breadcrumb.md)
-
-## StaticMenuProps.breadcrumb property
-
-面包屑配置。
-
-**Signature:**
-
-```typescript
-breadcrumb?: BreadcrumbConf;
-```
-
-**Reference:** [BreadcrumbConf](./brick-types.breadcrumbconf.md)
-
-## Remarks
-
-每一层路由都可以按需配置零个、一个或多个面包屑，系统将组合这些面包屑显示在页面顶栏中。
-
-通过 `overwrite` 指定是否覆盖上层路由已有的面包屑列表（默认为追加模式）。
-
-注意系统将始终在面包屑起始位置显示当前应用的名字。
-

package/dist/brick-types.staticmenuprops.md

@@ -1,31 +0,0 @@
----
-id: brick-types.staticmenuprops
-title: StaticMenuProps
-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; [StaticMenuProps](./brick-types.staticmenuprops.md)
-
-## StaticMenuProps interface
-
-静态菜单配置信息。
-
-**Signature:**
-
-```typescript
-export interface StaticMenuProps
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [breadcrumb](./brick-types.staticmenuprops.breadcrumb.md) | [BreadcrumbConf](./brick-types.breadcrumbconf.md) | 面包屑配置。 |
-|  [menuId](./brick-types.staticmenuprops.menuid.md) | string | 引用的菜单 ID。 |
-|  [pageTitle](./brick-types.staticmenuprops.pagetitle.md) | string | 页面标题（显示在浏览器标签栏）。 |
-|  [sidebarMenu](./brick-types.staticmenuprops.sidebarmenu.md) | [SidebarMenu](./brick-types.sidebarmenu.md) | 侧边栏菜单配置。 |
-|  [subMenuId](./brick-types.staticmenuprops.submenuid.md) | string | 引用的二级菜单 ID。 |
-

package/dist/brick-types.staticmenuprops.menuid.md

@@ -1,21 +0,0 @@
----
-id: brick-types.staticmenuprops.menuid
-title: StaticMenuProps.menuId
-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; [StaticMenuProps](./brick-types.staticmenuprops.md) &gt; [menuId](./brick-types.staticmenuprops.menuid.md)
-
-## StaticMenuProps.menuId property
-
-引用的菜单 ID。
-
-**Signature:**
-
-```typescript
-menuId?: string;
-```
-

package/dist/brick-types.staticmenuprops.pagetitle.md

@@ -1,21 +0,0 @@
----
-id: brick-types.staticmenuprops.pagetitle
-title: StaticMenuProps.pageTitle
-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; [StaticMenuProps](./brick-types.staticmenuprops.md) &gt; [pageTitle](./brick-types.staticmenuprops.pagetitle.md)
-
-## StaticMenuProps.pageTitle property
-
-页面标题（显示在浏览器标签栏）。
-
-**Signature:**
-
-```typescript
-pageTitle?: string;
-```
-

package/dist/brick-types.staticmenuprops.sidebarmenu.md

@@ -1,23 +0,0 @@
----
-id: brick-types.staticmenuprops.sidebarmenu
-title: StaticMenuProps.sidebarMenu
-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; [StaticMenuProps](./brick-types.staticmenuprops.md) &gt; [sidebarMenu](./brick-types.staticmenuprops.sidebarmenu.md)
-
-## StaticMenuProps.sidebarMenu property
-
-侧边栏菜单配置。
-
-**Signature:**
-
-```typescript
-sidebarMenu?: SidebarMenu;
-```
-
-**Reference:** [SidebarMenu](./brick-types.sidebarmenu.md)
-

package/dist/brick-types.staticmenuprops.submenuid.md

@@ -1,21 +0,0 @@
----
-id: brick-types.staticmenuprops.submenuid
-title: StaticMenuProps.subMenuId
-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; [StaticMenuProps](./brick-types.staticmenuprops.md) &gt; [subMenuId](./brick-types.staticmenuprops.submenuid.md)
-
-## StaticMenuProps.subMenuId property
-
-引用的二级菜单 ID。
-
-**Signature:**
-
-```typescript
-subMenuId?: string;
-```
-

package/dist/brick-types.storyboard.app.md

@@ -1,23 +0,0 @@
----
-id: brick-types.storyboard.app
-title: Storyboard.app
-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; [Storyboard](./brick-types.storyboard.md) &gt; [app](./brick-types.storyboard.app.md)
-
-## Storyboard.app property
-
-微应用基本信息。
-
-**Signature:**
-
-```typescript
-app: MicroApp;
-```
-
-**Reference:** [MicroApp](./brick-types.microapp.md)
-

package/dist/brick-types.storyboard.bootstrapfile.md

@@ -1,21 +0,0 @@
----
-id: brick-types.storyboard.bootstrapfile
-title: Storyboard.bootstrapFile
-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; [Storyboard](./brick-types.storyboard.md) &gt; [bootstrapFile](./brick-types.storyboard.bootstrapfile.md)
-
-## Storyboard.bootstrapFile property
-
-该 app 请求 bootstrap json 的地址，仅针对是联合 app 时才有该字段
-
-**Signature:**
-
-```typescript
-bootstrapFile?: string;
-```
-

package/dist/brick-types.storyboard.md

@@ -1,30 +0,0 @@
----
-id: brick-types.storyboard
-title: Storyboard
-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; [Storyboard](./brick-types.storyboard.md)
-
-## Storyboard interface
-
-应用的 Storyboard 配置。
-
-**Signature:**
-
-```typescript
-export interface Storyboard
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [app](./brick-types.storyboard.app.md) | [MicroApp](./brick-types.microapp.md) | 微应用基本信息。 |
-|  [bootstrapFile](./brick-types.storyboard.bootstrapfile.md) | string | 该 app 请求 bootstrap json 的地址，仅针对是联合 app 时才有该字段 |
-|  [meta](./brick-types.storyboard.meta.md) | [StoryboardMeta](./brick-types.storyboardmeta.md) | 应用的 Storyboard 元信息（包括自定义模板和国际化配置）。 |
-|  [routes](./brick-types.storyboard.routes.md) | [RouteConf](./brick-types.routeconf.md)<!-- -->\[\] | 路由配置列表。 |
-

package/dist/brick-types.storyboard.meta.md

@@ -1,23 +0,0 @@
----
-id: brick-types.storyboard.meta
-title: Storyboard.meta
-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; [Storyboard](./brick-types.storyboard.md) &gt; [meta](./brick-types.storyboard.meta.md)
-
-## Storyboard.meta property
-
-应用的 Storyboard 元信息（包括自定义模板和国际化配置）。
-
-**Signature:**
-
-```typescript
-meta?: StoryboardMeta;
-```
-
-**Reference:** [StoryboardMeta](./brick-types.storyboardmeta.md)
-

package/dist/brick-types.storyboard.routes.md

@@ -1,23 +0,0 @@
----
-id: brick-types.storyboard.routes
-title: Storyboard.routes
-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; [Storyboard](./brick-types.storyboard.md) &gt; [routes](./brick-types.storyboard.routes.md)
-
-## Storyboard.routes property
-
-路由配置列表。
-
-**Signature:**
-
-```typescript
-routes?: RouteConf[];
-```
-
-**Reference:** [RouteConf](./brick-types.routeconf.md)
-

package/dist/brick-types.storyboardfunction.md

@@ -1,30 +0,0 @@
----
-id: brick-types.storyboardfunction
-title: StoryboardFunction
-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; [StoryboardFunction](./brick-types.storyboardfunction.md)
-
-## StoryboardFunction interface
-
-应用定义的函数。
-
-**Signature:**
-
-```typescript
-export interface StoryboardFunction
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name](./brick-types.storyboardfunction.name.md) | string | 函数名称。 |
-|  [source](./brick-types.storyboardfunction.source.md) | string | 函数源码。 |
-|  [transformed](./brick-types.storyboardfunction.transformed.md) | [TransformedFunction](./brick-types.transformedfunction.md) | \[Compiled\] 编译后的函数<!-- -->在函数内先声明 "native mode"，打包时会将函数转换为原生 JS 代码，以提高执行性能。 |
-|  [typescript](./brick-types.storyboardfunction.typescript.md) | boolean | 是否使用 TypeScript。 |
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.storyboardfunction.name
-title: StoryboardFunction.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; [StoryboardFunction](./brick-types.storyboardfunction.md) &gt; [name](./brick-types.storyboardfunction.name.md)
-
-## StoryboardFunction.name property
-
-函数名称。
-
-**Signature:**
-
-```typescript
-name: string;
-```
-

package/dist/brick-types.storyboardfunction.source.md

@@ -1,21 +0,0 @@
----
-id: brick-types.storyboardfunction.source
-title: StoryboardFunction.source
-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; [StoryboardFunction](./brick-types.storyboardfunction.md) &gt; [source](./brick-types.storyboardfunction.source.md)
-
-## StoryboardFunction.source property
-
-函数源码。
-
-**Signature:**
-
-```typescript
-source: string;
-```
-

package/dist/brick-types.storyboardfunction.transformed.md

@@ -1,25 +0,0 @@
----
-id: brick-types.storyboardfunction.transformed
-title: StoryboardFunction.transformed
-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; [StoryboardFunction](./brick-types.storyboardfunction.md) &gt; [transformed](./brick-types.storyboardfunction.transformed.md)
-
-## StoryboardFunction.transformed property
-
-\[Compiled\] 编译后的函数
-
-在函数内先声明 "native mode"，打包时会将函数转换为原生 JS 代码，以提高执行性能。
-
-**Signature:**
-
-```typescript
-transformed?: TransformedFunction;
-```
-
-**Reference:** [TransformedFunction](./brick-types.transformedfunction.md)
-

package/dist/brick-types.storyboardfunction.typescript.md

@@ -1,21 +0,0 @@
----
-id: brick-types.storyboardfunction.typescript
-title: StoryboardFunction.typescript
-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; [StoryboardFunction](./brick-types.storyboardfunction.md) &gt; [typescript](./brick-types.storyboardfunction.typescript.md)
-
-## StoryboardFunction.typescript property
-
-是否使用 TypeScript。
-
-**Signature:**
-
-```typescript
-typescript?: boolean;
-```
-

package/dist/brick-types.storyboardmeta.blacklist.md

@@ -1,24 +0,0 @@
----
-id: brick-types.storyboardmeta.blacklist
-title: StoryboardMeta.blackList
-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; [StoryboardMeta](./brick-types.storyboardmeta.md) &gt; [blackList](./brick-types.storyboardmeta.blacklist.md)
-
-## StoryboardMeta.blackList property
-
-Launchpad /应用菜单黑名单 \*
-
-**Signature:**
-
-```typescript
-blackList?: {
-        to?: string;
-        url?: string;
-    }[];
-```
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.storyboardmeta.contracts
-title: StoryboardMeta.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; [StoryboardMeta](./brick-types.storyboardmeta.md) &gt; [contracts](./brick-types.storyboardmeta.contracts.md)
-
-## StoryboardMeta.contracts property
-
-应用所用到的契约 \*
-
-**Signature:**
-
-```typescript
-contracts?: Contract[];
-```
-
-**Reference:** [Contract](./brick-types.contract.md)
-

package/dist/brick-types.storyboardmeta.customtemplates.md

@@ -1,23 +0,0 @@
----
-id: brick-types.storyboardmeta.customtemplates
-title: StoryboardMeta.customTemplates
-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; [StoryboardMeta](./brick-types.storyboardmeta.md) &gt; [customTemplates](./brick-types.storyboardmeta.customtemplates.md)
-
-## StoryboardMeta.customTemplates property
-
-应用定义的自定义模板列表。
-
-**Signature:**
-
-```typescript
-customTemplates?: CustomTemplate[];
-```
-
-**Reference:** [CustomTemplate](./brick-types.customtemplate.md)
-

package/dist/brick-types.storyboardmeta.functions.md

@@ -1,23 +0,0 @@
----
-id: brick-types.storyboardmeta.functions
-title: StoryboardMeta.functions
-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; [StoryboardMeta](./brick-types.storyboardmeta.md) &gt; [functions](./brick-types.storyboardmeta.functions.md)
-
-## StoryboardMeta.functions property
-
-应用定义的函数列表。
-
-**Signature:**
-
-```typescript
-functions?: StoryboardFunction[];
-```
-
-**Reference:** [StoryboardFunction](./brick-types.storyboardfunction.md)
-