[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

(no description)

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

Defines 124 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  _iterableToArrayLimit()
  _slicedToArray()
  areInputsEqual()
  useMemoOne()
  useCallbackOne()
  _arrayWithoutHoles()
  _nonIterableSpread()
  _toConsumableArray()
  _assertThisInitialized()
  _typeof()
  _classCallCheck()
  _defineProperties()
  _createClass()
  ClipboardAction()
  clipboard_typeof()
  clipboard_classCallCheck()
  clipboard_defineProperties()
  clipboard_createClass()
  _inherits()
  _setPrototypeOf()
  _createSuper()
  _possibleConstructorReturn()
  _assertThisInitialized()
  _isNativeReflectConstruct()
  _getPrototypeOf()
  getAttributeValue()
  Clipboard()
  closest()
  _delegate()
  delegate()
  listener()
  listen()
  listenNode()
  listenNodeList()
  listenSelector()
  select()
  E()
  listener()
  __webpack_require__()
  _getPrototypeOf()
  _arrayLikeToArray()
  _classCallCheck()
  _defineProperties()
  _createClass()
  _unsupportedIterableToArray()
  _addEvent()
  _characterFromEvent()
  _modifiersMatch()
  _eventModifiers()
  _preventDefault()
  _stopPropagation()
  _isModifier()
  _getReverseMap()
  _pickBestAction()
  _keysFromString()
  _getKeyInfo()
  _belongsTo()
  Mousetrap()
  _resetSequences()
  _getMatches()
  _fireCallback()
  _handleKeyEvent()
  _resetSequenceTimer()
  _bindSequence()
  _increaseSequence()
  _callbackAndReset()
  _bindSingle()
  _inherits()
  _possibleConstructorReturn()
  _arrayWithHoles()
  _nonIterableRest()
  _iterableToArray()
  createHigherOrderComponent()
  _createSuper()
  _isNativeReflectConstruct()
  _class()
  _class2()
  Listener()
  with_global_events_createSuper()
  with_global_events_isNativeReflectConstruct()
  withGlobalEvents()
  Wrapper()
  createId()
  useInstanceId()
  with_safe_timeout_createSuper()
  with_safe_timeout_isNativeReflectConstruct()
  WrappedComponent()
  setTimeout()
  clearTimeout()
  with_state_createSuper()
  with_state_isNativeReflectConstruct()
  withState()
  WrappedComponent()
  useConstrainedTabbing()
  useCopyOnClick()
  useRefEffect()
  useUpdatedRef()
  useCopyToClipboard()
  useFocusOnMount()
  useFocusReturn()
  isFocusNormalizedButton()
  useFocusOutside()
  useMergeRefs()
  ownKeys()
  _objectSpread()
  useDialog()
  useDragging()
  isAppleOS()
  useKeyboardShortcut()
  useMediaQuery()
  usePrevious()
  getFirstItemsPresentInState()
  listReducer()
  useAsyncList()
  useWarnOnChange()
  useDebounce()
  useThrottle()
  _defineProperty()
  _setPrototypeOf()
  _typeof()
  _extends()

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

_iterableToArrayLimit(arr, i)   X-Ref
No description

_slicedToArray(arr, i)   X-Ref
No description

areInputsEqual(newInputs, lastInputs)   X-Ref
No description

useMemoOne(getResult, inputs)   X-Ref
No description

useCallbackOne(callback, inputs)   X-Ref
No description

_arrayWithoutHoles(arr)   X-Ref
No description

_nonIterableSpread()   X-Ref
No description

_toConsumableArray(arr)   X-Ref
No description

_assertThisInitialized(self)   X-Ref
No description

_typeof(obj)   X-Ref
No description

_classCallCheck(instance, Constructor)   X-Ref
No description

_defineProperties(target, props)   X-Ref
No description

_createClass(Constructor, protoProps, staticProps)   X-Ref
No description

ClipboardAction(options)   X-Ref

param: {Object} options

clipboard_typeof(obj)   X-Ref
No description

clipboard_classCallCheck(instance, Constructor)   X-Ref
No description

clipboard_defineProperties(target, props)   X-Ref
No description

clipboard_createClass(Constructor, protoProps, staticProps)   X-Ref
No description

_inherits(subClass, superClass)   X-Ref
No description

_setPrototypeOf(o, p)   X-Ref
No description

_createSuper(Derived)   X-Ref
No description

_possibleConstructorReturn(self, call)   X-Ref
No description

_assertThisInitialized(self)   X-Ref
No description

_isNativeReflectConstruct()   X-Ref
No description

_getPrototypeOf(o)   X-Ref
No description

getAttributeValue(suffix, element)   X-Ref
Helper function to retrieve attribute value.

param: {String} suffix
param: {Element} element

Clipboard(trigger, options)   X-Ref

param: {String|HTMLElement|HTMLCollection|NodeList} trigger
param: {Object} options

closest(element, selector)   X-Ref
Finds the closest parent that matches a selector.

param: {Element} element
param: {String} selector
return: {Function}

_delegate(element, selector, type, callback, useCapture)   X-Ref
Delegates event to a selector.

param: {Element} element
param: {String} selector
param: {String} type
param: {Function} callback
param: {Boolean} useCapture
return: {Object}

delegate(elements, selector, type, callback, useCapture)   X-Ref
Delegates event to a selector.

param: {Element|String|Array} [elements]
param: {String} selector
param: {String} type
param: {Function} callback
param: {Boolean} useCapture
return: {Object}

listener(element, selector, type, callback)   X-Ref
Finds closest match and invokes callback.

param: {Element} element
param: {String} selector
param: {String} type
param: {Function} callback
return: {Function}

listen(target, type, callback)   X-Ref
Validates all params and calls the right
listener function based on its target type.

param: {String|HTMLElement|HTMLCollection|NodeList} target
param: {String} type
param: {Function} callback
return: {Object}

listenNode(node, type, callback)   X-Ref
Adds an event listener to a HTML element
and returns a remove listener function.

param: {HTMLElement} node
param: {String} type
param: {Function} callback
return: {Object}

listenNodeList(nodeList, type, callback)   X-Ref
Add an event listener to a list of HTML elements
and returns a remove listener function.

param: {NodeList|HTMLCollection} nodeList
param: {String} type
param: {Function} callback
return: {Object}

listenSelector(selector, type, callback)   X-Ref
Add an event listener to a selector
and returns a remove listener function.

param: {String} selector
param: {String} type
param: {Function} callback
return: {Object}

select(element)   X-Ref
No description

E()   X-Ref
No description

listener()   X-Ref
No description

__webpack_require__(moduleId)   X-Ref
No description

_getPrototypeOf(o)   X-Ref
No description

_arrayLikeToArray(arr, len)   X-Ref
No description

_classCallCheck(instance, Constructor)   X-Ref
No description

_defineProperties(target, props)   X-Ref
No description

_createClass(Constructor, protoProps, staticProps)   X-Ref
No description

_unsupportedIterableToArray(o, minLen)   X-Ref
No description

_addEvent(object, type, callback)   X-Ref
cross browser add event method

returns: void
param: {Element|HTMLDocument} object
param: {string} type
param: {Function} callback

_characterFromEvent(e)   X-Ref
takes the event and returns the key character

param: {Event} e
return: {string}

_modifiersMatch(modifiers1, modifiers2)   X-Ref
checks if two arrays are equal

returns: {boolean}
param: {Array} modifiers1
param: {Array} modifiers2

_eventModifiers(e)   X-Ref
takes a key event and figures out what the modifiers are

returns: {Array}
param: {Event} e

_preventDefault(e)   X-Ref
prevents default for this event

returns: void
param: {Event} e

_stopPropagation(e)   X-Ref
stops propogation for this event

returns: void
param: {Event} e

_isModifier(key)   X-Ref
determines if the keycode specified is a modifier key or not

returns: {boolean}
param: {string} key

_getReverseMap()   X-Ref
reverses the map lookup so that we can look for specific keys
to see what can and can't use keypress

return: {Object}

_pickBestAction(key, modifiers, action)   X-Ref
picks the best action based on the key combination

param: {string} key - character for key
param: {Array} modifiers
param: {string=} action passed in

_keysFromString(combination)   X-Ref
Converts from a string key combination to an array

param: {string} combination like "command+shift+l"
return: {Array}

_getKeyInfo(combination, action)   X-Ref
Gets info for a specific key combination

returns: {Object}
param: {string} combination key combination ("command+s" or "a" or "*")
param: {string=} action

_belongsTo(element, ancestor)   X-Ref
No description

Mousetrap(targetElement)   X-Ref
No description

_resetSequences(doNotReset)   X-Ref
resets all sequence counters except for the ones passed in

returns: void
param: {Object} doNotReset

_getMatches(character, modifiers, e, sequenceName, combination, level)   X-Ref
finds all callbacks that match based on the keycode, modifiers,
and action

returns: {Array}
param: {string} character
param: {Array} modifiers
param: {Event|Object} e
param: {string=} sequenceName - name of the sequence we are looking for
param: {string=} combination
param: {number=} level

_fireCallback(callback, e, combo, sequence)   X-Ref
actually calls the callback function

if your callback function returns false this will use the jquery
convention - prevent default and stop propogation on the event

returns: void
param: {Function} callback
param: {Event} e

_handleKeyEvent(e)   X-Ref
handles a keydown event

returns: void
param: {Event} e

_resetSequenceTimer()   X-Ref
called to set a 1 second timeout on the specified sequence

this is so after each key press in the sequence you have 1 second
to press the next key before you have to start over

returns: void

_bindSequence(combo, keys, callback, action)   X-Ref
binds a key sequence to an event

returns: void
param: {string} combo - combo specified in bind call
param: {Array} keys
param: {Function} callback
param: {string=} action

_increaseSequence(nextAction)   X-Ref
callback to increase the sequence level for this sequence and reset
all other sequences that were active

returns: {Function}
param: {string} nextAction

_callbackAndReset(e)   X-Ref
wraps the specified callback inside of another function in order
to reset all sequence counters as soon as this sequence is done

returns: void
param: {Event} e

_bindSingle(combination, callback, action, sequenceName, level)   X-Ref
binds a single keyboard combination

returns: void
param: {string} combination
param: {Function} callback
param: {string=} action
param: {string=} sequenceName - name of sequence if part of sequence
param: {number=} level - what part of the sequence the command is

_inherits(subClass, superClass)   X-Ref
No description

_possibleConstructorReturn(self, call)   X-Ref
No description

_arrayWithHoles(arr)   X-Ref
No description

_nonIterableRest()   X-Ref
No description

_iterableToArray(iter)   X-Ref
No description

createHigherOrderComponent(mapComponentToEnhancedComponent, modifierName)   X-Ref
Given a function mapping a component to an enhanced component and modifier
name, returns the enhanced component augmented with a generated displayName.

param: {Function} mapComponentToEnhancedComponent Function mapping component
param: {string}   modifierName                    Seed name from which to
return: {WPComponent} Component class with generated display name assigned.

_createSuper(Derived)   X-Ref
No description

_isNativeReflectConstruct()   X-Ref
No description

_class()   X-Ref
No description

_class2()   X-Ref
No description

Listener()   X-Ref
Class responsible for orchestrating event handling on the global window,
binding a single event to be shared across all handling instances, and
removing the handler when no instances are listening for the event.


with_global_events_createSuper(Derived)   X-Ref
No description

with_global_events_isNativeReflectConstruct()   X-Ref
No description

withGlobalEvents(eventTypesToHandlers)   X-Ref
Higher-order component creator which, given an object of DOM event types and
values corresponding to a callback function name on the component, will
create or update a window event handler to invoke the callback when an event
occurs. On behalf of the consuming developer, the higher-order component
manages unbinding when the component unmounts, and binding at most a single
event handler for the entire application.

param: {Object<string,string>} eventTypesToHandlers Object with keys of DOM
return: {Function} Higher-order component.

Wrapper()   X-Ref
No description

createId(object)   X-Ref
Creates a new id for a given object.

param: {unknown} object Object reference to create an id for.
return: {number} The instance id (index).

useInstanceId(object, prefix)   X-Ref
Provides a unique instance ID.

param: {Object} object Object reference to create an id for.
param: {string} prefix Prefix for the unique id.
param: {string} preferredId Default ID to use.
return: {string | number} The unique instance id.

with_safe_timeout_createSuper(Derived)   X-Ref
No description

with_safe_timeout_isNativeReflectConstruct()   X-Ref
No description

WrappedComponent()   X-Ref
No description

setTimeout(_x, _x2)   X-Ref
No description

clearTimeout(_x3)   X-Ref
No description

with_state_createSuper(Derived)   X-Ref
No description

with_state_isNativeReflectConstruct()   X-Ref
No description

withState()   X-Ref
A Higher Order Component used to provide and manage internal component state
via props.

param: {?Object} initialState Optional initial state of the component.
return: {WPComponent} Wrapped component.

WrappedComponent()   X-Ref
No description

useConstrainedTabbing()   X-Ref
In Dialogs/modals, the tabbing must be constrained to the content of
the wrapper element. This hook adds the behavior to the returned ref.

return: {Object|Function} Element Ref.

useCopyOnClick(ref, _text)   X-Ref
Copies the text to the clipboard when the element is clicked.

param: {Object}          ref     Reference with the element.
param: {string|Function} text    The text to copy.
param: {number}          timeout Optional timeout to reset the returned
return: {boolean} Whether or not the text has been copied. Resets after the

useRefEffect(calllback, dependencies)   X-Ref
Effect-like ref callback. Just like with `useEffect`, this allows you to
return a cleanup function to be run if the ref changes or one of the
dependencies changes. The ref is provided as an argument to the callback
functions. The main difference between this and `useEffect` is that
the `useEffect` callback is not called when the ref changes, but this is.
Pass the returned ref callback as the component's ref and merge multiple refs
with `useMergeRefs`.

It's worth noting that if the dependencies array is empty, there's not
strictly a need to clean up event handlers for example, because the node is
to be removed. It *is* necessary if you add dependencies because the ref
callback will be called multiple times for the same node.

param: {Function} calllback    Callback with ref as argument.
param: {Array}    dependencies Dependencies of the callback.
return: {Function} Ref callback.

useUpdatedRef(value)   X-Ref
No description

useCopyToClipboard(text, onSuccess)   X-Ref
Copies the given text to the clipboard when the element is clicked.

param: {text|Function} text      The text to copy. Use a function if not
param: {Function}      onSuccess Called when to text is copied.
return: {RefObject} A ref to assign to the target element.

useFocusOnMount()   X-Ref
Hook used to focus the first tabbable element on mount.

param: {boolean|string} focusOnMount Focus on mount mode.
return: {Function} Ref callback.

useFocusReturn(onFocusReturn)   X-Ref
When opening modals/sidebars/dialogs, the focus
must move to the opened area and return to the
previously focused element when closed.
The current hook implements the returning behavior.

param: {Function?} onFocusReturn Overrides the default return behavior.
return: {Function} Element Ref.

isFocusNormalizedButton(eventTarget)   X-Ref
Returns true if the given element is a button element subject to focus
normalization, or false otherwise.

param: {EventTarget} eventTarget The target from a mouse or touch event.
return: {eventTarget is FocusNormalizedButton} Whether element is a button.

useFocusOutside(onFocusOutside)   X-Ref
A react hook that can be used to check whether focus has moved outside the
element the event handlers are bound to.

param: {EventCallback} onFocusOutside        A callback triggered when focus moves outside
return: {FocusOutsideReturnValue} An object containing event handlers. Bind the event handlers

useMergeRefs(refs)   X-Ref
Merges refs into one ref callback. Ensures the merged ref callbacks are only
called when it changes (as a result of a `useCallback` dependency update) or
when the ref value changes. If you don't wish a ref callback to be called on
every render, wrap it with `useCallback( ref, [] )`.
Dependencies can be added, but when a dependency changes, the old ref
callback will be called with `null` and the new ref callback will be called
with the same node.

param: {Array<RefObject|RefCallback>} refs The refs to be merged.
return: {RefCallback} The merged ref callback.

ownKeys(object, enumerableOnly)   X-Ref
No description

_objectSpread(target)   X-Ref
No description

useDialog(options)   X-Ref
Returns a ref and props to apply to a dialog wrapper to enable the following behaviors:
- constrained tabbing.
- focus on mount.
- return focus on unmount.
- focus outside.

param: {Object} options Dialog Options.

useDragging(_ref)   X-Ref
Internal dependencies


isAppleOS()   X-Ref
Return true if platform is MacOS.

param: {Object} _window   window object by default; used for DI testing.
return: {boolean} True if MacOS; false otherwise.

useKeyboardShortcut(shortcuts, callback)   X-Ref
Attach a keyboard shortcut handler.

param: {string[]|string}         shortcuts  Keyboard Shortcuts.
param: {Function}                callback   Shortcut callback.
param: {WPKeyboardShortcutConfig} options    Shortcut options.

useMediaQuery(query)   X-Ref
Runs a media query and returns its value when it changes.

param: {string} [query] Media Query.
return: {boolean} return value of the media query.

usePrevious(value)   X-Ref
Use something's value from the previous render.
Based on https://usehooks.com/usePrevious/.

param: {T} value The value to track.
return: {T|undefined} The value from the previous render.

getFirstItemsPresentInState(list, state)   X-Ref
Returns the first items from list that are present on state.

param: {Array} list  New array.
param: {Array} state Current state.
return: {Array} First items present iin state.

listReducer(state, action)   X-Ref
Reducer keeping track of a list of appended items.

param: {Array}  state  Current state
param: {Object} action Action
return: {Array} update state.

useAsyncList(list)   X-Ref
React hook returns an array which items get asynchronously appended from a source array.
This behavior is useful if we want to render a list of items asynchronously for performance reasons.

param: {Array} list Source array.
return: {Array} Async array.

useWarnOnChange(object)   X-Ref
Hook that performs a shallow comparison between the preview value of an object
and the new one, if there's a difference, it prints it to the console.
this is useful in performance related work, to check why a component re-renders.

param: {Object} object Object which changes to compare.
param: {string} prefix Just a prefix to show when console logging.

useDebounce()   X-Ref
Debounces a function with Lodash's `debounce`. A new debounced function will
be returned and any scheduled calls cancelled if any of the arguments change,
including the function to debounce, so please wrap functions created on
render in components in `useCallback`.

param: {...any} args Arguments passed to Lodash's `debounce`.
return: {Function} Debounced function.

useThrottle()   X-Ref
Throttles a function with Lodash's `throttle`. A new throttled function will
be returned and any scheduled calls cancelled if any of the arguments change,
including the function to throttle, so please wrap functions created on
render in components in `useCallback`.

param: {...any} args Arguments passed to Lodash's `throttle`.
return: {Function} Throttled function.

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

_setPrototypeOf(o, p)   X-Ref
No description

_typeof(obj)   X-Ref
No description

_extends()   X-Ref
No description



Generated: Mon Apr 19 01:00:04 2021 Cross-referenced by PHPXref 0.7.1