93 lines
1.9 KiB
Markdown
93 lines
1.9 KiB
Markdown
|
# NUX（新用户体验）数据
|
|||
|
|
|
|||
|
|
命名空间：`core/nux`
|
|||
|
|
|
|||
|
|
## 选择器
|
|||
|
|
|
|||
|
|
<!-- START TOKEN(Autogenerated selectors|../../../packages/nux/src/store/selectors.js) -->
|
|||
|
|
|
|||
|
|
### areTipsEnabled
|
|||
|
|
|
|||
|
|
返回提示功能是否全局启用。
|
|||
|
|
|
|||
|
|
_参数_
|
|||
|
|
|
|||
|
|
- _state_ `Object`: 全局应用状态。
|
|||
|
|
|
|||
|
|
_返回值_
|
|||
|
|
|
|||
|
|
- `boolean`: 提示功能是否全局启用。
|
|||
|
|
|
|||
|
|
### getAssociatedGuide
|
|||
|
|
|
|||
|
|
返回描述给定提示所属引导（如果存在）的对象。
|
|||
|
|
|
|||
|
|
_参数_
|
|||
|
|
|
|||
|
|
- _state_ `Object`: 全局应用状态。
|
|||
|
|
- _tipId_ `string`: 要查询的提示。
|
|||
|
|
|
|||
|
|
_返回值_
|
|||
|
|
|
|||
|
|
- `?NUXGuideInfo`: 关联引导的信息。
|
|||
|
|
|
|||
|
|
### isTipVisible
|
|||
|
|
|
|||
|
|
判断指定提示是否正在显示。如果提示被禁用、已被关闭或不是所在引导中的当前提示，则不会显示。
|
|||
|
|
|
|||
|
|
_参数_
|
|||
|
|
|
|||
|
|
- _state_ `Object`: 全局应用状态。
|
|||
|
|
- _tipId_ `string`: 要查询的提示。
|
|||
|
|
|
|||
|
|
_返回值_
|
|||
|
|
|
|||
|
|
- `boolean`: 指定提示是否正在显示。
|
|||
|
|
|
|||
|
|
<!-- END TOKEN(Autogenerated selectors|../../../packages/nux/src/store/selectors.js) -->
|
|||
|
|
|
|||
|
|
## 操作
|
|||
|
|
|
|||
|
|
<!-- START TOKEN(Autogenerated actions|../../../packages/nux/src/store/actions.js) -->
|
|||
|
|
|
|||
|
|
### disableTips
|
|||
|
|
|
|||
|
|
返回一个操作对象，当被分发时，将阻止所有提示再次显示。
|
|||
|
|
|
|||
|
|
_返回值_
|
|||
|
|
|
|||
|
|
- `Object`: 操作对象。
|
|||
|
|
|
|||
|
|
### dismissTip
|
|||
|
|
|
|||
|
|
返回一个操作对象，当被分发时，将关闭指定提示。被关闭的提示将不再显示。
|
|||
|
|
|
|||
|
|
_参数_
|
|||
|
|
|
|||
|
|
- _id_ `string`: 要关闭的提示。
|
|||
|
|
|
|||
|
|
_返回值_
|
|||
|
|
|
|||
|
|
- `Object`: 操作对象。
|
|||
|
|
|
|||
|
|
### enableTips
|
|||
|
|
|
|||
|
|
返回一个操作对象，当被分发时，将重新启用所有提示显示。
|
|||
|
|
|
|||
|
|
_返回值_
|
|||
|
|
|
|||
|
|
- `Object`: 操作对象。
|
|||
|
|
|
|||
|
|
### triggerGuide
|
|||
|
|
|
|||
|
|
返回一个操作对象，当被分发时，将呈现一个引导，逐步引导用户完成一系列提示。
|
|||
|
|
|
|||
|
|
_参数_
|
|||
|
|
|
|||
|
|
- _tipIds_ `string[]`: 引导中要显示的提示列表。
|
|||
|
|
|
|||
|
|
_返回值_
|
|||
|
|
|
|||
|
|
- `Object`: 操作对象。
|
|||
|
|
|
|||
|
|
<!-- END TOKEN(Autogenerated actions|../../../packages/nux/src/store/actions.js) -->
|