[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/js/dist/ -> keyboard-shortcuts.js (summary)

(no description)

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

Defines 31 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  _arrayWithoutHoles()
  _nonIterableSpread()
  _toConsumableArray()
  _iterableToArrayLimit()
  _slicedToArray()
  _iterableToArray()
  _arrayWithHoles()
  _nonIterableRest()
  arrayOf()
  isObjectLike()
  createCache()
  isShallowEqual()
  getRootCache()
  getWeakMapCache()
  clear()
  callSelector()
  ownKeys()
  _objectSpread()
  reducer()
  registerShortcut()
  unregisterShortcut()
  getKeyCombinationRepresentation()
  getShortcutKeyCombination()
  getShortcutRepresentation()
  getShortcutDescription()
  getShortcutAliases()
  useShortcut()
  _defineProperty()

Functions
Functions that are not part of a class:

__webpack_require__(moduleId)   X-Ref
No description

getDefault()   X-Ref
No description

getModuleExports()   X-Ref
No description

_arrayWithoutHoles(arr)   X-Ref
No description

_nonIterableSpread()   X-Ref
No description

_toConsumableArray(arr)   X-Ref
No description

_iterableToArrayLimit(arr, i)   X-Ref
No description

_slicedToArray(arr, i)   X-Ref
No description

_iterableToArray(iter)   X-Ref
No description

_arrayWithHoles(arr)   X-Ref
No description

_nonIterableRest()   X-Ref
No description

arrayOf( value )   X-Ref
Returns the first argument as the sole entry in an array.

param: {*} value Value to return.
return: {Array} Value returned as entry in array.

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.

param: {*} value Value to test.
return: {boolean} Whether value is object-like.

createCache()   X-Ref
Creates and returns a new cache object.

return: {Object} 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.

param: {Array}  a         First array.
param: {Array}  b         Second array.
param: {number} fromIndex Index from which to start comparison.
return: {boolean} Whether arrays are shallowly equal.

getRootCache()   X-Ref
Returns the root cache. If WeakMap is supported, this is assigned to the
root WeakMap cache set, otherwise it is a shared instance of the default
cache object.

return: {(WeakMap|Object)} Root cache object.

getWeakMapCache( 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.

param: {Array} dependants Selector dependants.
return: {Object} Cache object.

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.

param: {Object} source    Source object for derivation.
param: {...*}   extraArgs Additional arguments to pass to selector.
return: {*} Selector result.

ownKeys(object, enumerableOnly)   X-Ref
No description

_objectSpread(target)   X-Ref
No description

reducer()   X-Ref
Reducer returning the registered shortcuts

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

registerShortcut(_ref)   X-Ref
Returns an action object used to register a new keyboard shortcut.

param: {WPShortcutConfig} config Shortcut config.
return: {Object} action.

unregisterShortcut(name)   X-Ref
Returns an action object used to unregister a keyboard shortcut.

param: {string} name Shortcut name.
return: {Object} action.

getKeyCombinationRepresentation(shortcut, representation)   X-Ref
Returns a string representing the key combination.

param: {?WPShortcutKeyCombination} shortcut       Key combination.
param: {keyof FORMATTING_METHODS}  representation Type of representation
return: {string?} Shortcut representation.

getShortcutKeyCombination(state, name)   X-Ref
Returns the main key combination for a given shortcut name.

param: {Object} state Global state.
param: {string} name  Shortcut name.
return: {WPShortcutKeyCombination?} Key combination.

getShortcutRepresentation(state, name)   X-Ref
Returns a string representing the main key combination for a given shortcut name.

param: {Object}                   state          Global state.
param: {string}                   name           Shortcut name.
param: {keyof FORMATTING_METHODS} representation Type of representation
return: {string?} Shortcut representation.

getShortcutDescription(state, name)   X-Ref
Returns the shortcut description given its name.

param: {Object} state Global state.
param: {string} name  Shortcut name.
return: {string?} Shortcut description.

getShortcutAliases(state, name)   X-Ref
Returns the aliases for a given shortcut name.

param: {Object} state Global state.
param: {string} name  Shortcut name.
return: {WPShortcutKeyCombination[]} Key combinations.

useShortcut(name, callback, options)   X-Ref
Attach a keyboard shortcut handler.

param: {string} name       Shortcut name.
param: {Function} callback Shortcut callback.
param: {Object} options    Shortcut options.

_defineProperty(obj, key, value)   X-Ref
No description



Generated : Sun May 24 08:20:01 2020 Cross-referenced by PHPXref