@next-core/next-docs 1.2.307 → 1.2.308
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 +8 -0
- package/dist/brick-types.builtinbrickeventhandler.action.md +1 -1
- package/dist/brick-types.builtinbrickeventhandler.md +1 -1
- package/dist/brick-types.contextconf.md +2 -1
- package/dist/brick-types.contextconf.resolve.md +2 -2
- package/dist/brick-types.contextconf.track.md +21 -0
- package/dist/brick-types.contextresolveconf.md +25 -0
- package/dist/brick-types.customtemplatestate.md +1 -1
- package/dist/brick-types.md +1 -0
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
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.308](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.307...@next-core/next-docs@1.2.308) (2022-08-25)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @next-core/next-docs
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
## [1.2.307](https://github.com/easyops-cn/next-core/compare/@next-core/next-docs@1.2.306...@next-core/next-docs@1.2.307) (2022-08-23)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @next-core/next-docs
|
|
@@ -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" | "state.update" | "tpl.dispatchEvent" | "message.subscribe" | "message.unsubscribe" | "theme.setDarkTheme" | "theme.setLightTheme" | "theme.setTheme" | "mode.setDashboardMode" | "mode.setDefaultMode" | "menu.clearMenuTitleCache" | "menu.clearMenuCache" | "preview.debug" | "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" | "context.refresh" | "state.update" | "state.refresh" | "tpl.dispatchEvent" | "message.subscribe" | "message.unsubscribe" | "theme.setDarkTheme" | "theme.setLightTheme" | "theme.setTheme" | "mode.setDashboardMode" | "mode.setDefaultMode" | "menu.clearMenuTitleCache" | "menu.clearMenuCache" | "preview.debug" | "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" \| "state.update" \| "tpl.dispatchEvent" \| "message.subscribe" \| "message.unsubscribe" \| "theme.setDarkTheme" \| "theme.setLightTheme" \| "theme.setTheme" \| "mode.setDashboardMode" \| "mode.setDefaultMode" \| "menu.clearMenuTitleCache" \| "menu.clearMenuCache" \| "preview.debug" \| "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" \| "context.refresh" \| "state.update" \| "state.refresh" \| "tpl.dispatchEvent" \| "message.subscribe" \| "message.unsubscribe" \| "theme.setDarkTheme" \| "theme.setLightTheme" \| "theme.setTheme" \| "mode.setDashboardMode" \| "mode.setDefaultMode" \| "menu.clearMenuTitleCache" \| "menu.clearMenuCache" \| "preview.debug" \| "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 | 根据条件决定是否执行该动作。 |
|
|
@@ -72,6 +72,7 @@ bricks:
|
|
|
72
72
|
| [name](./brick-types.contextconf.name.md) | string | 上下文(数据)名称。 |
|
|
73
73
|
| [onChange](./brick-types.contextconf.onchange.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 当数据发生变化时触发的事件。注意,该事件仅适用于自由变量或异步处理的数据,不适用于绑定构件属性的数据。 |
|
|
74
74
|
| [property](./brick-types.contextconf.property.md) | string | 要绑定的构件属性名。 |
|
|
75
|
-
| [resolve](./brick-types.contextconf.resolve.md) | [
|
|
75
|
+
| [resolve](./brick-types.contextconf.resolve.md) | [ContextResolveConf](./brick-types.contextresolveconf.md) | 异步处理配置。如需 transform,将使用转换后的结果的 <code>value</code> 字段作为值。 |
|
|
76
|
+
| [track](./brick-types.contextconf.track.md) | boolean | 是否自动跟踪自己依赖的上下文数据,当它们变化时自动计算获得新的值。 |
|
|
76
77
|
| [value](./brick-types.contextconf.value.md) | unknown | 自由变量类型的上下文的值。 |
|
|
77
78
|
|
|
@@ -16,8 +16,8 @@ custom_edit_url: null
|
|
|
16
16
|
**Signature:**
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
resolve?:
|
|
19
|
+
resolve?: ContextResolveConf;
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
**Reference:** [
|
|
22
|
+
**Reference:** [ContextResolveConf](./brick-types.contextresolveconf.md)
|
|
23
23
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.contextconf.track
|
|
3
|
+
title: ContextConf.track
|
|
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) > [@next-core/brick-types](./brick-types.md) > [ContextConf](./brick-types.contextconf.md) > [track](./brick-types.contextconf.track.md)
|
|
11
|
+
|
|
12
|
+
## ContextConf.track property
|
|
13
|
+
|
|
14
|
+
是否自动跟踪自己依赖的上下文数据,当它们变化时自动计算获得新的值。
|
|
15
|
+
|
|
16
|
+
**Signature:**
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
track?: boolean;
|
|
20
|
+
```
|
|
21
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: brick-types.contextresolveconf
|
|
3
|
+
title: ContextResolveConf
|
|
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) > [@next-core/brick-types](./brick-types.md) > [ContextResolveConf](./brick-types.contextresolveconf.md)
|
|
11
|
+
|
|
12
|
+
## ContextResolveConf interface
|
|
13
|
+
|
|
14
|
+
用于 Context 的异步数据处理配置。
|
|
15
|
+
|
|
16
|
+
**Signature:**
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
export declare type ContextResolveConf = ResolveConf & {
|
|
20
|
+
lazy?: boolean;
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**Reference:** [ResolveConf](./brick-types.resolveconf.md)
|
|
25
|
+
|
|
@@ -16,7 +16,7 @@ custom_edit_url: null
|
|
|
16
16
|
**Signature:**
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
|
-
export declare type CustomTemplateState = Pick<ContextConf, "name" | "value" | "if" | "resolve">;
|
|
19
|
+
export declare type CustomTemplateState = Pick<ContextConf, "name" | "value" | "if" | "resolve" | "track">;
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
**Reference:** [ContextConf](./brick-types.contextconf.md)
|
package/dist/brick-types.md
CHANGED
|
@@ -41,6 +41,7 @@ The core types of Brick Next.
|
|
|
41
41
|
| [BrickMenuConf](./brick-types.brickmenuconf.md) | 使用构件做数据代理的菜单配置。 |
|
|
42
42
|
| [BuiltinBrickEventHandler](./brick-types.builtinbrickeventhandler.md) | 系统内置的事件处理器。 |
|
|
43
43
|
| [ContextConf](./brick-types.contextconf.md) | 上下文(数据)配置 |
|
|
44
|
+
| [ContextResolveConf](./brick-types.contextresolveconf.md) | 用于 Context 的异步数据处理配置。 |
|
|
44
45
|
| [Contract](./brick-types.contract.md) | |
|
|
45
46
|
| [ContractField](./brick-types.contractfield.md) | |
|
|
46
47
|
| [ContractFieldItem](./brick-types.contractfielditem.md) | |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@next-core/next-docs",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.308",
|
|
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.
|
|
25
|
-
"@next-core/brick-types": "^2.
|
|
24
|
+
"@next-core/brick-kit": "^2.131.0",
|
|
25
|
+
"@next-core/brick-types": "^2.69.0",
|
|
26
26
|
"fs-extra": "^10.1.0"
|
|
27
27
|
},
|
|
28
|
-
"gitHead": "
|
|
28
|
+
"gitHead": "d37fcd8629e2e832156dd5fee4dcd4bd0ac6b8e2"
|
|
29
29
|
}
|