-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'trunk' into enhancement/patterns-sticky-header
- Loading branch information
Showing
59 changed files
with
1,657 additions
and
680 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
# The NUX (New User Experience) Data | ||
|
||
Namespace: `core/nux`. | ||
|
||
## Selectors | ||
|
||
<!-- START TOKEN(Autogenerated selectors|../../../packages/nux/src/store/selectors.js) --> | ||
|
||
### areTipsEnabled | ||
|
||
Returns whether or not tips are globally enabled. | ||
|
||
_Parameters_ | ||
|
||
- _state_ `Object`: Global application state. | ||
|
||
_Returns_ | ||
|
||
- `boolean`: Whether tips are globally enabled. | ||
|
||
### getAssociatedGuide | ||
|
||
Returns an object describing the guide, if any, that the given tip is a part of. | ||
|
||
_Parameters_ | ||
|
||
- _state_ `Object`: Global application state. | ||
- _tipId_ `string`: The tip to query. | ||
|
||
_Returns_ | ||
|
||
- `?NUXGuideInfo`: Information about the associated guide. | ||
|
||
### isTipVisible | ||
|
||
Determines whether or not the given tip is showing. Tips are hidden if they are disabled, have been dismissed, or are not the current tip in any guide that they have been added to. | ||
|
||
_Parameters_ | ||
|
||
- _state_ `Object`: Global application state. | ||
- _tipId_ `string`: The tip to query. | ||
|
||
_Returns_ | ||
|
||
- `boolean`: Whether or not the given tip is showing. | ||
|
||
<!-- END TOKEN(Autogenerated selectors|../../../packages/nux/src/store/selectors.js) --> | ||
|
||
## Actions | ||
|
||
<!-- START TOKEN(Autogenerated actions|../../../packages/nux/src/store/actions.js) --> | ||
|
||
### disableTips | ||
|
||
Returns an action object that, when dispatched, prevents all tips from showing again. | ||
|
||
_Returns_ | ||
|
||
- `Object`: Action object. | ||
|
||
### dismissTip | ||
|
||
Returns an action object that, when dispatched, dismisses the given tip. A dismissed tip will not show again. | ||
|
||
_Parameters_ | ||
|
||
- _id_ `string`: The tip to dismiss. | ||
|
||
_Returns_ | ||
|
||
- `Object`: Action object. | ||
|
||
### enableTips | ||
|
||
Returns an action object that, when dispatched, makes all tips show again. | ||
|
||
_Returns_ | ||
|
||
- `Object`: Action object. | ||
|
||
### triggerGuide | ||
|
||
Returns an action object that, when dispatched, presents a guide that takes the user through a series of tips step by step. | ||
|
||
_Parameters_ | ||
|
||
- _tipIds_ `string[]`: Which tips to show in the guide. | ||
|
||
_Returns_ | ||
|
||
- `Object`: Action object. | ||
|
||
<!-- END TOKEN(Autogenerated actions|../../../packages/nux/src/store/actions.js) --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.