@next-core/next-docs 1.2.201 → 1.2.205

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.205](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.204...@next-core/next-docs@1.2.205) (2022-02-15)
7
+
8
+ **Note:** Version bump only for package @next-core/next-docs
9
+
10
+
11
+
12
+
13
+
14
+ ## [1.2.204](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.203...@next-core/next-docs@1.2.204) (2022-02-15)
15
+
16
+ **Note:** Version bump only for package @next-core/next-docs
17
+
18
+
19
+
20
+
21
+
22
+ ## [1.2.203](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.202...@next-core/next-docs@1.2.203) (2022-02-14)
23
+
24
+ **Note:** Version bump only for package @next-core/next-docs
25
+
26
+
27
+
28
+
29
+
30
+ ## [1.2.202](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.201...@next-core/next-docs@1.2.202) (2022-02-14)
31
+
32
+ **Note:** Version bump only for package @next-core/next-docs
33
+
34
+
35
+
36
+
37
+
6
38
  ## [1.2.201](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.200...@next-core/next-docs@1.2.201) (2022-01-28)
7
39
 
8
40
  **Note:** Version bump only for package @next-core/next-docs
@@ -16,14 +16,14 @@ custom_edit_url: null
16
16
  **Signature:**
17
17
 
18
18
  ```typescript
19
- export declare function BrickAsComponent({ useBrick, data, parentRefForUseBrickInPortal, }: BrickAsComponentProps): React.ReactElement;
19
+ export declare function BrickAsComponent({ useBrick, data, }: BrickAsComponentProps): React.ReactElement;
20
20
  ```
21
21
 
22
22
  ## Parameters
23
23
 
24
24
  | Parameter | Type | Description |
25
25
  | --- | --- | --- |
26
- | { useBrick, data, parentRefForUseBrickInPortal, } | BrickAsComponentProps | |
26
+ | { useBrick, data, } | BrickAsComponentProps | |
27
27
 
28
28
  **Returns:**
29
29
 
@@ -42,7 +42,6 @@ React.ReactElement
42
42
  brick: "your.any-brick"
43
43
  }}
44
44
  data={yourData}
45
- parentRefForUseBrickInPortal={yourParentElementRef}
46
45
  />
47
46
  ```
48
47
 
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: brick-kit.dotransformoptions.__lazyforusebrick
3
+ title: DoTransformOptions.$$lazyForUseBrick
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; [DoTransformOptions](./brick-kit.dotransformoptions.md) &gt; [$$lazyForUseBrick](./brick-kit.dotransformoptions.__lazyforusebrick.md)
11
+
12
+ ## DoTransformOptions.$$lazyForUseBrick property
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ $$lazyForUseBrick?: boolean;
18
+ ```
19
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: brick-kit.dotransformoptions.__stateofusebrick
3
+ title: DoTransformOptions.$$stateOfUseBrick
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; [DoTransformOptions](./brick-kit.dotransformoptions.md) &gt; [$$stateOfUseBrick](./brick-kit.dotransformoptions.__stateofusebrick.md)
11
+
12
+ ## DoTransformOptions.$$stateOfUseBrick property
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ $$stateOfUseBrick?: StateOfUseBrick;
18
+ ```
19
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: brick-kit.dotransformoptions.allowinject
3
+ title: DoTransformOptions.allowInject
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; [DoTransformOptions](./brick-kit.dotransformoptions.md) &gt; [allowInject](./brick-kit.dotransformoptions.allowinject.md)
11
+
12
+ ## DoTransformOptions.allowInject property
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ allowInject?: boolean;
18
+ ```
19
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: brick-kit.dotransformoptions.evaluateoptions
3
+ title: DoTransformOptions.evaluateOptions
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; [DoTransformOptions](./brick-kit.dotransformoptions.md) &gt; [evaluateOptions](./brick-kit.dotransformoptions.evaluateoptions.md)
11
+
12
+ ## DoTransformOptions.evaluateOptions property
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ evaluateOptions?: EvaluateOptions;
18
+ ```
19
+
@@ -0,0 +1,30 @@
1
+ ---
2
+ id: brick-kit.dotransformoptions
3
+ title: DoTransformOptions
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; [DoTransformOptions](./brick-kit.dotransformoptions.md)
11
+
12
+ ## DoTransformOptions interface
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ export interface DoTransformOptions
18
+ ```
19
+
20
+ ## Properties
21
+
22
+ | Property | Type | Description |
23
+ | --- | --- | --- |
24
+ | [$$lazyForUseBrick](./brick-kit.dotransformoptions.__lazyforusebrick.md) | boolean | |
25
+ | [$$stateOfUseBrick](./brick-kit.dotransformoptions.__stateofusebrick.md) | StateOfUseBrick | |
26
+ | [allowInject](./brick-kit.dotransformoptions.allowinject.md) | boolean | |
27
+ | [evaluateOptions](./brick-kit.dotransformoptions.evaluateoptions.md) | EvaluateOptions | |
28
+ | [tplContextId](./brick-kit.dotransformoptions.tplcontextid.md) | string | |
29
+ | [trackingContextList](./brick-kit.dotransformoptions.trackingcontextlist.md) | TrackingContextItem\[\] | |
30
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: brick-kit.dotransformoptions.tplcontextid
3
+ title: DoTransformOptions.tplContextId
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; [DoTransformOptions](./brick-kit.dotransformoptions.md) &gt; [tplContextId](./brick-kit.dotransformoptions.tplcontextid.md)
11
+
12
+ ## DoTransformOptions.tplContextId property
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ tplContextId?: string;
18
+ ```
19
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ id: brick-kit.dotransformoptions.trackingcontextlist
3
+ title: DoTransformOptions.trackingContextList
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; [DoTransformOptions](./brick-kit.dotransformoptions.md) &gt; [trackingContextList](./brick-kit.dotransformoptions.trackingcontextlist.md)
11
+
12
+ ## DoTransformOptions.trackingContextList property
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ trackingContextList?: TrackingContextItem[];
18
+ ```
19
+
@@ -16,10 +16,7 @@ custom_edit_url: null
16
16
  **Signature:**
17
17
 
18
18
  ```typescript
19
- export declare function looseCheckIfByTransform(ifContainer: IfContainer, data: unknown, options?: {
20
- allowInject?: boolean;
21
- getTplVariables?: () => Record<string, unknown>;
22
- }): boolean;
19
+ export declare function looseCheckIfByTransform(ifContainer: IfContainer, data: unknown, options?: Pick<DoTransformOptions, "allowInject" | "tplContextId">): boolean;
23
20
  ```
24
21
 
25
22
  ## Parameters
@@ -28,7 +25,7 @@ export declare function looseCheckIfByTransform(ifContainer: IfContainer, data:
28
25
  | --- | --- | --- |
29
26
  | ifContainer | [IfContainer](./brick-kit.ifcontainer.md) | 包含 <code>if</code> 条件判断的配置对象。 |
30
27
  | data | unknown | 要传递的数据源。 |
31
- | options | { allowInject?: boolean; getTplVariables?: () =&gt; Record&lt;string, unknown&gt;; } | <code>allowInject</code> 允许在 <code>if</code> 中使用 <code>${...}</code> 占位符。 |
28
+ | options | Pick&lt;[DoTransformOptions](./brick-kit.dotransformoptions.md)<!-- -->, "allowInject" \| "tplContextId"&gt; | <code>allowInject</code> 允许在 <code>if</code> 中使用 <code>${...}</code> 占位符。 |
32
29
 
33
30
  **Returns:**
34
31
 
package/dist/brick-kit.md CHANGED
@@ -52,6 +52,7 @@ The core kit of Brick Next.
52
52
  | Interface | Description |
53
53
  | --- | --- |
54
54
  | [AbstractRuntime](./brick-kit.abstractruntime.md) | 系统运行时对象(抽象类型)。 |
55
+ | [DoTransformOptions](./brick-kit.dotransformoptions.md) | |
55
56
  | [EasyopsEmptyProps](./brick-kit.easyopsemptyprops.md) | |
56
57
  | [EventDeclaration](./brick-kit.eventdeclaration.md) | 构件事件的选项。 |
57
58
  | [EventEmitter](./brick-kit.eventemitter.md) | 事件发送器 |
@@ -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" | "theme.setTheme" | "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" | "state.update" | "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" \| "theme.setTheme" \| "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" \| "state.update" \| "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 | 根据条件决定是否执行该动作。 |
@@ -26,4 +26,5 @@ export interface CustomTemplate
26
26
  | [bricks](./brick-types.customtemplate.bricks.md) | [BrickConfInTemplate](./brick-types.brickconfintemplate.md)<!-- -->\[\] | 自定义模板渲染的构件配置列表。 |
27
27
  | [name](./brick-types.customtemplate.name.md) | string | 自定义模板的名称。 |
28
28
  | [proxy](./brick-types.customtemplate.proxy.md) | [CustomTemplateProxy](./brick-types.customtemplateproxy.md) | 自定义模板的代理配置。 |
29
+ | [state](./brick-types.customtemplate.state.md) | [CustomTemplateState](./brick-types.customtemplatestate.md)<!-- -->\[\] | 状态数据配置列表。 |
29
30
 
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: brick-types.customtemplate.state
3
+ title: CustomTemplate.state
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; [CustomTemplate](./brick-types.customtemplate.md) &gt; [state](./brick-types.customtemplate.state.md)
11
+
12
+ ## CustomTemplate.state property
13
+
14
+ 状态数据配置列表。
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ state?: CustomTemplateState[];
20
+ ```
21
+
22
+ **Reference:** [CustomTemplateState](./brick-types.customtemplatestate.md)
23
+
@@ -0,0 +1,23 @@
1
+ ---
2
+ id: brick-types.customtemplatestate
3
+ title: CustomTemplateState
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; [CustomTemplateState](./brick-types.customtemplatestate.md)
11
+
12
+ ## CustomTemplateState interface
13
+
14
+ 自定义模板状态数据配置。
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ export declare type CustomTemplateState = Pick<ContextConf, "name" | "value" | "if" | "resolve">;
20
+ ```
21
+
22
+ **Reference:** [ContextConf](./brick-types.contextconf.md)
23
+
@@ -63,6 +63,7 @@ The core types of Brick Next.
63
63
  | [CustomTemplateProxyTransformableProperty](./brick-types.customtemplateproxytransformableproperty.md) | 自定义模板的可转换的属性代理配置。 |
64
64
  | [CustomTemplateProxyVariableProperty](./brick-types.customtemplateproxyvariableproperty.md) | 自定义模板的当作变量供内部构件引用的属性代理配置。 |
65
65
  | [CustomTemplateProxyWithExtra](./brick-types.customtemplateproxywithextra.md) | |
66
+ | [CustomTemplateState](./brick-types.customtemplatestate.md) | 自定义模板状态数据配置。 |
66
67
  | [DefineResolveConf](./brick-types.defineresolveconf.md) | 预定义的异步数据处理配置。 |
67
68
  | [EasyopsIcon](./brick-types.easyopsicon.md) | EasyOps 图标配置。 |
68
69
  | [EntityResolveConf](./brick-types.entityresolveconf.md) | 实体类的异步数据处理配置。 |
@@ -27,7 +27,6 @@ export interface PluginRuntimeContext
27
27
  | [app](./brick-types.pluginruntimecontext.app.md) | [MicroApp](./brick-types.microapp.md) | 当前的应用信息。 |
28
28
  | [event](./brick-types.pluginruntimecontext.event.md) | CustomEvent | 当前的在事件处理中的事件对象。 |
29
29
  | [flags](./brick-types.pluginruntimecontext.flags.md) | [FeatureFlags](./brick-types.featureflags.md) | 特性开关字典。 |
30
- | [getTplVariables](./brick-types.pluginruntimecontext.gettplvariables.md) | () =&gt; Record&lt;string, unknown&gt; | |
31
30
  | [hash](./brick-types.pluginruntimecontext.hash.md) | string | 当前的 hash 参数 |
32
31
  | [overrideApp](./brick-types.pluginruntimecontext.overrideapp.md) | [MicroApp](./brick-types.microapp.md) | 用于跨应用菜单注入等场景的应用重载。 |
33
32
  | [query](./brick-types.pluginruntimecontext.query.md) | URLSearchParams | 当前的 query 参数。 |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@next-core/next-docs",
3
- "version": "1.2.201",
3
+ "version": "1.2.205",
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.103.9",
25
- "@next-core/brick-types": "^2.56.1",
24
+ "@next-core/brick-kit": "^2.104.3",
25
+ "@next-core/brick-types": "^2.57.0",
26
26
  "fs-extra": "^10.0.0"
27
27
  },
28
- "gitHead": "c3eb2892421b026471fb2b49b1fe0972ae8413d6"
28
+ "gitHead": "d7d9d0f691f649a1f92c97593d4de50e0446a652"
29
29
  }
@@ -1,19 +0,0 @@
1
- ---
2
- id: brick-types.pluginruntimecontext.gettplvariables
3
- title: PluginRuntimeContext.getTplVariables
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; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [getTplVariables](./brick-types.pluginruntimecontext.gettplvariables.md)
11
-
12
- ## PluginRuntimeContext.getTplVariables property
13
-
14
- **Signature:**
15
-
16
- ```typescript
17
- getTplVariables?: () => Record<string, unknown>;
18
- ```
19
-