| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
WordPress dependencies
| File Size: | 746 lines (21 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| 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. |
| arrayOf(value) X-Ref |
| Returns the first argument as the sole entry in an array. return: {[T]} Value returned as entry in array. param: {T} value Value to return. |
| isObjectLike(value) X-Ref |
| Returns true if the value passed is object-like, or false otherwise. A value is object-like if it can support property assignment, e.g. object or array. return: {boolean} Whether value is object-like. param: {*} value Value to test. |
| createCache() X-Ref |
| Creates and returns a new cache object. return: {Cache} Cache object. |
| isShallowEqual(a, b, fromIndex) X-Ref |
| Returns true if entries within the two arrays are strictly equal by reference from a starting index. return: {boolean} Whether arrays are shallowly equal. param: {*[]} a First array. param: {*[]} b Second array. param: {number} fromIndex Index from which to start comparison. |
| rememo(selector, getDependants) X-Ref |
| Returns a memoized selector function. The getDependants function argument is called before the memoized selector and is expected to return an immutable reference or array of references on which the selector depends for computing its own return value. The memoize cache is preserved only as long as those dependant references remain the same. If getDependants returns a different reference(s), the cache is cleared and the selector value regenerated. param: {S} selector Selector function. param: {GetDependants=} getDependants Dependant getter returning an array of |
| getCache(dependants) X-Ref |
| Returns the cache for a given dependants array. When possible, a WeakMap will be used to create a unique cache for each set of dependants. This is feasible due to the nature of WeakMap in allowing garbage collection to occur on entries where the key object is no longer referenced. Since WeakMap requires the key to be an object, this is only possible when the dependant is object-like. The root cache is created as a hierarchy where each top-level key is the first entry in a dependants set, the value a WeakMap where each key is the next dependant, and so on. This continues so long as the dependants are object-like. If no dependants are object- like, then the cache is shared across all invocations. return: {Cache} Cache object. param: {*[]} dependants Selector dependants. |
| clear() X-Ref |
| Resets root memoization cache. |
| callSelector() X-Ref |
| The augmented selector call, considering first whether dependants have changed before passing it to underlying memoize function. return: {*} Selector result. param: {*} source Source object for derivation. param: {...*} extraArgs Additional arguments to pass to selector. |
| 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 |
| Internal dependencies |
| DotTip({position = 'middle right',children,isVisible,hasNextTip,onDismiss,onDisable}) X-Ref |
| No description |
| Generated : Fri Apr 26 08:20:02 2024 | Cross-referenced by PHPXref |