[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/js/dist/ -> edit-site.js (summary)

(no description)

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

Defines 1 class

ErrorBoundary:: (32 methods):
  WelcomeGuideImage()
  WelcomeGuideEditor()
  WelcomeGuideStyles()
  WelcomeGuide()
  useGlobalStylesRenderer()
  GlobalStylesRenderer()
  useTitle()
  Editor()
  useRegisterShortcuts()
  NewTemplate()
  NewTemplatePart()
  AddNewTemplate()
  header_Header()
  isTemplateRemovable()
  RenameMenuItem()
  Actions()
  CustomizedTooltip()
  BaseAddedBy()
  AddedByTheme()
  AddedByPlugin()
  AddedByAuthor()
  AddedBySite()
  AddedBy()
  Table()
  List()
  getIsListPage()
  EditSiteApp()
  onPluginAreaError()
  PluginSidebarEditSite()
  PluginSidebarMoreMenuItem()
  reinitializeEditor()
  initializeEditor()

Defines 32 functions

  assign()
  init()
  changeOverflow()
  getParentOverflows()
  resize()
  update()
  destroy()
  update()
  classNames()
  dataUrlToBlob()
  saver()
  lineHeight()
  emptyFunction()
  emptyFunctionWithReset()
  shim()
  getShim()
  __()
  TextareaAutosizeClass()
  __webpack_require__()
  deviceType()
  settings()
  editedPost()
  homeTemplateId()
  navigationPanel()
  blockInserterPanel()
  listViewPanel()
  extends_extends()
  toggleFeature()
  setFeatureValue()
  setFeatureDefaults()
  ComplementaryAreaToggle()
  ActionItemSlot()
  ActionItem()
  ComplementaryAreaMoreMenuItem()
  PinnedItems()
  PinnedItemsSlot()
  ComplementaryAreaSlot()
  ComplementaryAreaFill()
  useAdjustComplementaryListener()
  ComplementaryArea()
  useHTMLClass()
  InterfaceSkeleton()
  MoreMenuDropdown()
  PreferencesModal()
  Icon()
  PreferencesModalTabs()
  BaseOption()
  isTemplateRevertable()
  actions_toggleFeature()
  __experimentalSetPreviewDeviceType()
  setTemplatePart()
  setHomeTemplateId()
  setNavigationPanelActiveMenu()
  openNavigationPanelToMenu()
  setIsNavigationPanelOpened()
  setIsInserterOpened()
  updateSettings()
  setIsListViewOpened()
  arrayOf()
  isObjectLike()
  createCache()
  isShallowEqual()
  rememo()
  getRootCache()
  getWeakMapCache()
  clear()
  callSelector()
  isTemplateSuperseded()
  getTemplateLocation()
  getUnusedTemplates()
  getTemplatesLocationMap()
  selectors_isFeatureActive()
  __experimentalGetPreviewDeviceType()
  getHomeTemplateId()
  getCurrentEditedPost()
  getEditedPostType()
  getEditedPostId()
  getPage()
  getNavigationPanelActiveMenu()
  isNavigationOpened()
  isInserterOpened()
  __experimentalGetInsertionPoint()
  isListViewOpened()
  getEditorMode()
  warning()
  createBrowserHistory()
  getIndexAndLocation()
  handlePop()
  createHref()
  getNextLocation()
  getHistoryStateAndUrl()
  allowTx()
  applyTx()
  push()
  retry()
  replace()
  retry()
  go()
  createHashHistory()
  getIndexAndLocation()
  handlePop()
  getBaseHref()
  createHref()
  getNextLocation()
  getHistoryStateAndUrl()
  allowTx()
  applyTx()
  push()
  retry()
  replace()
  retry()
  go()
  createMemoryHistory()
  createHref()
  getNextLocation()
  allowTx()
  applyTx()
  push()
  retry()
  replace()
  retry()
  go()
  retry()
  clamp()
  promptBeforeUnload()
  createEvents()
  createKey()
  createPath()
  parsePath()
  push()
  replace()
  useLocation()
  useHistory()
  getLocationWithParams()
  Routes()
  KeyCombination()
  Shortcut()
  DynamicShortcut()
  KeyboardShortcutHelpModal()
  EnableFeature()
  EditSitePreferencesModal()
  SiteExport()
  WelcomeGuideMenuItem()
  CopyContentMenuItem()
  onSuccess()
  ModeSwitcher()
  MoreMenu()
  SaveButton()
  UndoButton()
  RedoButton()
  getBlockDisplayText()
  useSecondaryText()
  DocumentActions()
  useLink()
  onClick()
  Link()
  TemplatePartItemMore()
  editTemplatePart()
  clearCustomizations()
  TemplatePartItem()
  TemplateAreas()
  EditTemplateTitle()
  TemplateDetails()
  Header()
  default_sidebar_DefaultSidebar()
  IconWithCurrentColor()
  GenericNavigationButton()
  NavigationButton()
  NavigationBackButton()
  findInPresetsBy()
  getPresetVariableFromValue()
  getValueFromPresetVariable()
  getValueFromCustomVariable()
  getValueFromVariable()
  useSetting()
  useStyle()
  getSupportedGlobalStylesPanels()
  useColorsPerOrigin()
  useGradientsPerOrigin()
  useHasBorderPanel()
  useHasBorderColorControl()
  useHasBorderRadiusControl()
  useHasBorderStyleControl()
  useHasBorderWidthControl()
  BorderPanel()
  useHasColorPanel()
  useHasDimensionsPanel()
  useHasPadding()
  useHasMargin()
  useHasGap()
  filterValuesBySides()
  splitStyleValue()
  DimensionsPanel()
  useHasTypographyPanel()
  useHasLineHeightControl()
  useHasAppearanceControl()
  useHasLetterSpacingControl()
  TypographyPanel()
  ContextMenu()
  generateBoxRules()
  generate()
  getCSSRules()
  compileStyleValue()
  getPresetsDeclarations()
  getPresetsClasses()
  getPresetsSvgFilters()
  flattenTree()
  getStylesDeclarations()
  toSvgFilters()
  useGlobalStylesOutput()
  ScreenRoot()
  ScreenHeader()
  useSortedBlockTypes()
  BlockMenuItem()
  ScreenBlockList()
  ScreenBlock()
  Subtitle()
  Item()
  ScreenTypography()
  ScreenTypographyElement()
  ColorIndicatorWrapper()
  Palette()
  BackgroundColorItem()
  TextColorItem()
  LinkColorItem()
  ScreenColors()
  ColorPalettePanel()
  GradientPalettePanel()
  ScreenColorPalette()
  ScreenBackgroundColor()
  ScreenTextColor()
  ScreenLinkColor()
  ScreenLayout()
  mergeTreesCustomizer()
  mergeBaseAndUserConfigs()
  useGlobalStylesUserConfig()
  useGlobalStylesBaseConfig()
  useGlobalStylesContext()
  GlobalStylesProvider()
  compareVariations()
  Variation()
  ScreenStyleVariations()
  GlobalStylesNavigationScreen()
  ContextScreens()
  GlobalStylesUI()
  GlobalStylesSidebar()
  navigation_menu_NavigationMenu()
  navigation_inspector_NavigationInspector()
  NavigationMenuSidebar()
  TemplateAreaItem()
  template_areas_TemplateAreas()
  TemplateCard()
  SidebarComplementaryAreaFills()
  NavLink()
  NavigationToggle()
  NavigationSidebar()
  ConvertToRegularBlocks()
  CreateTemplatePartModal()
  ConvertToTemplatePart()
  TemplatePartConverter()
  NavigateToLink()
  BlockInspectorButton()
  EditTemplatePartMenuButton()
  EditTemplatePartMenuItem()
  BackButton()
  ResizeHandle()
  handleKeyDown()
  ResizableEditor()
  resizeHeight()
  registerObserver()
  BlockEditor()
  CodeEditorTextArea()
  CodeEditor()
  KeyboardShortcuts()
  KeyboardShortcutsRegister()
  URLQueryController()
  InserterSidebar()
  ListViewSidebar()
  closeOnEscape()
  CopyButton()
  ErrorBoundaryWarning()

Class: ErrorBoundary  - X-Ref

Internal dependencies

WelcomeGuideImage(_ref)   X-Ref
No description

WelcomeGuideEditor()   X-Ref
Internal dependencies


WelcomeGuideStyles()   X-Ref
No description

WelcomeGuide()   X-Ref
Internal dependencies


useGlobalStylesRenderer()   X-Ref
No description

GlobalStylesRenderer()   X-Ref
No description

useTitle(title)   X-Ref
Internal dependencies


Editor(_ref)   X-Ref
No description

useRegisterShortcuts()   X-Ref
No description

NewTemplate(_ref)   X-Ref
No description

NewTemplatePart(_ref)   X-Ref
No description

AddNewTemplate(_ref)   X-Ref
No description

header_Header(_ref)   X-Ref
Internal dependencies


isTemplateRemovable(template)   X-Ref
Check if a template is removable.

return: {boolean} Whether the template is revertable.
param: {Object} template The template entity to check.

RenameMenuItem(_ref)   X-Ref
No description

Actions(_ref)   X-Ref
No description

CustomizedTooltip(_ref)   X-Ref
No description

BaseAddedBy(_ref2)   X-Ref
No description

AddedByTheme(_ref3)   X-Ref
No description

AddedByPlugin(_ref4)   X-Ref
No description

AddedByAuthor(_ref5)   X-Ref
No description

AddedBySite()   X-Ref
No description

AddedBy(_ref6)   X-Ref
No description

Table(_ref)   X-Ref
No description

List()   X-Ref
No description

getIsListPage(_ref)   X-Ref
Returns if the params match the list page route.

return: {boolean} Is list page or not.
param: {Object} params          The search params.
param: {string} params.postId   The post ID.
param: {string} params.postType The post type.

EditSiteApp(_ref)   X-Ref
No description

onPluginAreaError(name)   X-Ref
No description

PluginSidebarEditSite(_ref)   X-Ref
Renders a sidebar when activated. The contents within the `PluginSidebar` will appear as content within the sidebar.
It also automatically renders a corresponding `PluginSidebarMenuItem` component when `isPinnable` flag is set to `true`.
If you wish to display the sidebar, you can with use the `PluginSidebarMoreMenuItem` component or the `wp.data.dispatch` API:

```js
wp.data.dispatch( 'core/edit-site' ).openGeneralSidebar( 'plugin-name/sidebar-name' );
```

param: {Object}                props                                 Element props.
param: {string}                props.name                            A string identifying the sidebar. Must be unique for every sidebar registered within the scope of your plugin.
param: {string}                [props.className]                     An optional class name added to the sidebar body.
param: {string}                props.title                           Title displayed at the top of the sidebar.
param: {boolean}               [props.isPinnable=true]               Whether to allow to pin sidebar to the toolbar. When set to `true` it also automatically renders a corresponding menu item.
param: {WPBlockTypeIconRender} [props.icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.

PluginSidebarMoreMenuItem(props)   X-Ref
Renders a menu item in `Plugins` group in `More Menu` drop down,
and can be used to activate the corresponding `PluginSidebar` component.
The text within the component appears as the menu item label.

return: {WPComponent} The component to be rendered.
param: {Object}                props                                 Component props.
param: {string}                props.target                          A string identifying the target sidebar you wish to be activated by this menu item. Must be the same as the `name` prop you have given to that sidebar.
param: {WPBlockTypeIconRender} [props.icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.

reinitializeEditor(target, settings)   X-Ref
Reinitializes the editor after the user chooses to reboot the editor after
an unhandled error occurs, replacing previously mounted editor element using
an initial state from prior to the crash.

param: {Element} target   DOM node in which editor is rendered.
param: {?Object} settings Editor settings object.

initializeEditor(id, settings)   X-Ref
Initializes the site editor screen.

param: {string} id       ID of the root element to render the screen in.
param: {Object} settings Editor settings.

Functions
Functions that are not part of a class:

assign(ta)   X-Ref
No description

init()   X-Ref
No description

changeOverflow(value)   X-Ref
No description

getParentOverflows(el)   X-Ref
No description

resize()   X-Ref
No description

update()   X-Ref
No description

destroy(ta)   X-Ref
No description

update(ta)   X-Ref
No description

classNames()   X-Ref
No description

dataUrlToBlob(strUrl)   X-Ref
No description

saver(url, winMode)   X-Ref
No description

lineHeight(node)   X-Ref
Calculate the `line-height` of a given node

returns: {Number} `line-height` of the element in pixels
param: {HTMLElement} node Element to calculate line height of. Must be in the DOM.

emptyFunction()   X-Ref
No description

emptyFunctionWithReset()   X-Ref
No description

shim(props, propName, componentName, location, propFullName, secret)   X-Ref
No description

getShim()   X-Ref
No description

__()   X-Ref
No description

TextareaAutosizeClass()   X-Ref
A light replacement for built-in textarea component
which automaticaly adjusts its height to match the content


__webpack_require__(moduleId)   X-Ref
No description

deviceType()   X-Ref
No description

settings()   X-Ref
Reducer returning the settings.

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

editedPost()   X-Ref
Reducer keeping track of the currently edited Post Type,
Post Id and the context provided to fill the content of the block editor.

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

homeTemplateId(state, action)   X-Ref
Reducer for information about the site's homepage.

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

navigationPanel()   X-Ref
Reducer for information about the navigation panel, such as its active menu
and whether it should be opened or closed.

Note: this reducer interacts with the inserter and list view panels reducers
to make sure that only one of the three panels is open at the same time.

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

blockInserterPanel()   X-Ref
Reducer to set the block inserter panel open or closed.

Note: this reducer interacts with the navigation and list view panels reducers
to make sure that only one of the three panels is open at the same time.

param: {boolean|Object} state  Current state.
param: {Object}         action Dispatched action.

listViewPanel()   X-Ref
Reducer to set the list view panel open or closed.

Note: this reducer interacts with the navigation and inserter panels reducers
to make sure that only one of the three panels is open at the same time.

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

extends_extends()   X-Ref
No description

toggleFeature(scope, featureName)   X-Ref
Returns an action object used in signalling that a feature should be toggled.

param: {string} scope       The feature scope (e.g. core/edit-post).
param: {string} featureName The feature name.

setFeatureValue(scope, featureName, value)   X-Ref
Returns an action object used in signalling that a feature should be set to
a true or false value

return: {Object} Action object.
param: {string}  scope       The feature scope (e.g. core/edit-post).
param: {string}  featureName The feature name.
param: {boolean} value       The value to set.

setFeatureDefaults(scope, defaults)   X-Ref
Returns an action object used in signalling that defaults should be set for features.

return: {Object} Action object.
param: {string}                  scope    The feature scope (e.g. core/edit-post).
param: {Object<string, boolean>} defaults A key/value map of feature names to values.

ComplementaryAreaToggle(_ref)   X-Ref
No description

ActionItemSlot(_ref)   X-Ref
No description

ActionItem(_ref3)   X-Ref
No description

ComplementaryAreaMoreMenuItem(_ref)   X-Ref
No description

PinnedItems(_ref)   X-Ref
No description

PinnedItemsSlot(_ref2)   X-Ref
No description

ComplementaryAreaSlot(_ref)   X-Ref
No description

ComplementaryAreaFill(_ref2)   X-Ref
No description

useAdjustComplementaryListener(scope, identifier, activeArea, isActive, isSmall)   X-Ref
No description

ComplementaryArea(_ref3)   X-Ref
No description

useHTMLClass(className)   X-Ref
No description

InterfaceSkeleton(_ref, ref)   X-Ref
No description

MoreMenuDropdown(_ref)   X-Ref
No description

PreferencesModal(_ref)   X-Ref
WordPress dependencies


Icon(_ref)   X-Ref
Return an SVG icon.

return: {JSX.Element}  Icon component
param: {IconProps} props icon is the SVG component to render

PreferencesModalTabs(_ref)   X-Ref
No description

BaseOption(_ref)   X-Ref
WordPress dependencies


isTemplateRevertable(template)   X-Ref
Check if a template is revertable to its original theme-provided template file.

return: {boolean} Whether the template is revertable.
param: {Object} template The template entity to check.

actions_toggleFeature(featureName)   X-Ref
Dispatches an action that toggles a feature flag.

param: {string} featureName Feature name.

__experimentalSetPreviewDeviceType(deviceType)   X-Ref
Action that changes the width of the editing canvas.

return: {Object} Action object.
param: {string} deviceType

setTemplatePart(templatePartId)   X-Ref
Action that sets a template part.

return: {Object} Action object.
param: {string} templatePartId The template part ID.

setHomeTemplateId(homeTemplateId)   X-Ref
Action that sets the home template ID to the template ID of the page resolved
from a given path.

param: {number} homeTemplateId The template ID for the homepage.

setNavigationPanelActiveMenu(menu)   X-Ref
Action that sets the active navigation panel menu.

return: {Object} Action object.
param: {string} menu Menu prop of active menu.

openNavigationPanelToMenu(menu)   X-Ref
Opens the navigation panel and sets its active menu at the same time.

param: {string} menu Identifies the menu to open.

setIsNavigationPanelOpened(isOpen)   X-Ref
Sets whether the navigation panel should be open.

param: {boolean} isOpen If true, opens the nav panel. If false, closes it. It

setIsInserterOpened(value)   X-Ref
Opens or closes the inserter.

return: {Object} Action object.
param: {boolean|Object} value                Whether the inserter should be
param: {string}         value.rootClientId   The root client ID to insert at.
param: {number}         value.insertionIndex The index to insert at.

updateSettings(settings)   X-Ref
Returns an action object used to update the settings.

return: {Object} Action object.
param: {Object} settings New settings.

setIsListViewOpened(isOpen)   X-Ref
Sets whether the list view panel should be open.

param: {boolean} isOpen If true, opens the list view. If false, closes it.

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

return: {Array} Value returned as entry in array.
param: {*} 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: {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.

return: {boolean} Whether arrays are shallowly equal.
param: {Array}  a         First array.
param: {Array}  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.

return: {Function} Memoized selector.
param: {Function} selector      Selector function.
param: {Function} getDependants Dependant getter returning an immutable

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.

return: {Object} Cache object.
param: {Array} 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: {Object} source    Source object for derivation.
param: {...*}   extraArgs Additional arguments to pass to selector.

isTemplateSuperseded(slug, existingSlugs, showOnFront)   X-Ref
Internal dependencies


getTemplateLocation(slug)   X-Ref
No description

getUnusedTemplates(templates, showOnFront)   X-Ref
No description

getTemplatesLocationMap(templates)   X-Ref
No description

selectors_isFeatureActive(state, featureName)   X-Ref
Returns whether the given feature is enabled or not.

return: {boolean} Is active.
param: {Object} state       Global application state.
param: {string} featureName Feature slug.

__experimentalGetPreviewDeviceType(state)   X-Ref
Returns the current editing canvas device type.

return: {string} Device type.
param: {Object} state Global application state.

getHomeTemplateId(state)   X-Ref
Returns the current home template ID.

return: {number?} Home template ID.
param: {Object} state Global application state.

getCurrentEditedPost(state)   X-Ref
No description

getEditedPostType(state)   X-Ref
Returns the current edited post type (wp_template or wp_template_part).

return: {TemplateType?} Template type.
param: {Object} state Global application state.

getEditedPostId(state)   X-Ref
Returns the ID of the currently edited template or template part.

return: {string?} Post ID.
param: {Object} state Global application state.

getPage(state)   X-Ref
Returns the current page object.

return: {Object} Page.
param: {Object} state Global application state.

getNavigationPanelActiveMenu(state)   X-Ref
Returns the active menu in the navigation panel.

return: {string} Active menu.
param: {Object} state Global application state.

isNavigationOpened(state)   X-Ref
Returns the current opened/closed state of the navigation panel.

return: {boolean} True if the navigation panel should be open; false if closed.
param: {Object} state Global application state.

isInserterOpened(state)   X-Ref
Returns the current opened/closed state of the inserter panel.

return: {boolean} True if the inserter panel should be open; false if closed.
param: {Object} state Global application state.

__experimentalGetInsertionPoint(state)   X-Ref
Get the insertion point for the inserter.

return: {Object} The root client ID, index to insert at and starting filter value.
param: {Object} state Global application state.

isListViewOpened(state)   X-Ref
Returns the current opened/closed state of the list view panel.

return: {boolean} True if the list view panel should be open; false if closed.
param: {Object} state Global application state.

getEditorMode(state)   X-Ref
Returns the current editing mode.

return: {string} Editing mode.
param: {Object} state Global application state.

warning(cond, message)   X-Ref
No description

createBrowserHistory(options)   X-Ref
Browser history stores the location in regular URLs. This is the standard for
most web apps, but it requires some configuration on the server to ensure you
serve the same app at multiple URLs.


getIndexAndLocation()   X-Ref
No description

handlePop()   X-Ref
No description

createHref(to)   X-Ref
No description

getNextLocation(to, state)   X-Ref
No description

getHistoryStateAndUrl(nextLocation, index)   X-Ref
No description

allowTx(action, location, retry)   X-Ref
No description

applyTx(nextAction)   X-Ref
No description

push(to, state)   X-Ref
No description

retry()   X-Ref
No description

replace(to, state)   X-Ref
No description

retry()   X-Ref
No description

go(delta)   X-Ref
No description

createHashHistory(options)   X-Ref
Hash history stores the location in window.location.hash. This makes it ideal
for situations where you don't want to send the location to the server for
some reason, either because you do cannot configure it or the URL space is
reserved for something else.


getIndexAndLocation()   X-Ref
No description

handlePop()   X-Ref
No description

getBaseHref()   X-Ref
No description

createHref(to)   X-Ref
No description

getNextLocation(to, state)   X-Ref
No description

getHistoryStateAndUrl(nextLocation, index)   X-Ref
No description

allowTx(action, location, retry)   X-Ref
No description

applyTx(nextAction)   X-Ref
No description

push(to, state)   X-Ref
No description

retry()   X-Ref
No description

replace(to, state)   X-Ref
No description

retry()   X-Ref
No description

go(delta)   X-Ref
No description

createMemoryHistory(options)   X-Ref
Memory history stores the current location in memory. It is designed for use
in stateful non-browser environments like tests and React Native.


createHref(to)   X-Ref
No description

getNextLocation(to, state)   X-Ref
No description

allowTx(action, location, retry)   X-Ref
No description

applyTx(nextAction, nextLocation)   X-Ref
No description

push(to, state)   X-Ref
No description

retry()   X-Ref
No description

replace(to, state)   X-Ref
No description

retry()   X-Ref
No description

go(delta)   X-Ref
No description

retry()   X-Ref
No description

clamp(n, lowerBound, upperBound)   X-Ref
No description

promptBeforeUnload(event)   X-Ref
No description

createEvents()   X-Ref
No description

createKey()   X-Ref
No description

createPath(_ref)   X-Ref
Creates a string URL path from the given pathname, search, and hash components.


parsePath(path)   X-Ref
Parses a string URL path into its separate pathname, search, and hash components.


push(params, state)   X-Ref
No description

replace(params, state)   X-Ref
No description

useLocation()   X-Ref
No description

useHistory()   X-Ref
No description

getLocationWithParams(location)   X-Ref
No description

Routes(_ref)   X-Ref
No description

KeyCombination(_ref)   X-Ref
No description

Shortcut(_ref2)   X-Ref
No description

DynamicShortcut(_ref)   X-Ref
Internal dependencies


KeyboardShortcutHelpModal(_ref4)   X-Ref
No description

EnableFeature(props)   X-Ref
No description

EditSitePreferencesModal(_ref)   X-Ref
Internal dependencies


SiteExport()   X-Ref
No description

WelcomeGuideMenuItem()   X-Ref
No description

CopyContentMenuItem()   X-Ref
Internal dependencies


onSuccess()   X-Ref
No description

ModeSwitcher()   X-Ref
No description

MoreMenu()   X-Ref
No description

SaveButton(_ref)   X-Ref
No description

UndoButton()   X-Ref
No description

RedoButton()   X-Ref
No description

getBlockDisplayText(block)   X-Ref
No description

useSecondaryText()   X-Ref
No description

DocumentActions(_ref)   X-Ref

param: {Object}   props                Props for the DocumentActions component.
param: {string}   props.entityTitle    The title to display.
param: {string}   props.entityLabel    A label to use for entity-related options.
param: {boolean}  props.isLoaded       Whether the data is available.
param: {Function} props.children       React component to use for the
param: {boolean}  props.showIconLabels Whether buttons display icons or text labels.

useLink()   X-Ref
Internal dependencies


onClick(event)   X-Ref
No description

Link(_ref)   X-Ref
No description

TemplatePartItemMore(_ref)   X-Ref
No description

editTemplatePart(event)   X-Ref
No description

clearCustomizations()   X-Ref
No description

TemplatePartItem(_ref2)   X-Ref
No description

TemplateAreas(_ref4)   X-Ref
No description

EditTemplateTitle(_ref)   X-Ref
No description

TemplateDetails(_ref)   X-Ref
No description

Header(_ref)   X-Ref
No description

default_sidebar_DefaultSidebar(_ref)   X-Ref
WordPress dependencies


IconWithCurrentColor(_ref)   X-Ref
WordPress dependencies


GenericNavigationButton(_ref)   X-Ref
No description

NavigationButton(props)   X-Ref
No description

NavigationBackButton(props)   X-Ref
No description

findInPresetsBy(features, blockName, presetPath, presetProperty, presetValueValue)   X-Ref
No description

getPresetVariableFromValue(features, blockName, variableStylePath, presetPropertyValue)   X-Ref
No description

getValueFromPresetVariable(features, blockName, variable, _ref2)   X-Ref
No description

getValueFromCustomVariable(features, blockName, variable, path)   X-Ref
No description

getValueFromVariable(features, blockName, variable)   X-Ref
No description

useSetting(path, blockName)   X-Ref
No description

useStyle(path, blockName)   X-Ref
No description

getSupportedGlobalStylesPanels(name)   X-Ref
No description

useColorsPerOrigin(name)   X-Ref
No description

useGradientsPerOrigin(name)   X-Ref
No description

useHasBorderPanel(name)   X-Ref
No description

useHasBorderColorControl(name)   X-Ref
No description

useHasBorderRadiusControl(name)   X-Ref
No description

useHasBorderStyleControl(name)   X-Ref
No description

useHasBorderWidthControl(name)   X-Ref
No description

BorderPanel(_ref)   X-Ref
No description

useHasColorPanel(name)   X-Ref
Internal dependencies


useHasDimensionsPanel(name)   X-Ref
No description

useHasPadding(name)   X-Ref
No description

useHasMargin(name)   X-Ref
No description

useHasGap(name)   X-Ref
No description

filterValuesBySides(values, sides)   X-Ref
No description

splitStyleValue(value)   X-Ref
No description

DimensionsPanel(_ref)   X-Ref
No description

useHasTypographyPanel(name)   X-Ref
Internal dependencies


useHasLineHeightControl(name)   X-Ref
No description

useHasAppearanceControl(name)   X-Ref
No description

useHasLetterSpacingControl(name)   X-Ref
No description

TypographyPanel(_ref)   X-Ref
No description

ContextMenu(_ref)   X-Ref
No description

generateBoxRules(style, options, path, ruleKey)   X-Ref
Internal dependencies


generate(style, options)   X-Ref
Generates a stylesheet for a given style object and selector.

return: generated stylesheet.
param: style   Style object.
param: options Options object with settings to adjust how the styles are generated.

getCSSRules(style, options)   X-Ref
Returns a JSON representation of the generated CSS rules.

return: generated styles.
param: style   Style object.
param: options Options object with settings to adjust how the styles are generated.

compileStyleValue(uncompiledValue)   X-Ref
No description

getPresetsDeclarations()   X-Ref
Transform given preset tree into a set of style declarations.

return: {Array} An array of style declarations.
param: {Object} blockPresets

getPresetsClasses(blockSelector)   X-Ref
Transform given preset tree into a set of preset class declarations.

return: {string} CSS declarations for the preset classes.
param: {string} blockSelector
param: {Object} blockPresets

getPresetsSvgFilters()   X-Ref
No description

flattenTree()   X-Ref
No description

getStylesDeclarations()   X-Ref
Transform given style tree into a set of style declarations.

return: {Array} An array of style declarations.
param: {Object} blockStyles Block styles.

toSvgFilters(tree, blockSelectors)   X-Ref
No description

useGlobalStylesOutput()   X-Ref
No description

ScreenRoot()   X-Ref
No description

ScreenHeader(_ref)   X-Ref
No description

useSortedBlockTypes()   X-Ref
No description

BlockMenuItem(_ref)   X-Ref
No description

ScreenBlockList()   X-Ref
No description

ScreenBlock(_ref)   X-Ref
No description

Subtitle(_ref)   X-Ref
WordPress dependencies


Item(_ref)   X-Ref
No description

ScreenTypography(_ref2)   X-Ref
No description

ScreenTypographyElement(_ref)   X-Ref
No description

ColorIndicatorWrapper(_ref)   X-Ref
No description

Palette(_ref)   X-Ref
No description

BackgroundColorItem(_ref)   X-Ref
No description

TextColorItem(_ref2)   X-Ref
No description

LinkColorItem(_ref3)   X-Ref
No description

ScreenColors(_ref4)   X-Ref
No description

ColorPalettePanel(_ref)   X-Ref
Internal dependencies


GradientPalettePanel(_ref)   X-Ref
No description

ScreenColorPalette(_ref)   X-Ref
No description

ScreenBackgroundColor(_ref)   X-Ref
No description

ScreenTextColor(_ref)   X-Ref
No description

ScreenLinkColor(_ref)   X-Ref
No description

ScreenLayout(_ref)   X-Ref
No description

mergeTreesCustomizer(_, srcValue)   X-Ref
No description

mergeBaseAndUserConfigs(base, user)   X-Ref
No description

useGlobalStylesUserConfig()   X-Ref
No description

useGlobalStylesBaseConfig()   X-Ref
No description

useGlobalStylesContext()   X-Ref
No description

GlobalStylesProvider(_ref)   X-Ref
No description

compareVariations(a, b)   X-Ref
No description

Variation(_ref)   X-Ref
No description

ScreenStyleVariations()   X-Ref
No description

GlobalStylesNavigationScreen(_ref)   X-Ref
No description

ContextScreens(_ref2)   X-Ref
No description

GlobalStylesUI()   X-Ref
No description

GlobalStylesSidebar()   X-Ref
No description

navigation_menu_NavigationMenu(_ref)   X-Ref
No description

navigation_inspector_NavigationInspector()   X-Ref
No description

NavigationMenuSidebar()   X-Ref
No description

TemplateAreaItem(_ref)   X-Ref
No description

template_areas_TemplateAreas()   X-Ref
No description

TemplateCard()   X-Ref
No description

SidebarComplementaryAreaFills()   X-Ref
No description

NavLink(_ref)   X-Ref
No description

NavigationToggle(_ref)   X-Ref
No description

NavigationSidebar(_ref)   X-Ref
No description

ConvertToRegularBlocks(_ref)   X-Ref
No description

CreateTemplatePartModal(_ref)   X-Ref
Internal dependencies


ConvertToTemplatePart(_ref)   X-Ref
Internal dependencies


TemplatePartConverter()   X-Ref
No description

NavigateToLink(_ref)   X-Ref
No description

BlockInspectorButton(_ref)   X-Ref
No description

EditTemplatePartMenuButton()   X-Ref
No description

EditTemplatePartMenuItem(_ref2)   X-Ref
No description

BackButton()   X-Ref
No description

ResizeHandle(_ref)   X-Ref
No description

handleKeyDown(event)   X-Ref
No description

ResizableEditor(_ref)   X-Ref
No description

resizeHeight()   X-Ref
No description

registerObserver()   X-Ref
No description

BlockEditor(_ref)   X-Ref
No description

CodeEditorTextArea(_ref)   X-Ref
No description

CodeEditor()   X-Ref
No description

KeyboardShortcuts(_ref)   X-Ref
No description

KeyboardShortcutsRegister()   X-Ref
No description

URLQueryController()   X-Ref
No description

InserterSidebar()   X-Ref
Internal dependencies


ListViewSidebar()   X-Ref
Internal dependencies


closeOnEscape(event)   X-Ref
No description

CopyButton(_ref)   X-Ref
No description

ErrorBoundaryWarning(_ref2)   X-Ref
No description



Generated: Wed Jun 29 01:00:03 2022 Cross-referenced by PHPXref 0.7.1