@next-core/next-docs 1.2.179 → 1.2.183

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,38 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [1.2.183](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.182...@next-core/next-docs@1.2.183) (2021-12-31)
7
+
8
+ **Note:** Version bump only for package @next-core/next-docs
9
+
10
+
11
+
12
+
13
+
14
+ ## [1.2.182](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.181...@next-core/next-docs@1.2.182) (2021-12-30)
15
+
16
+ **Note:** Version bump only for package @next-core/next-docs
17
+
18
+
19
+
20
+
21
+
22
+ ## [1.2.181](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.180...@next-core/next-docs@1.2.181) (2021-12-29)
23
+
24
+ **Note:** Version bump only for package @next-core/next-docs
25
+
26
+
27
+
28
+
29
+
30
+ ## [1.2.180](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.179...@next-core/next-docs@1.2.180) (2021-12-29)
31
+
32
+ **Note:** Version bump only for package @next-core/next-docs
33
+
34
+
35
+
36
+
37
+
6
38
  ## [1.2.179](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.178...@next-core/next-docs@1.2.179) (2021-12-28)
7
39
 
8
40
  **Note:** Version bump only for package @next-core/next-docs
@@ -25,4 +25,5 @@ export interface EasyopsEmptyProps
25
25
  | [description](./brick-kit.easyopsemptyprops.description.md) | string \| React.ReactNode | |
26
26
  | [illustration](./brick-kit.easyopsemptyprops.illustration.md) | IllustrationProps | |
27
27
  | [imageStyle](./brick-kit.easyopsemptyprops.imagestyle.md) | React.CSSProperties | |
28
+ | [useBigEmptyImage](./brick-kit.easyopsemptyprops.usebigemptyimage.md) | boolean | |
28
29
 
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: brick-kit.easyopsemptyprops.usebigemptyimage
3
+ title: EasyopsEmptyProps.useBigEmptyImage
4
+ hide_title: true
5
+ custom_edit_url: null
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ [API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [EasyopsEmptyProps](./brick-kit.easyopsemptyprops.md) &gt; [useBigEmptyImage](./brick-kit.easyopsemptyprops.usebigemptyimage.md)
11
+
12
+ ## EasyopsEmptyProps.useBigEmptyImage property
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ useBigEmptyImage?: boolean;
18
+ ```
19
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: brick-kit.getmockid
3
+ title: getMockId
4
+ hide_title: true
5
+ custom_edit_url: null
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ [API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [getMockId](./brick-kit.getmockid.md)
11
+
12
+ ## getMockId variable
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ getMockId: (requestUrl: string) => string | undefined
18
+ ```
19
+
package/dist/brick-kit.md CHANGED
@@ -64,6 +64,6 @@ The core kit of Brick Next.
64
64
  | --- | --- |
65
65
  | [FeatureFlagsProvider](./brick-kit.featureflagsprovider.md) | |
66
66
  | [ForwardRefSingleBrickAsComponent](./brick-kit.forwardrefsinglebrickascomponent.md) | |
67
- | [getMockRule](./brick-kit.getmockrule.md) | |
67
+ | [getMockId](./brick-kit.getmockid.md) | |
68
68
  | [SingleBrickAsComponent](./brick-kit.singlebrickascomponent.md) | 可以渲染单个 <code>useBrick</code> 的 React 组件。 |
69
69
 
@@ -16,6 +16,6 @@ custom_edit_url: null
16
16
  **Signature:**
17
17
 
18
18
  ```typescript
19
- action: "history.push" | "history.replace" | "history.goBack" | "history.goForward" | "history.reload" | "history.pushQuery" | "history.replaceQuery" | "history.pushAnchor" | "history.block" | "history.unblock" | "segue.push" | "segue.replace" | "alias.push" | "alias.replace" | "localStorage.setItem" | "localStorage.removeItem" | "sessionStorage.setItem" | "sessionStorage.removeItem" | "legacy.go" | "location.reload" | "location.assign" | "window.open" | "event.preventDefault" | "console.log" | "console.error" | "console.warn" | "console.info" | "message.success" | "message.error" | "message.info" | "message.warn" | "handleHttpError" | "context.assign" | "context.replace" | "tpl.dispatchEvent" | "message.subscribe" | "message.unsubscribe" | "theme.setDarkTheme" | "theme.setLightTheme" | "mode.setDashboardMode" | "mode.setDefaultMode" | "menu.clearMenuTitleCache" | "menu.clearMenuCache" | "analytics.event";
19
+ action: "history.push" | "history.replace" | "history.goBack" | "history.goForward" | "history.reload" | "history.pushQuery" | "history.replaceQuery" | "history.pushAnchor" | "history.block" | "history.unblock" | "segue.push" | "segue.replace" | "alias.push" | "alias.replace" | "localStorage.setItem" | "localStorage.removeItem" | "sessionStorage.setItem" | "sessionStorage.removeItem" | "legacy.go" | "location.reload" | "location.assign" | "window.open" | "event.preventDefault" | "console.log" | "console.error" | "console.warn" | "console.info" | "message.success" | "message.error" | "message.info" | "message.warn" | "handleHttpError" | "context.assign" | "context.replace" | "tpl.dispatchEvent" | "message.subscribe" | "message.unsubscribe" | "theme.setDarkTheme" | "theme.setLightTheme" | "theme.setTheme" | "mode.setDashboardMode" | "mode.setDefaultMode" | "menu.clearMenuTitleCache" | "menu.clearMenuCache" | "analytics.event";
20
20
  ```
21
21
 
@@ -23,7 +23,7 @@ export interface BuiltinBrickEventHandler
23
23
 
24
24
  | Property | Type | Description |
25
25
  | --- | --- | --- |
26
- | [action](./brick-types.builtinbrickeventhandler.action.md) | "history.push" \| "history.replace" \| "history.goBack" \| "history.goForward" \| "history.reload" \| "history.pushQuery" \| "history.replaceQuery" \| "history.pushAnchor" \| "history.block" \| "history.unblock" \| "segue.push" \| "segue.replace" \| "alias.push" \| "alias.replace" \| "localStorage.setItem" \| "localStorage.removeItem" \| "sessionStorage.setItem" \| "sessionStorage.removeItem" \| "legacy.go" \| "location.reload" \| "location.assign" \| "window.open" \| "event.preventDefault" \| "console.log" \| "console.error" \| "console.warn" \| "console.info" \| "message.success" \| "message.error" \| "message.info" \| "message.warn" \| "handleHttpError" \| "context.assign" \| "context.replace" \| "tpl.dispatchEvent" \| "message.subscribe" \| "message.unsubscribe" \| "theme.setDarkTheme" \| "theme.setLightTheme" \| "mode.setDashboardMode" \| "mode.setDefaultMode" \| "menu.clearMenuTitleCache" \| "menu.clearMenuCache" \| "analytics.event" | 处理动作名。 |
26
+ | [action](./brick-types.builtinbrickeventhandler.action.md) | "history.push" \| "history.replace" \| "history.goBack" \| "history.goForward" \| "history.reload" \| "history.pushQuery" \| "history.replaceQuery" \| "history.pushAnchor" \| "history.block" \| "history.unblock" \| "segue.push" \| "segue.replace" \| "alias.push" \| "alias.replace" \| "localStorage.setItem" \| "localStorage.removeItem" \| "sessionStorage.setItem" \| "sessionStorage.removeItem" \| "legacy.go" \| "location.reload" \| "location.assign" \| "window.open" \| "event.preventDefault" \| "console.log" \| "console.error" \| "console.warn" \| "console.info" \| "message.success" \| "message.error" \| "message.info" \| "message.warn" \| "handleHttpError" \| "context.assign" \| "context.replace" \| "tpl.dispatchEvent" \| "message.subscribe" \| "message.unsubscribe" \| "theme.setDarkTheme" \| "theme.setLightTheme" \| "theme.setTheme" \| "mode.setDashboardMode" \| "mode.setDefaultMode" \| "menu.clearMenuTitleCache" \| "menu.clearMenuCache" \| "analytics.event" | 处理动作名。 |
27
27
  | [args](./brick-types.builtinbrickeventhandler.args.md) | unknown\[\] | 传递的参数列表 |
28
28
  | [callback](./brick-types.builtinbrickeventhandler.callback.md) | [BrickEventHandlerCallback](./brick-types.brickeventhandlercallback.md) | 事件处理回调。 |
29
29
  | [if](./brick-types.builtinbrickeventhandler.if.md) | string \| boolean | 根据条件决定是否执行该动作。 |
@@ -86,6 +86,7 @@ The core types of Brick Next.
86
86
  | [MetaI18n](./brick-types.metai18n.md) | 应用定义的国际化配置表。 |
87
87
  | [MicroApp](./brick-types.microapp.md) | 微应用基本信息。 |
88
88
  | [MockRule](./brick-types.mockrule.md) | 应用启用mock服务 |
89
+ | [Mocks](./brick-types.mocks.md) | |
89
90
  | [PluginHistory](./brick-types.pluginhistory.md) | 系统会话对象。 |
90
91
  | [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) | 系统运行时信息。 |
91
92
  | [ProviderConf](./brick-types.providerconf.md) | Provider 配置。 |
@@ -43,5 +43,6 @@ export interface MicroApp
43
43
  | [noAuthGuard](./brick-types.microapp.noauthguard.md) | boolean | 整个应用不启用登录守卫。 |
44
44
  | [private](./brick-types.microapp.private.md) | boolean | 标记为私有的应用不会出现在应用商店中。 |
45
45
  | [status](./brick-types.microapp.status.md) | "developing" \| "enabled" \| "disabled" | 应用状态。 |
46
+ | [theme](./brick-types.microapp.theme.md) | "light" \| "dark-v2" | 该应用所属主题, dark 已经被用大屏模式,这里使用 dark-v2 |
46
47
  | [userConfig](./brick-types.microapp.userconfig.md) | Record&lt;string, unknown&gt; | 应用的用户配置,在运行环境由用户维护。 |
47
48
 
@@ -0,0 +1,21 @@
1
+ ---
2
+ id: brick-types.microapp.theme
3
+ title: MicroApp.theme
4
+ hide_title: true
5
+ custom_edit_url: null
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ [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)
11
+
12
+ ## MicroApp.theme property
13
+
14
+ 该应用所属主题, dark 已经被用大屏模式,这里使用 dark-v2
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ theme?: "light" | "dark-v2";
20
+ ```
21
+
@@ -23,6 +23,5 @@ export interface MockRule
23
23
 
24
24
  | Property | Type | Description |
25
25
  | --- | --- | --- |
26
- | [mockId](./brick-types.mockrule.mockid.md) | string | mock id |
27
26
  | [uri](./brick-types.mockrule.uri.md) | string | uri地址 |
28
27
 
@@ -0,0 +1,26 @@
1
+ ---
2
+ id: brick-types.mocks
3
+ title: Mocks
4
+ hide_title: true
5
+ custom_edit_url: null
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ [API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [Mocks](./brick-types.mocks.md)
11
+
12
+ ## Mocks interface
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ export interface Mocks
18
+ ```
19
+
20
+ ## Properties
21
+
22
+ | Property | Type | Description |
23
+ | --- | --- | --- |
24
+ | [mockId](./brick-types.mocks.mockid.md) | string | mock id |
25
+ | [mockList](./brick-types.mocks.mocklist.md) | [MockRule](./brick-types.mockrule.md)<!-- -->\[\] | 使用mock规则列表 |
26
+
@@ -1,15 +1,15 @@
1
1
  ---
2
- id: brick-types.mockrule.mockid
3
- title: MockRule.mockId
2
+ id: brick-types.mocks.mockid
3
+ title: Mocks.mockId
4
4
  hide_title: true
5
5
  custom_edit_url: null
6
6
  ---
7
7
 
8
8
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
9
 
10
- [API Reference](./index.md) &gt; [@next-core/brick-types](./brick-types.md) &gt; [MockRule](./brick-types.mockrule.md) &gt; [mockId](./brick-types.mockrule.mockid.md)
10
+ [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)
11
11
 
12
- ## MockRule.mockId property
12
+ ## Mocks.mockId property
13
13
 
14
14
  mock id
15
15
 
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: brick-types.mocks.mocklist
3
+ title: Mocks.mockList
4
+ hide_title: true
5
+ custom_edit_url: null
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ [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)
11
+
12
+ ## Mocks.mockList property
13
+
14
+ 使用mock规则列表
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ mockList: MockRule[];
20
+ ```
21
+
22
+ **Reference:** [MockRule](./brick-types.mockrule.md)
23
+
@@ -16,6 +16,6 @@ custom_edit_url: null
16
16
  **Signature:**
17
17
 
18
18
  ```typescript
19
- export declare type SiteTheme = "light" | "dark";
19
+ export declare type SiteTheme = "light" | "dark" | "dark-v2";
20
20
  ```
21
21
 
@@ -27,5 +27,5 @@ export interface StoryboardMeta
27
27
  | [functions](./brick-types.storyboardmeta.functions.md) | [StoryboardFunction](./brick-types.storyboardfunction.md)<!-- -->\[\] | 应用定义的函数列表。 |
28
28
  | [i18n](./brick-types.storyboardmeta.i18n.md) | [MetaI18n](./brick-types.metai18n.md) | 应用定义的国际化配置表。 |
29
29
  | [menus](./brick-types.storyboardmeta.menus.md) | [MenuRawData](./brick-types.menurawdata.md)<!-- -->\[\] | |
30
- | [mocks](./brick-types.storyboardmeta.mocks.md) | [MockRule](./brick-types.mockrule.md)<!-- -->\[\] | 应用启用mock服务列表 |
30
+ | [mocks](./brick-types.storyboardmeta.mocks.md) | [Mocks](./brick-types.mocks.md) | 应用启用mock服务列表 |
31
31
 
@@ -16,8 +16,8 @@ custom_edit_url: null
16
16
  **Signature:**
17
17
 
18
18
  ```typescript
19
- mocks?: MockRule[];
19
+ mocks?: Mocks;
20
20
  ```
21
21
 
22
- **Reference:** [MockRule](./brick-types.mockrule.md)
22
+ **Reference:** [Mocks](./brick-types.mocks.md)
23
23
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@next-core/next-docs",
3
- "version": "1.2.179",
3
+ "version": "1.2.183",
4
4
  "description": "> TODO: description",
5
5
  "homepage": "https://github.com/easyops-cn/next-core/tree/master/packages/next-docs",
6
6
  "license": "GPL-3.0",
@@ -21,9 +21,9 @@
21
21
  "sideEffects": false,
22
22
  "devDependencies": {
23
23
  "@easyops-cn/brick-next-pipes": "^0.3.12",
24
- "@next-core/brick-kit": "^2.95.1",
25
- "@next-core/brick-types": "^2.52.0",
24
+ "@next-core/brick-kit": "^2.99.0",
25
+ "@next-core/brick-types": "^2.54.0",
26
26
  "fs-extra": "^10.0.0"
27
27
  },
28
- "gitHead": "2fbc145285bf9c081fa7ef6d702ef22a6a17f2db"
28
+ "gitHead": "fce6644df3e1b98e00e50fef4b8281290c92bd1e"
29
29
  }
@@ -1,21 +0,0 @@
1
- ---
2
- id: brick-kit.getmockrule
3
- title: getMockRule
4
- hide_title: true
5
- custom_edit_url: null
6
- ---
7
-
8
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
-
10
- [API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [getMockRule](./brick-kit.getmockrule.md)
11
-
12
- ## getMockRule variable
13
-
14
- **Signature:**
15
-
16
- ```typescript
17
- getMockRule: (requestUrl: string) => MockRule
18
- ```
19
-
20
- **Reference:** [MockRule](./brick-types.mockrule.md)
21
-