@next-core/next-docs 1.2.567 → 1.2.569

package/dist/brick-types.microapp.md

@@ -1,51 +0,0 @@
----
-id: brick-types.microapp
-title: MicroApp
-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)
-
-## MicroApp interface
-
-微应用基本信息。
-
-**Signature:**
-
-```typescript
-export interface MicroApp
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [breadcrumb](./brick-types.microapp.breadcrumb.md) | [BreadcrumbConf](./brick-types.breadcrumbconf.md) | 面包屑配置 |
-|  [config](./brick-types.microapp.config.md) | Record&lt;string, unknown&gt; | 合并后的应用配置（运行时得出）。 |
-|  [currentVersion](./brick-types.microapp.currentversion.md) | string | 应用当前版本。 |
-|  [defaultConfig](./brick-types.microapp.defaultconfig.md) | Record&lt;string, unknown&gt; | 应用的默认配置，在开发环境由应用开发者维护。 |
-|  [homepage](./brick-types.microapp.homepage.md) | string | 应用主页地址，如 <code>/search</code>。 |
-|  [iconBackground](./brick-types.microapp.iconbackground.md) | "circle" \| "square" | 应用图标在 Launchpad 中显示的背景形状。 |
-|  [icons](./brick-types.microapp.icons.md) | { large: string; } | 应用图标配置。 |
-|  [id](./brick-types.microapp.id.md) | string | 应用唯一 ID，应使用 <code>lower-kebab-case</code> 格式。 |
-|  [installStatus](./brick-types.microapp.installstatus.md) | "ok" \| "running" | 应用的安装状态。 |
-|  [internal](./brick-types.microapp.internal.md) | boolean | 标记为内部的应用不会出现在 Launchpad 中。 |
-|  [isBuildPush](./brick-types.microapp.isbuildpush.md) | boolean | 表示该应用是否是来自 BuildAndPush 的。 |
-|  [layoutType](./brick-types.microapp.layouttype.md) | [LayoutType](./brick-types.layouttype.md) | 页面整体布局类型。 |
-|  [legacy](./brick-types.microapp.legacy.md) | "iframe" | 应用是否是 iframe 嵌套老 console 的模式。 |
-|  [localeName](./brick-types.microapp.localename.md) | string | 本地化后的应用名称（运行时得出），本地化获取失败时回退到 <code>name</code>。 |
-|  [locales](./brick-types.microapp.locales.md) | [AppLocales](./brick-types.applocales.md) | 应用的基本信息的本地化配置。 |
-|  [localeTitle](./brick-types.microapp.localetitle.md) | string | 本地化后的页面标题（运行时得出），在运行环境由用户维护，本地化获取失败时为“”。 |
-|  [menuIcon](./brick-types.microapp.menuicon.md) | [MenuIcon](./brick-types.menuicon.md) \| { imgSrc?: string; imgStyle?: Record&lt;string, any&gt;; } | 应用在菜单中显示的图标。 |
-|  [name](./brick-types.microapp.name.md) | string | 应用名称。 |
-|  [noAuthGuard](./brick-types.microapp.noauthguard.md) | boolean | 整个应用不启用登录守卫。 |
-|  [private](./brick-types.microapp.private.md) | boolean | 标记为私有的应用不会出现在应用商店中。 |
-|  [standaloneMode](./brick-types.microapp.standalonemode.md) | boolean | 该应用是否是独立打包应用 |
-|  [status](./brick-types.microapp.status.md) | "developing" \| "enabled" \| "disabled" | 应用状态。 |
-|  [theme](./brick-types.microapp.theme.md) | "light" \| "dark-v2" | 该应用所属主题， dark 已经被用大屏模式，这里使用 dark-v2 |
-|  [uiVersion](./brick-types.microapp.uiversion.md) | string | UI 版本 |
-|  [userConfig](./brick-types.microapp.userconfig.md) | Record&lt;string, unknown&gt; | 应用的用户配置，在运行环境由用户维护。 |
-

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

@@ -1,26 +0,0 @@
----
-id: brick-types.microapp.menuicon
-title: MicroApp.menuIcon
-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; [menuIcon](./brick-types.microapp.menuicon.md)
-
-## MicroApp.menuIcon property
-
-应用在菜单中显示的图标。
-
-**Signature:**
-
-```typescript
-menuIcon?: MenuIcon | {
-        imgSrc?: string;
-        imgStyle?: Record<string, any>;
-    };
-```
-
-**Reference:** [MenuIcon](./brick-types.menuicon.md)
-

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

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

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.noauthguard
-title: MicroApp.noAuthGuard
-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; [noAuthGuard](./brick-types.microapp.noauthguard.md)
-
-## MicroApp.noAuthGuard property
-
-整个应用不启用登录守卫。
-
-**Signature:**
-
-```typescript
-noAuthGuard?: boolean;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.private
-title: MicroApp.private
-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; [private](./brick-types.microapp.private.md)
-
-## MicroApp.private property
-
-标记为私有的应用不会出现在应用商店中。
-
-**Signature:**
-
-```typescript
-private?: boolean;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.standalonemode
-title: MicroApp.standaloneMode
-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; [standaloneMode](./brick-types.microapp.standalonemode.md)
-
-## MicroApp.standaloneMode property
-
-该应用是否是独立打包应用
-
-**Signature:**
-
-```typescript
-standaloneMode?: boolean;
-```
-

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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