@next-core/next-docs 1.2.573 → 1.2.574

package/dist/brick-types.scrollintoviewconf.threshold.md

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

package/dist/brick-types.segueconf.md

@@ -1,27 +0,0 @@
----
-id: brick-types.segueconf
-title: SegueConf
-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; [SegueConf](./brick-types.segueconf.md)
-
-## SegueConf interface
-
-页面切换配置。
-
-**Signature:**
-
-```typescript
-export interface SegueConf
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [target](./brick-types.segueconf.target.md) | string | 目标路由的别名。 |
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.segueconf.target
-title: SegueConf.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; [SegueConf](./brick-types.segueconf.md) &gt; [target](./brick-types.segueconf.target.md)
-
-## SegueConf.target property
-
-目标路由的别名。
-
-**Signature:**
-
-```typescript
-target: string;
-```
-

package/dist/brick-types.seguesconf.md

@@ -1,36 +0,0 @@
----
-id: brick-types.seguesconf
-title: SeguesConf
-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; [SeguesConf](./brick-types.seguesconf.md)
-
-## SeguesConf interface
-
-页面切换配置表。
-
-**Signature:**
-
-```typescript
-export interface SeguesConf
-```
-
-## Remarks
-
-可以用于组织视图之间的访问关系。在 Next Builder 中可以在 Routes Graph 页面显示该关系。
-
-## Example
-
-
-```yaml
-go-to-list:
-  target: product-list
-go-to-detail:
-  target: product-detail
-```
-
-

package/dist/brick-types.selectorproviderresolveconf.md

@@ -1,29 +0,0 @@
----
-id: brick-types.selectorproviderresolveconf
-title: SelectorProviderResolveConf
-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; [SelectorProviderResolveConf](./brick-types.selectorproviderresolveconf.md)
-
-## SelectorProviderResolveConf interface
-
-使用 CSS selector 指定 Provider 的异步数据处理配置。
-
-**Signature:**
-
-```typescript
-export interface SelectorProviderResolveConf extends BaseEntityResolveConf
-```
-
-**Extends:** [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md)
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [provider](./brick-types.selectorproviderresolveconf.provider.md) | string | Provider 构件的 CSS selector。 |
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.selectorproviderresolveconf.provider
-title: SelectorProviderResolveConf.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; [SelectorProviderResolveConf](./brick-types.selectorproviderresolveconf.md) &gt; [provider](./brick-types.selectorproviderresolveconf.provider.md)
-
-## SelectorProviderResolveConf.provider property
-
-Provider 构件的 CSS selector。
-
-**Signature:**
-
-```typescript
-provider: string;
-```
-

package/dist/brick-types.setpropscustombrickeventhandler.md

@@ -1,29 +0,0 @@
----
-id: brick-types.setpropscustombrickeventhandler
-title: SetPropsCustomBrickEventHandler
-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; [SetPropsCustomBrickEventHandler](./brick-types.setpropscustombrickeventhandler.md)
-
-## SetPropsCustomBrickEventHandler interface
-
-设置指定构件的指定属性的事件处理配置。
-
-**Signature:**
-
-```typescript
-export interface SetPropsCustomBrickEventHandler extends BaseCustomBrickEventHandler
-```
-
-**Extends:** [BaseCustomBrickEventHandler](./brick-types.basecustombrickeventhandler.md)
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [properties](./brick-types.setpropscustombrickeventhandler.properties.md) | Record&lt;string, unknown&gt; | 要设置的属性表。 |
-

package/dist/brick-types.setpropscustombrickeventhandler.properties.md

@@ -1,21 +0,0 @@
----
-id: brick-types.setpropscustombrickeventhandler.properties
-title: SetPropsCustomBrickEventHandler.properties
-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; [SetPropsCustomBrickEventHandler](./brick-types.setpropscustombrickeventhandler.md) &gt; [properties](./brick-types.setpropscustombrickeventhandler.properties.md)
-
-## SetPropsCustomBrickEventHandler.properties property
-
-要设置的属性表。
-
-**Signature:**
-
-```typescript
-properties: Record<string, unknown>;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenu.defaultcollapsed
-title: SidebarMenu.defaultCollapsed
-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; [SidebarMenu](./brick-types.sidebarmenu.md) &gt; [defaultCollapsed](./brick-types.sidebarmenu.defaultcollapsed.md)
-
-## SidebarMenu.defaultCollapsed property
-
-是否默认折叠。
-
-**Signature:**
-
-```typescript
-defaultCollapsed?: boolean;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenu.defaultcollapsedbreakpoint
-title: SidebarMenu.defaultCollapsedBreakpoint
-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; [SidebarMenu](./brick-types.sidebarmenu.md) &gt; [defaultCollapsedBreakpoint](./brick-types.sidebarmenu.defaultcollapsedbreakpoint.md)
-
-## SidebarMenu.defaultCollapsedBreakpoint property
-
-针对小于特定尺寸的屏幕（例如 1600px），是否默认折叠。
-
-**Signature:**
-
-```typescript
-defaultCollapsedBreakpoint?: number;
-```
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.sidebarmenu.icon
-title: SidebarMenu.icon
-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; [SidebarMenu](./brick-types.sidebarmenu.md) &gt; [icon](./brick-types.sidebarmenu.icon.md)
-
-## SidebarMenu.icon property
-
-菜单标题对应的图标。
-
-**Signature:**
-
-```typescript
-icon?: MenuIcon;
-```
-
-**Reference:** [MenuIcon](./brick-types.menuicon.md)
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenu.link
-title: SidebarMenu.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; [SidebarMenu](./brick-types.sidebarmenu.md) &gt; [link](./brick-types.sidebarmenu.link.md)
-
-## SidebarMenu.link property
-
-菜单标题对应的链接地址。
-
-**Signature:**
-
-```typescript
-link?: LocationDescriptor;
-```
-

package/dist/brick-types.sidebarmenu.md

@@ -1,33 +0,0 @@
----
-id: brick-types.sidebarmenu
-title: 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; [SidebarMenu](./brick-types.sidebarmenu.md)
-
-## SidebarMenu interface
-
-侧边栏菜单配置。
-
-**Signature:**
-
-```typescript
-export interface SidebarMenu
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [defaultCollapsed](./brick-types.sidebarmenu.defaultcollapsed.md) | boolean | 是否默认折叠。 |
-|  [defaultCollapsedBreakpoint](./brick-types.sidebarmenu.defaultcollapsedbreakpoint.md) | number | 针对小于特定尺寸的屏幕（例如 1600px），是否默认折叠。 |
-|  [icon](./brick-types.sidebarmenu.icon.md) | [MenuIcon](./brick-types.menuicon.md) | 菜单标题对应的图标。 |
-|  [link](./brick-types.sidebarmenu.link.md) | LocationDescriptor | 菜单标题对应的链接地址。 |
-|  [menuItems](./brick-types.sidebarmenu.menuitems.md) | [SidebarMenuItem](./brick-types.sidebarmenuitem.md)<!-- -->\[\] | 菜单项列表。 |
-|  [showRelatedApps](./brick-types.sidebarmenu.showrelatedapps.md) | boolean | 是否显示关联应用。 |
-|  [title](./brick-types.sidebarmenu.title.md) | string | 菜单标题。 |
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.sidebarmenu.menuitems
-title: SidebarMenu.menuItems
-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; [SidebarMenu](./brick-types.sidebarmenu.md) &gt; [menuItems](./brick-types.sidebarmenu.menuitems.md)
-
-## SidebarMenu.menuItems property
-
-菜单项列表。
-
-**Signature:**
-
-```typescript
-menuItems: SidebarMenuItem[];
-```
-
-**Reference:** [SidebarMenuItem](./brick-types.sidebarmenuitem.md)
-

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

@@ -1,26 +0,0 @@
----
-id: brick-types.sidebarmenu.showrelatedapps
-title: SidebarMenu.showRelatedApps
-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; [SidebarMenu](./brick-types.sidebarmenu.md) &gt; [showRelatedApps](./brick-types.sidebarmenu.showrelatedapps.md)
-
-## SidebarMenu.showRelatedApps property
-
-> Warning: This API is now obsolete.
-> 
-> 现在建议通过引用相同的 `menuId` 进行菜单扩展。
-> 
-
-是否显示关联应用。
-
-**Signature:**
-
-```typescript
-showRelatedApps?: boolean;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenu.title
-title: SidebarMenu.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; [SidebarMenu](./brick-types.sidebarmenu.md) &gt; [title](./brick-types.sidebarmenu.title.md)
-
-## SidebarMenu.title property
-
-菜单标题。
-
-**Signature:**
-
-```typescript
-title: string;
-```
-

package/dist/brick-types.sidebarmenugroup.childlayout.md

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenugroup.childlayout
-title: SidebarMenuGroup.childLayout
-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; [SidebarMenuGroup](./brick-types.sidebarmenugroup.md) &gt; [childLayout](./brick-types.sidebarmenugroup.childlayout.md)
-
-## SidebarMenuGroup.childLayout property
-
-子菜单项的布局方式。
-
-**Signature:**
-
-```typescript
-childLayout?: "default" | "category" | "siteMap";
-```
-

package/dist/brick-types.sidebarmenugroup.defaultexpanded.md

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenugroup.defaultexpanded
-title: SidebarMenuGroup.defaultExpanded
-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; [SidebarMenuGroup](./brick-types.sidebarmenugroup.md) &gt; [defaultExpanded](./brick-types.sidebarmenugroup.defaultexpanded.md)
-
-## SidebarMenuGroup.defaultExpanded property
-
-该分组下的子菜单是否默认展开。
-
-**Signature:**
-
-```typescript
-defaultExpanded?: boolean;
-```
-

package/dist/brick-types.sidebarmenugroup.groupfrom.md

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenugroup.groupfrom
-title: SidebarMenuGroup.groupFrom
-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; [SidebarMenuGroup](./brick-types.sidebarmenugroup.md) &gt; [groupFrom](./brick-types.sidebarmenugroup.groupfrom.md)
-
-## SidebarMenuGroup.groupFrom property
-
-分组来源。
-
-**Signature:**
-
-```typescript
-groupFrom?: string;
-```
-

package/dist/brick-types.sidebarmenugroup.groupid.md

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenugroup.groupid
-title: SidebarMenuGroup.groupId
-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; [SidebarMenuGroup](./brick-types.sidebarmenugroup.md) &gt; [groupId](./brick-types.sidebarmenugroup.groupid.md)
-
-## SidebarMenuGroup.groupId property
-
-分组 Id。
-
-**Signature:**
-
-```typescript
-groupId?: string;
-```
-

package/dist/brick-types.sidebarmenugroup.icon.md

@@ -1,23 +0,0 @@
----
-id: brick-types.sidebarmenugroup.icon
-title: SidebarMenuGroup.icon
-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; [SidebarMenuGroup](./brick-types.sidebarmenugroup.md) &gt; [icon](./brick-types.sidebarmenugroup.icon.md)
-
-## SidebarMenuGroup.icon property
-
-菜单项的图标。
-
-**Signature:**
-
-```typescript
-icon?: MenuIcon;
-```
-
-**Reference:** [MenuIcon](./brick-types.menuicon.md)
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.sidebarmenugroup.items
-title: SidebarMenuGroup.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; [SidebarMenuGroup](./brick-types.sidebarmenugroup.md) &gt; [items](./brick-types.sidebarmenugroup.items.md)
-
-## SidebarMenuGroup.items property
-
-该分组下的子菜单项列表。
-
-**Signature:**
-
-```typescript
-items: SidebarMenuItem[];
-```
-
-**Reference:** [SidebarMenuItem](./brick-types.sidebarmenuitem.md)
-

package/dist/brick-types.sidebarmenugroup.md

@@ -1,34 +0,0 @@
----
-id: brick-types.sidebarmenugroup
-title: SidebarMenuGroup
-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; [SidebarMenuGroup](./brick-types.sidebarmenugroup.md)
-
-## SidebarMenuGroup interface
-
-侧边栏分组菜单项的配置。
-
-**Signature:**
-
-```typescript
-export interface SidebarMenuGroup
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [childLayout](./brick-types.sidebarmenugroup.childlayout.md) | "default" \| "category" \| "siteMap" | 子菜单项的布局方式。 |
-|  [defaultExpanded](./brick-types.sidebarmenugroup.defaultexpanded.md) | boolean | 该分组下的子菜单是否默认展开。 |
-|  [groupFrom](./brick-types.sidebarmenugroup.groupfrom.md) | string | 分组来源。 |
-|  [groupId](./brick-types.sidebarmenugroup.groupid.md) | string | 分组 Id。 |
-|  [icon](./brick-types.sidebarmenugroup.icon.md) | [MenuIcon](./brick-types.menuicon.md) | 菜单项的图标。 |
-|  [items](./brick-types.sidebarmenugroup.items.md) | [SidebarMenuItem](./brick-types.sidebarmenuitem.md)<!-- -->\[\] | 该分组下的子菜单项列表。 |
-|  [title](./brick-types.sidebarmenugroup.title.md) | string | 分组标题。 |
-|  [type](./brick-types.sidebarmenugroup.type.md) | "group" \| "subMenu" | 分组类型。 |
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenugroup.title
-title: SidebarMenuGroup.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; [SidebarMenuGroup](./brick-types.sidebarmenugroup.md) &gt; [title](./brick-types.sidebarmenugroup.title.md)
-
-## SidebarMenuGroup.title property
-
-分组标题。
-
-**Signature:**
-
-```typescript
-title: string;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenugroup.type
-title: SidebarMenuGroup.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; [SidebarMenuGroup](./brick-types.sidebarmenugroup.md) &gt; [type](./brick-types.sidebarmenugroup.type.md)
-
-## SidebarMenuGroup.type property
-
-分组类型。
-
-**Signature:**
-
-```typescript
-type: "group" | "subMenu";
-```
-

package/dist/brick-types.sidebarmenuitem.md

@@ -1,23 +0,0 @@
----
-id: brick-types.sidebarmenuitem
-title: SidebarMenuItem
-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; [SidebarMenuItem](./brick-types.sidebarmenuitem.md)
-
-## SidebarMenuItem interface
-
-侧边栏菜单项配置。
-
-**Signature:**
-
-```typescript
-export declare type SidebarMenuItem = SidebarMenuSimpleItem | SidebarMenuGroup;
-```
-
-**Reference:** [SidebarMenuSimpleItem](./brick-types.sidebarmenusimpleitem.md)<!-- -->, [SidebarMenuGroup](./brick-types.sidebarmenugroup.md)
-

package/dist/brick-types.sidebarmenuitemtype.md

@@ -1,21 +0,0 @@
----
-id: brick-types.sidebarmenuitemtype
-title: SidebarMenuItemType
-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; [SidebarMenuItemType](./brick-types.sidebarmenuitemtype.md)
-
-## SidebarMenuItemType interface
-
-侧边栏二级菜单项类型。
-
-**Signature:**
-
-```typescript
-export declare type SidebarMenuItemType = "default" | "group" | "subMenu";
-```
-