@next-core/next-docs 1.2.544 → 1.2.545

package/dist/brick-types.microapp.status.md

@@ -0,0 +1,25 @@
+---
+id: brick-types.microapp.status
+title: MicroApp.status
+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; [MicroApp](./brick-types.microapp.md) &gt; [status](./brick-types.microapp.status.md)
+
+## MicroApp.status property
+
+应用状态。
+
+**Signature:**
+
+```typescript
+status?: "developing" | "enabled" | "disabled";
+```
+
+## Remarks
+
+标记为 `disabled` 的应用不会出现在 Launchpad 中。
+

package/dist/brick-types.microapp.theme.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.microapp.theme
+title: MicroApp.theme
+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; [MicroApp](./brick-types.microapp.md) &gt; [theme](./brick-types.microapp.theme.md)
+
+## MicroApp.theme property
+
+该应用所属主题， dark 已经被用大屏模式，这里使用 dark-v2
+
+**Signature:**
+
+```typescript
+theme?: "light" | "dark-v2";
+```
+

package/dist/brick-types.microapp.uiversion.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.microapp.uiversion
+title: MicroApp.uiVersion
+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; [MicroApp](./brick-types.microapp.md) &gt; [uiVersion](./brick-types.microapp.uiversion.md)
+
+## MicroApp.uiVersion property
+
+UI 版本
+
+**Signature:**
+
+```typescript
+uiVersion?: string;
+```
+

package/dist/brick-types.microapp.userconfig.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.microapp.userconfig
+title: MicroApp.userConfig
+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; [MicroApp](./brick-types.microapp.md) &gt; [userConfig](./brick-types.microapp.userconfig.md)
+
+## MicroApp.userConfig property
+
+应用的用户配置，在运行环境由用户维护。
+
+**Signature:**
+
+```typescript
+userConfig?: Record<string, unknown>;
+```
+

package/dist/brick-types.mockrule.md

@@ -0,0 +1,29 @@
+---
+id: brick-types.mockrule
+title: MockRule
+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; [MockRule](./brick-types.mockrule.md)
+
+## MockRule interface
+
+应用启用mock服务
+
+**Signature:**
+
+```typescript
+export interface MockRule
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [method](./brick-types.mockrule.method.md) | string | method方法 |
+|  [provider](./brick-types.mockrule.provider.md) | string | provider名称 |
+|  [uri](./brick-types.mockrule.uri.md) | string | uri地址 |
+

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

@@ -0,0 +1,21 @@
+---
+id: brick-types.mockrule.method
+title: MockRule.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; [MockRule](./brick-types.mockrule.md) &gt; [method](./brick-types.mockrule.method.md)
+
+## MockRule.method property
+
+method方法
+
+**Signature:**
+
+```typescript
+method?: string;
+```
+

package/dist/brick-types.mockrule.provider.md

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

package/dist/brick-types.mockrule.uri.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.mockrule.uri
+title: MockRule.uri
+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; [MockRule](./brick-types.mockrule.md) &gt; [uri](./brick-types.mockrule.uri.md)
+
+## MockRule.uri property
+
+uri地址
+
+**Signature:**
+
+```typescript
+uri: string;
+```
+

package/dist/brick-types.mocks.md

@@ -0,0 +1,26 @@
+---
+id: brick-types.mocks
+title: Mocks
+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; [Mocks](./brick-types.mocks.md)
+
+## Mocks interface
+
+**Signature:**
+
+```typescript
+export interface Mocks
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [mockId](./brick-types.mocks.mockid.md) | string | mock id |
+|  [mockList](./brick-types.mocks.mocklist.md) | [MockRule](./brick-types.mockrule.md)<!-- -->\[\] | 使用mock规则列表 |
+

package/dist/brick-types.mocks.mockid.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.mocks.mockid
+title: Mocks.mockId
+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; [Mocks](./brick-types.mocks.md) &gt; [mockId](./brick-types.mocks.mockid.md)
+
+## Mocks.mockId property
+
+mock id
+
+**Signature:**
+
+```typescript
+mockId: string;
+```
+

package/dist/brick-types.mocks.mocklist.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.mocks.mocklist
+title: Mocks.mockList
+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; [Mocks](./brick-types.mocks.md) &gt; [mockList](./brick-types.mocks.mocklist.md)
+
+## Mocks.mockList property
+
+使用mock规则列表
+
+**Signature:**
+
+```typescript
+mockList: MockRule[];
+```
+
+**Reference:** [MockRule](./brick-types.mockrule.md)
+

package/dist/brick-types.navtip.backgroundcolor.md

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

package/dist/brick-types.navtip.closable.md

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

package/dist/brick-types.navtip.info.md

@@ -0,0 +1,22 @@
+---
+id: brick-types.navtip.info
+title: NavTip.info
+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; [NavTip](./brick-types.navtip.md) &gt; [info](./brick-types.navtip.info.md)
+
+## NavTip.info property
+
+**Signature:**
+
+```typescript
+info?: {
+        url: string;
+        label: string;
+    };
+```
+

package/dist/brick-types.navtip.iscenter.md

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

package/dist/brick-types.navtip.md

@@ -0,0 +1,30 @@
+---
+id: brick-types.navtip
+title: NavTip
+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; [NavTip](./brick-types.navtip.md)
+
+## NavTip interface
+
+**Signature:**
+
+```typescript
+export interface NavTip
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [backgroundColor](./brick-types.navtip.backgroundcolor.md) | string |  |
+|  [closable](./brick-types.navtip.closable.md) | boolean |  |
+|  [info](./brick-types.navtip.info.md) | { url: string; label: string; } |  |
+|  [isCenter](./brick-types.navtip.iscenter.md) | boolean |  |
+|  [text](./brick-types.navtip.text.md) | string |  |
+|  [tipKey](./brick-types.navtip.tipkey.md) | string |  |
+

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

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

package/dist/brick-types.navtip.tipkey.md

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

package/dist/brick-types.pluginhistory.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.pluginhistory
+title: PluginHistory
+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; [PluginHistory](./brick-types.pluginhistory.md)
+
+## PluginHistory interface
+
+系统会话对象。
+
+**Signature:**
+
+```typescript
+export declare type PluginHistory = History<PluginHistoryState> & ExtendedHistory;
+```
+
+**Reference:** [ExtendedHistory](./brick-types.extendedhistory.md)
+

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

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

package/dist/brick-types.pluginruntimecontext.appendi18nnamespace.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.pluginruntimecontext.appendi18nnamespace
+title: PluginRuntimeContext.appendI18nNamespace
+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; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [appendI18nNamespace](./brick-types.pluginruntimecontext.appendi18nnamespace.md)
+
+## PluginRuntimeContext.appendI18nNamespace property
+
+扩展当前表达式的国际化命名空间。
+
+**Signature:**
+
+```typescript
+appendI18nNamespace?: string;
+```
+

package/dist/brick-types.pluginruntimecontext.event.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.pluginruntimecontext.event
+title: PluginRuntimeContext.event
+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; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [event](./brick-types.pluginruntimecontext.event.md)
+
+## PluginRuntimeContext.event property
+
+当前的在事件处理中的事件对象。
+
+**Signature:**
+
+```typescript
+event?: CustomEvent;
+```
+

package/dist/brick-types.pluginruntimecontext.flags.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.pluginruntimecontext.flags
+title: PluginRuntimeContext.flags
+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; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [flags](./brick-types.pluginruntimecontext.flags.md)
+
+## PluginRuntimeContext.flags property
+
+特性开关字典。
+
+**Signature:**
+
+```typescript
+flags?: FeatureFlags;
+```
+
+**Reference:** [FeatureFlags](./brick-types.featureflags.md)
+

package/dist/brick-types.pluginruntimecontext.hash.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.pluginruntimecontext.hash
+title: PluginRuntimeContext.hash
+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; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [hash](./brick-types.pluginruntimecontext.hash.md)
+
+## PluginRuntimeContext.hash property
+
+当前的 hash 参数
+
+**Signature:**
+
+```typescript
+hash?: string;
+```
+

package/dist/brick-types.pluginruntimecontext.md

@@ -0,0 +1,36 @@
+---
+id: brick-types.pluginruntimecontext
+title: PluginRuntimeContext
+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; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md)
+
+## PluginRuntimeContext interface
+
+系统运行时信息。
+
+**Signature:**
+
+```typescript
+export interface PluginRuntimeContext
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [app](./brick-types.pluginruntimecontext.app.md) | [MicroApp](./brick-types.microapp.md) | 当前的应用信息。 |
+|  [appendI18nNamespace](./brick-types.pluginruntimecontext.appendi18nnamespace.md) | string | 扩展当前表达式的国际化命名空间。 |
+|  [event](./brick-types.pluginruntimecontext.event.md) | CustomEvent | 当前的在事件处理中的事件对象。 |
+|  [flags](./brick-types.pluginruntimecontext.flags.md) | [FeatureFlags](./brick-types.featureflags.md) | 特性开关字典。 |
+|  [hash](./brick-types.pluginruntimecontext.hash.md) | string | 当前的 hash 参数 |
+|  [overrideApp](./brick-types.pluginruntimecontext.overrideapp.md) | [MicroApp](./brick-types.microapp.md) | 用于跨应用菜单注入等场景的应用重载。 |
+|  [pathname](./brick-types.pluginruntimecontext.pathname.md) | string | 当前的 pathname 参数 |
+|  [query](./brick-types.pluginruntimecontext.query.md) | URLSearchParams | 当前的 query 参数。 |
+|  [segues](./brick-types.pluginruntimecontext.segues.md) | [SeguesConf](./brick-types.seguesconf.md) | 当前应用的页面切换配置。 |
+|  [sys](./brick-types.pluginruntimecontext.sys.md) | [SystemInfo](./brick-types.systeminfo.md) | 系统会话信息。 |
+

package/dist/brick-types.pluginruntimecontext.overrideapp.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.pluginruntimecontext.overrideapp
+title: PluginRuntimeContext.overrideApp
+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; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [overrideApp](./brick-types.pluginruntimecontext.overrideapp.md)
+
+## PluginRuntimeContext.overrideApp property
+
+用于跨应用菜单注入等场景的应用重载。
+
+**Signature:**
+
+```typescript
+overrideApp?: MicroApp;
+```
+
+**Reference:** [MicroApp](./brick-types.microapp.md)
+

package/dist/brick-types.pluginruntimecontext.pathname.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.pluginruntimecontext.pathname
+title: PluginRuntimeContext.pathname
+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; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [pathname](./brick-types.pluginruntimecontext.pathname.md)
+
+## PluginRuntimeContext.pathname property
+
+当前的 pathname 参数
+
+**Signature:**
+
+```typescript
+pathname?: string;
+```
+

package/dist/brick-types.pluginruntimecontext.query.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.pluginruntimecontext.query
+title: PluginRuntimeContext.query
+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; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [query](./brick-types.pluginruntimecontext.query.md)
+
+## PluginRuntimeContext.query property
+
+当前的 query 参数。
+
+**Signature:**
+
+```typescript
+query?: URLSearchParams;
+```
+