WHAT YOU'LL LEARN
  • What is exported from webiny/admin/website-builder/page/editor?
  • How to import and use each exported item?

Overview
anchor

This page documents everything exported from webiny/admin/website-builder/page/editor. Import any of the items below directly from this path in your Webiny extensions.

Hooks

Other

Hooks
anchor

useActiveElement
anchor

Constant — imported from webiny/admin/website-builder/page/editor

useComponent
anchor

Constant — imported from webiny/admin/website-builder/page/editor

useCreateElement
anchor

Function — imported from webiny/admin/website-builder/page/editor

useDeleteElement
anchor

Function — imported from webiny/admin/website-builder/page/editor

useDocumentEditor
anchor

Function — imported from webiny/admin/website-builder/page/editor

useElementComponentManifest
anchor

Constant — imported from webiny/admin/website-builder/page/editor

useElementInputs
anchor

Function — imported from webiny/admin/website-builder/page/editor

Returns the resolved input values for the given element, plus an updater callback.

@param elementId The element whose inputs to resolve (null returns {}). @param depth How many levels of slot children to resolve (default 0).

useHighlightedElement
anchor

Constant — imported from webiny/admin/website-builder/page/editor

usePageEditorConfig
anchor

Constant — imported from webiny/admin/website-builder/page/editor

useSelectFromDocument
anchor

Function — imported from webiny/admin/website-builder/page/editor

Subscribe to part of the document state. @param selector Pick the slice of state you care about. @param equals (optional) comparator, defaults to Object.is

useSelectFromEditor
anchor

Function — imported from webiny/admin/website-builder/page/editor

Subscribe to part of the document state. @param selector Pick the slice of state you care about. @param equals (optional) comparator, defaults to Object.is

useUpdateElement
anchor

Function — imported from webiny/admin/website-builder/page/editor

Other
anchor

$addElementReferenceToParent
anchor

Function — imported from webiny/admin/website-builder/page/editor

$createElement
anchor

Function — imported from webiny/admin/website-builder/page/editor

$deleteElement
anchor

Function — imported from webiny/admin/website-builder/page/editor

$deselectElement
anchor

Function — imported from webiny/admin/website-builder/page/editor

$getActiveElementId
anchor

Function — imported from webiny/admin/website-builder/page/editor

$getComponentManifestByElementId
anchor

Function — imported from webiny/admin/website-builder/page/editor

$getElementById
anchor

Function — imported from webiny/admin/website-builder/page/editor

$getElementInputValues
anchor

Function — imported from webiny/admin/website-builder/page/editor

$getElementsOfType
anchor

Function — imported from webiny/admin/website-builder/page/editor

$getFirstElementOfType
anchor

Function — imported from webiny/admin/website-builder/page/editor

$highlightElement
anchor

Function — imported from webiny/admin/website-builder/page/editor

$moveElement
anchor

Function — imported from webiny/admin/website-builder/page/editor

$previewElementInputs
anchor

Function — imported from webiny/admin/website-builder/page/editor

Programmatically update an element’s inputs in the preview iframe only (via JSON patch). Does NOT write to the editor document state.

$removeElementReferenceFromParent
anchor

Function — imported from webiny/admin/website-builder/page/editor

$selectElement
anchor

Function — imported from webiny/admin/website-builder/page/editor

$updateElementInputs
anchor

Function — imported from webiny/admin/website-builder/page/editor

Programmatically update an element’s inputs using a callback-based API. The updater receives a deep object representation of the element’s inputs which can be mutated in place.

createCommand
anchor

Function — imported from webiny/admin/website-builder/page/editor

createElement
anchor

Constant — imported from webiny/admin/website-builder/page/editor

useElementOverlay
anchor

Export — imported from webiny/admin/website-builder/page/editor