[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/js/dist/ -> nux.js (summary)

WordPress dependencies

File Size: 458 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 11 functions

  guides()
  areTipsEnabled()
  dismissedTips()
  triggerGuide()
  dismissTip()
  disableTips()
  enableTips()
  isTipVisible()
  selectors_areTipsEnabled()
  onClick()
  DotTip()

Functions
Functions that are not part of a class:

guides(state = [], action)   X-Ref
Reducer that tracks which tips are in a guide. Each guide is represented by
an array which contains the tip identifiers contained within that guide.

return: {Array} Updated state.
param: {Array}  state  Current state.
param: {Object} action Dispatched action.

areTipsEnabled(state = true, action)   X-Ref
Reducer that tracks whether or not tips are globally enabled.

return: {boolean} Updated state.
param: {boolean} state  Current state.
param: {Object}  action Dispatched action.

dismissedTips(state = {}, action)   X-Ref
Reducer that tracks which tips have been dismissed. If the state object
contains a tip identifier, then that tip is dismissed.

return: {Object} Updated state.
param: {Object} state  Current state.
param: {Object} action Dispatched action.

triggerGuide(tipIds)   X-Ref
Returns an action object that, when dispatched, presents a guide that takes
the user through a series of tips step by step.

return: {Object} Action object.
param: {string[]} tipIds Which tips to show in the guide.

dismissTip(id)   X-Ref
Returns an action object that, when dispatched, dismisses the given tip. A
dismissed tip will not show again.

return: {Object} Action object.
param: {string} id The tip to dismiss.

disableTips()   X-Ref
Returns an action object that, when dispatched, prevents all tips from
showing again.

return: {Object} Action object.

enableTips()   X-Ref
Returns an action object that, when dispatched, makes all tips show again.

return: {Object} Action object.

isTipVisible(state, tipId)   X-Ref
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.

return: {boolean} Whether or not the given tip is showing.
param: {Object} state Global application state.
param: {string} tipId The tip to query.

selectors_areTipsEnabled(state)   X-Ref
Returns whether or not tips are globally enabled.

return: {boolean} Whether tips are globally enabled.
param: {Object} state Global application state.

onClick(event)   X-Ref
No description

DotTip({position = 'middle right',children,isVisible,hasNextTip,onDismiss,onDisable})   X-Ref
No description



Generated : Sun Dec 22 08:20:01 2024 Cross-referenced by PHPXref