@next-core/next-docs 1.2.536 → 1.2.538

package/dist/brick-types.menurawdata.items.md

@@ -1,21 +0,0 @@
----
-id: brick-types.menurawdata.items
-title: MenuRawData.items
-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; [MenuRawData](./brick-types.menurawdata.md) &gt; [items](./brick-types.menurawdata.items.md)
-
-## MenuRawData.items property
-
-**Signature:**
-
-```typescript
-items?: MenuItemRawData[];
-```
-
-**Reference:** [MenuItemRawData](./brick-types.menuitemrawdata.md)
-

package/dist/brick-types.menurawdata.itemsresolve.md

@@ -1,21 +0,0 @@
----
-id: brick-types.menurawdata.itemsresolve
-title: MenuRawData.itemsResolve
-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; [MenuRawData](./brick-types.menurawdata.md) &gt; [itemsResolve](./brick-types.menurawdata.itemsresolve.md)
-
-## MenuRawData.itemsResolve property
-
-**Signature:**
-
-```typescript
-itemsResolve?: ResolveConf;
-```
-
-**Reference:** [ResolveConf](./brick-types.resolveconf.md)
-

package/dist/brick-types.menurawdata.link.md

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

package/dist/brick-types.menurawdata.md

@@ -1,41 +0,0 @@
----
-id: brick-types.menurawdata
-title: MenuRawData
-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; [MenuRawData](./brick-types.menurawdata.md)
-
-## MenuRawData interface
-
-原始菜单数据。
-
-**Signature:**
-
-```typescript
-export interface MenuRawData
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [app](./brick-types.menurawdata.app.md) | \[ { appId: string; } \] |  |
-|  [defaultCollapsed](./brick-types.menurawdata.defaultcollapsed.md) | boolean |  |
-|  [defaultCollapsedBreakpoint](./brick-types.menurawdata.defaultcollapsedbreakpoint.md) | number |  |
-|  [dynamicItems](./brick-types.menurawdata.dynamicitems.md) | boolean |  |
-|  [i18n](./brick-types.menurawdata.i18n.md) | [MetaI18n](./brick-types.metai18n.md) |  |
-|  [icon](./brick-types.menurawdata.icon.md) | [MenuIcon](./brick-types.menuicon.md) |  |
-|  [injectMenuGroupId](./brick-types.menurawdata.injectmenugroupid.md) | string |  |
-|  [items](./brick-types.menurawdata.items.md) | [MenuItemRawData](./brick-types.menuitemrawdata.md)<!-- -->\[\] |  |
-|  [itemsResolve](./brick-types.menurawdata.itemsresolve.md) | [ResolveConf](./brick-types.resolveconf.md) |  |
-|  [link](./brick-types.menurawdata.link.md) | string |  |
-|  [menuId](./brick-types.menurawdata.menuid.md) | string |  |
-|  [overrideApp](./brick-types.menurawdata.overrideapp.md) | [MicroApp](./brick-types.microapp.md) |  |
-|  [title](./brick-types.menurawdata.title.md) | string |  |
-|  [titleDataSource](./brick-types.menurawdata.titledatasource.md) | TitleDataSource |  |
-|  [type](./brick-types.menurawdata.type.md) | "main" \| "inject" |  |
-

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

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

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

@@ -1,21 +0,0 @@
----
-id: brick-types.menurawdata.overrideapp
-title: MenuRawData.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; [MenuRawData](./brick-types.menurawdata.md) &gt; [overrideApp](./brick-types.menurawdata.overrideapp.md)
-
-## MenuRawData.overrideApp property
-
-**Signature:**
-
-```typescript
-overrideApp?: MicroApp;
-```
-
-**Reference:** [MicroApp](./brick-types.microapp.md)
-

package/dist/brick-types.menurawdata.title.md

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

package/dist/brick-types.menurawdata.titledatasource.md

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

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

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

package/dist/brick-types.metai18n.md

@@ -1,34 +0,0 @@
----
-id: brick-types.metai18n
-title: MetaI18n
-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; [MetaI18n](./brick-types.metai18n.md)
-
-## MetaI18n interface
-
-应用定义的国际化配置表。
-
-**Signature:**
-
-```typescript
-export declare type MetaI18n = Record<string, Record<string, string>>;
-```
-
-## Example
-
-
-```yaml
-zh:
-  SEARCH: 搜索
-  PLEASE_INPUT_KEYWORDS: 请输入关键字。
-en:
-  SEARCH: Search
-  PLEASE_INPUT_KEYWORDS: Please input keywords.
-```
-
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.microapp.breadcrumb
-title: MicroApp.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; [MicroApp](./brick-types.microapp.md) &gt; [breadcrumb](./brick-types.microapp.breadcrumb.md)
-
-## MicroApp.breadcrumb property
-
-面包屑配置
-
-**Signature:**
-
-```typescript
-breadcrumb?: BreadcrumbConf;
-```
-
-**Reference:** [BreadcrumbConf](./brick-types.breadcrumbconf.md)
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.config
-title: MicroApp.config
-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; [config](./brick-types.microapp.config.md)
-
-## MicroApp.config property
-
-合并后的应用配置（运行时得出）。
-
-**Signature:**
-
-```typescript
-config?: Record<string, unknown>;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.currentversion
-title: MicroApp.currentVersion
-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; [currentVersion](./brick-types.microapp.currentversion.md)
-
-## MicroApp.currentVersion property
-
-应用当前版本。
-
-**Signature:**
-
-```typescript
-currentVersion?: string;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.defaultconfig
-title: MicroApp.defaultConfig
-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; [defaultConfig](./brick-types.microapp.defaultconfig.md)
-
-## MicroApp.defaultConfig property
-
-应用的默认配置，在开发环境由应用开发者维护。
-
-**Signature:**
-
-```typescript
-defaultConfig?: Record<string, unknown>;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.homepage
-title: MicroApp.homepage
-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; [homepage](./brick-types.microapp.homepage.md)
-
-## MicroApp.homepage property
-
-应用主页地址，如 `/search`<!-- -->。
-
-**Signature:**
-
-```typescript
-homepage: string;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.iconbackground
-title: MicroApp.iconBackground
-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; [iconBackground](./brick-types.microapp.iconbackground.md)
-
-## MicroApp.iconBackground property
-
-应用图标在 Launchpad 中显示的背景形状。
-
-**Signature:**
-
-```typescript
-iconBackground?: "circle" | "square";
-```
-

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

@@ -1,45 +0,0 @@
----
-id: brick-types.microapp.icons
-title: MicroApp.icons
-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; [icons](./brick-types.microapp.icons.md)
-
-## MicroApp.icons property
-
-应用图标配置。
-
-**Signature:**
-
-```typescript
-icons?: {
-        large: string;
-    };
-```
-
-## Remarks
-
-图标地址相对于应用所在目录，也可以使用 `http://` 或 `https://` 开头的完整 URL。
-
-## Example 1
-
-
-```yaml
-icons:
-  large: "icons/large.png"
-```
-
-
-## Example 2
-
-
-```yaml
-icons:
-  large: "http://your.domain/your-icon.png"
-```
-
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.id
-title: MicroApp.id
-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; [id](./brick-types.microapp.id.md)
-
-## MicroApp.id property
-
-应用唯一 ID，应使用 `lower-kebab-case` 格式。
-
-**Signature:**
-
-```typescript
-id: string;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.installstatus
-title: MicroApp.installStatus
-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; [installStatus](./brick-types.microapp.installstatus.md)
-
-## MicroApp.installStatus property
-
-应用的安装状态。
-
-**Signature:**
-
-```typescript
-installStatus?: "ok" | "running";
-```
-

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

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

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.isbuildpush
-title: MicroApp.isBuildPush
-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; [isBuildPush](./brick-types.microapp.isbuildpush.md)
-
-## MicroApp.isBuildPush property
-
-表示该应用是否是来自 BuildAndPush 的。
-
-**Signature:**
-
-```typescript
-isBuildPush?: boolean;
-```
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.microapp.layouttype
-title: MicroApp.layoutType
-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; [layoutType](./brick-types.microapp.layouttype.md)
-
-## MicroApp.layoutType property
-
-页面整体布局类型。
-
-**Signature:**
-
-```typescript
-layoutType?: LayoutType;
-```
-
-**Reference:** [LayoutType](./brick-types.layouttype.md)
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.legacy
-title: MicroApp.legacy
-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; [legacy](./brick-types.microapp.legacy.md)
-
-## MicroApp.legacy property
-
-应用是否是 iframe 嵌套老 console 的模式。
-
-**Signature:**
-
-```typescript
-legacy?: "iframe";
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.microapp.localename
-title: MicroApp.localeName
-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; [localeName](./brick-types.microapp.localename.md)
-
-## MicroApp.localeName property
-
-本地化后的应用名称（运行时得出），本地化获取失败时回退到 `name`<!-- -->。
-
-**Signature:**
-
-```typescript
-localeName?: string;
-```
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.microapp.locales
-title: MicroApp.locales
-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; [locales](./brick-types.microapp.locales.md)
-
-## MicroApp.locales property
-
-应用的基本信息的本地化配置。
-
-**Signature:**
-
-```typescript
-locales?: AppLocales;
-```
-
-**Reference:** [AppLocales](./brick-types.applocales.md)
-

package/dist/brick-types.microapp.md

@@ -1,50 +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) | 应用的基本信息的本地化配置。 |
-|  [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; | 应用的用户配置，在运行环境由用户维护。 |
-