@next-core/next-docs 1.2.534 → 1.2.536

package/dist/brick-types.sidebarmenusimpleitem.target.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.sidebarmenusimpleitem.target
+title: SidebarMenuSimpleItem.target
+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; [SidebarMenuSimpleItem](./brick-types.sidebarmenusimpleitem.md) &gt; [target](./brick-types.sidebarmenusimpleitem.target.md)
+
+## SidebarMenuSimpleItem.target property
+
+菜单项链接打开的目标。
+
+**Signature:**
+
+```typescript
+target?: string;
+```
+

package/dist/brick-types.sidebarmenusimpleitem.text.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.sidebarmenusimpleitem.text
+title: SidebarMenuSimpleItem.text
+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; [SidebarMenuSimpleItem](./brick-types.sidebarmenusimpleitem.md) &gt; [text](./brick-types.sidebarmenusimpleitem.text.md)
+
+## SidebarMenuSimpleItem.text property
+
+菜单项文本。
+
+**Signature:**
+
+```typescript
+text: string;
+```
+

package/dist/brick-types.sidebarmenusimpleitem.to.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.sidebarmenusimpleitem.to
+title: SidebarMenuSimpleItem.to
+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; [SidebarMenuSimpleItem](./brick-types.sidebarmenusimpleitem.md) &gt; [to](./brick-types.sidebarmenusimpleitem.to.md)
+
+## SidebarMenuSimpleItem.to property
+
+菜单项对应的系统内地址。
+
+**Signature:**
+
+```typescript
+to?: LocationDescriptor;
+```
+

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

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

package/dist/brick-types.sidebarsubmenu.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.sidebarsubmenu
+title: SidebarSubMenu
+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; [SidebarSubMenu](./brick-types.sidebarsubmenu.md)
+
+## SidebarSubMenu interface
+
+侧边栏二级菜单配置。
+
+**Signature:**
+
+```typescript
+export declare type SidebarSubMenu = Pick<SidebarMenu, "title" | "icon" | "menuItems">;
+```
+
+**Reference:** [SidebarMenu](./brick-types.sidebarmenu.md)
+

package/dist/brick-types.simplefunction.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.simplefunction
+title: SimpleFunction
+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; [SimpleFunction](./brick-types.simplefunction.md)
+
+## SimpleFunction interface
+
+**Signature:**
+
+```typescript
+export declare type SimpleFunction<P extends unknown[] = unknown[], R = unknown> = (...args: P) => R;
+```
+

package/dist/brick-types.sitemode.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.sitemode
+title: SiteMode
+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; [SiteMode](./brick-types.sitemode.md)
+
+## SiteMode interface
+
+站点模式。
+
+**Signature:**
+
+```typescript
+export declare type SiteMode = "default" | "dashboard";
+```
+

package/dist/brick-types.sitetheme.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.sitetheme
+title: SiteTheme
+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; [SiteTheme](./brick-types.sitetheme.md)
+
+## SiteTheme interface
+
+站点主题。
+
+**Signature:**
+
+```typescript
+export declare type SiteTheme = "light" | "dark" | "dark-v2";
+```
+

package/dist/brick-types.slotconf.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.slotconf
+title: SlotConf
+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; [SlotConf](./brick-types.slotconf.md)
+
+## SlotConf interface
+
+插槽配置。
+
+**Signature:**
+
+```typescript
+export declare type SlotConf = SlotConfOfBricks | SlotConfOfRoutes;
+```
+
+**Reference:** [SlotConfOfBricks](./brick-types.slotconfofbricks.md)<!-- -->, [SlotConfOfRoutes](./brick-types.slotconfofroutes.md)
+

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

@@ -0,0 +1,23 @@
+---
+id: brick-types.slotconfintemplate.bricks
+title: SlotConfInTemplate.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; [SlotConfInTemplate](./brick-types.slotconfintemplate.md) &gt; [bricks](./brick-types.slotconfintemplate.bricks.md)
+
+## SlotConfInTemplate.bricks property
+
+在插槽中插入的子构件列表。
+
+**Signature:**
+
+```typescript
+bricks: BrickConfInTemplate[];
+```
+
+**Reference:** [BrickConfInTemplate](./brick-types.brickconfintemplate.md)
+

package/dist/brick-types.slotconfintemplate.md

@@ -0,0 +1,28 @@
+---
+id: brick-types.slotconfintemplate
+title: SlotConfInTemplate
+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; [SlotConfInTemplate](./brick-types.slotconfintemplate.md)
+
+## SlotConfInTemplate interface
+
+自定义模板中的构件的插槽配置。
+
+**Signature:**
+
+```typescript
+export interface SlotConfInTemplate
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [bricks](./brick-types.slotconfintemplate.bricks.md) | [BrickConfInTemplate](./brick-types.brickconfintemplate.md)<!-- -->\[\] | 在插槽中插入的子构件列表。 |
+|  [type](./brick-types.slotconfintemplate.type.md) | "bricks" |  |
+

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

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

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

@@ -0,0 +1,23 @@
+---
+id: brick-types.slotconfofbricks.bricks
+title: SlotConfOfBricks.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; [SlotConfOfBricks](./brick-types.slotconfofbricks.md) &gt; [bricks](./brick-types.slotconfofbricks.bricks.md)
+
+## SlotConfOfBricks.bricks property
+
+在插槽中插入的构件列表。
+
+**Signature:**
+
+```typescript
+bricks: BrickConf[];
+```
+
+**Reference:** [BrickConf](./brick-types.brickconf.md)
+

package/dist/brick-types.slotconfofbricks.md

@@ -0,0 +1,28 @@
+---
+id: brick-types.slotconfofbricks
+title: SlotConfOfBricks
+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; [SlotConfOfBricks](./brick-types.slotconfofbricks.md)
+
+## SlotConfOfBricks interface
+
+使用一组构件的插槽配置。
+
+**Signature:**
+
+```typescript
+export interface SlotConfOfBricks
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [bricks](./brick-types.slotconfofbricks.bricks.md) | [BrickConf](./brick-types.brickconf.md)<!-- -->\[\] | 在插槽中插入的构件列表。 |
+|  [type](./brick-types.slotconfofbricks.type.md) | "bricks" |  |
+

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

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

package/dist/brick-types.slotconfofroutes.md

@@ -0,0 +1,28 @@
+---
+id: brick-types.slotconfofroutes
+title: SlotConfOfRoutes
+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; [SlotConfOfRoutes](./brick-types.slotconfofroutes.md)
+
+## SlotConfOfRoutes interface
+
+使用一组子路由的插槽配置。
+
+**Signature:**
+
+```typescript
+export interface SlotConfOfRoutes
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [routes](./brick-types.slotconfofroutes.routes.md) | [RouteConf](./brick-types.routeconf.md)<!-- -->\[\] | 在插槽中插入的子路由列表。 |
+|  [type](./brick-types.slotconfofroutes.type.md) | "routes" |  |
+

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

@@ -0,0 +1,23 @@
+---
+id: brick-types.slotconfofroutes.routes
+title: SlotConfOfRoutes.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; [SlotConfOfRoutes](./brick-types.slotconfofroutes.md) &gt; [routes](./brick-types.slotconfofroutes.routes.md)
+
+## SlotConfOfRoutes.routes property
+
+在插槽中插入的子路由列表。
+
+**Signature:**
+
+```typescript
+routes: RouteConf[];
+```
+
+**Reference:** [RouteConf](./brick-types.routeconf.md)
+

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

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

package/dist/brick-types.slotsconf.md

@@ -0,0 +1,44 @@
+---
+id: brick-types.slotsconf
+title: SlotsConf
+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; [SlotsConf](./brick-types.slotsconf.md)
+
+## SlotsConf interface
+
+插槽配置表。
+
+**Signature:**
+
+```typescript
+export interface SlotsConf
+```
+
+## Remarks
+
+对于容器类构件，会有特定的插槽以供插入子构件，容器构件通常会对这些插槽内的子构件有不同的布局及交互处理。
+
+`slots` 为 key-value 键值对配置，其中 key 为插槽名称，value 为插槽配置。
+
+每个插槽配置有两种模式：构件列表和路由列表。 对于构件列表，容器将直接插入这些子构件。 而对于路由构件，系统将根据路由匹配进行渲染。
+
+## Example
+
+
+```yaml
+brick: "basic-bricks.micro-view"
+slots:
+  toolbar:
+    type: "bricks"
+    bricks: ...
+  content:
+    type: "routes"
+    routes: ...
+```
+
+

package/dist/brick-types.slotsconfintemplate.md

@@ -0,0 +1,25 @@
+---
+id: brick-types.slotsconfintemplate
+title: SlotsConfInTemplate
+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; [SlotsConfInTemplate](./brick-types.slotsconfintemplate.md)
+
+## SlotsConfInTemplate interface
+
+自定义模板中的构件的插槽配置表。
+
+**Signature:**
+
+```typescript
+export interface SlotsConfInTemplate
+```
+
+## Remarks
+
+配置表中的键为插槽名，值为插槽配置。
+

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

@@ -0,0 +1,21 @@
+---
+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

@@ -0,0 +1,19 @@
+---
+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

@@ -0,0 +1,27 @@
+---
+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

@@ -0,0 +1,19 @@
+---
+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

@@ -0,0 +1,19 @@
+---
+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

@@ -0,0 +1,29 @@
+---
+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

@@ -0,0 +1,19 @@
+---
+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";
+```
+