@wordpress/block-editor
v14.8.0
Published
Generic block editor.
Downloads
354,736
Readme
Block Editor
This module allows you to create and use standalone block editors.
Installation
Install the module
npm install @wordpress/block-editor --saveThis package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.
Usage
import { useState } from 'react';
import {
BlockCanvas,
BlockEditorProvider,
BlockList,
} from '@wordpress/block-editor';
function MyEditorComponent() {
const [ blocks, updateBlocks ] = useState( [] );
return (
<BlockEditorProvider
value={ blocks }
onInput={ ( blocks ) => updateBlocks( blocks ) }
onChange={ ( blocks ) => updateBlocks( blocks ) }
>
<BlockCanvas height="400px" />
</BlockEditorProvider>
);
}
// Make sure to load the block editor stylesheets too
// import '@wordpress/components/build-style/style.css';
// import '@wordpress/block-editor/build-style/style.css';In this example, we're instantiating a block editor. A block editor is composed by a BlockEditorProvider wrapper component where you pass the current array of blocks and on each change the onInput or onChange callbacks are called depending on whether the change is considered persistent or not.
Inside BlockEditorProvider, you can nest any of the available @wordpress/block-editor UI components to build the UI of your editor.
In the example above we're rendering the BlockList to show and edit the block list. For instance we could add a custom sidebar and use the BlockInspector component to be able to edit the advanced settings for the currently selected block. (See the API for the list of all the available components).
The BlockTools component is used to render the toolbar for a selected block.
In the example above, there's no registered block type, in order to use the block editor successfully make sure to register some block types. For instance, registering the core block types can be done like so:
import { registerCoreBlocks } from '@wordpress/block-library';
registerCoreBlocks();
// Make sure to load the block stylesheets too
// import '@wordpress/block-library/build-style/style.css';
// import '@wordpress/block-library/build-style/editor.css';
// import '@wordpress/block-library/build-style/theme.css';API
Any components in this package that have a counterpart in @wordpress/components are an extension of those components.
Unless you're creating an editor, it is recommended that the components in @wordpress/components should be used rather than the ones in this package as these components have been customized for use in an editor and may result in unexpected behaviour if used outside of this context.
AlignmentControl
Related
AlignmentToolbar
Related
Autocomplete
Related
BlockAlignmentControl
Related
BlockAlignmentToolbar
Related
BlockBreadcrumb
Block breadcrumb component, displaying the hierarchy of the current block selection as a breadcrumb.
Parameters
- props
Object: Component props. - props.rootLabelText
string: Translated label for the root element of the breadcrumb trail.
Returns
Element: Block Breadcrumb.
BlockCanvas
BlockCanvas component is a component used to display the canvas of the block editor. What we call the canvas is an iframe containing the block list that you can manipulate. The component is also responsible of wiring up all the necessary hooks to enable the keyboard navigation across blocks in the editor and inject content styles into the iframe.
Usage
function MyBlockEditor() {
const [ blocks, updateBlocks ] = useState( [] );
return (
<BlockEditorProvider
value={ blocks }
onInput={ updateBlocks }
onChange={ persistBlocks }
>
<BlockCanvas height="400px" />
</BlockEditorProvider>
);
}Parameters
- props
Object: Component props. - props.height
string: Canvas height, defaults to 300px. - props.styles
Array: Content styles to inject into the iframe. - props.children
Element: Content of the canvas, defaults to the BlockList component.
Returns
Element: Block Breadcrumb.
BlockColorsStyleSelector
Undocumented declaration.
BlockContextProvider
Component which merges passed value with current consumed block context.
Related
Parameters
- props
BlockContextProviderProps:
BlockControls
Undocumented declaration.
BlockEdit
Undocumented declaration.
BlockEditorKeyboardShortcuts
Undocumented declaration.
BlockEditorProvider
Undocumented declaration.
BlockFormatControls
Undocumented declaration.
BlockIcon
Related
BlockInspector
Related
BlockList
Undocumented declaration.
BlockMover
Related
BlockNavigationDropdown
Undocumented declaration.
BlockPopover
Related
BlockPreview
BlockPreview renders a preview of a block or array of blocks.
Related
Parameters
- preview
Object: options for how the preview should be shown - preview.blocks
Array|Object: A block instance (object) or an array of blocks to be previewed. - preview.viewportWidth
number: Width of the preview container in pixels. Controls at what size the blocks will be rendered inside the preview. Default: 700.
Returns
Component: The component to be rendered.
BlockSelectionClearer
Undocumented declaration.
BlockSettingsMenu
Undocumented declaration.
BlockSettingsMenuControls
Related
Parameters
- props
Object: Fill props.
Returns
Element: Element.
BlockStyles
Undocumented declaration.
BlockTitle
Renders the block's configured title as a string, or empty if the title cannot be determined.
Usage
<BlockTitle
clientId="afd1cb17-2c08-4e7a-91be-007ba7ddc3a1"
maximumLength={ 17 }
/>Parameters
- props
Object: - props.clientId
string: Client ID of block. - props.maximumLength
number|undefined: The maximum length that the block title string may be before truncated. - props.context
string|undefined: The context to pass togetBlockLabel.
Returns
JSX.Element: Block title.
BlockToolbar
Renders the block toolbar.
Related
Parameters
- props
Object: Components props. - props.hideDragHandle
boolean: Show or hide the Drag Handle for drag and drop functionality. - props.variant
string: Style variant of the toolbar, also passed to the Dropdowns rendered from Block Toolbar Buttons.
BlockTools
Renders block tools (the block toolbar, select/navigation mode toolbar, the insertion point and a slot for the inline rich text toolbar). Must be wrapped around the block content and editor styles wrapper or iframe.
Parameters
- $0
Object: Props. - $0.children
Object: The block content and style container. - $0.__unstableContentRef
Object: Ref holding the content scroll container.
BlockVerticalAlignmentControl
Related
BlockVerticalAlignmentToolbar
Related
ButtonBlockAppender
Related
ButtonBlockerAppender
Deprecated
Use ButtonBlockAppender instead.
ColorPalette
Undocumented declaration.
ColorPaletteControl
Undocumented declaration.
ContrastChecker
Related
CopyHandler
Deprecated
Parameters
- props
Object:
createCustomColorsHOC
A higher-order component factory for creating a 'withCustomColors' HOC, which handles color logic for class generation color value, retrieval and color attribute setting.
Use this higher-order component to work with a custom set of colors.
Usage
const CUSTOM_COLORS = [
{ name: 'Red', slug: 'red', color: '#ff0000' },
{ name: 'Blue', slug: 'blue', color: '#0000ff' },
];
const withCustomColors = createCustomColorsHOC( CUSTOM_COLORS );
// ...
export default compose(
withCustomColors( 'backgroundColor', 'borderColor' ),
MyColorfulComponent
);Parameters
- colorsArray
Array: The array of color objects (name, slug, color, etc... ).
Returns
Function: Higher-order component.
DefaultBlockAppender
Undocumented declaration.
FontSizePicker
Related
getColorClassName
Returns a class based on the context a color is being used and its slug.
Parameters
- colorContextName
string: Context/place where color is being used e.g: background, text etc... - colorSlug
string: Slug of the color.
Returns
?string: String with the class corresponding to the color in the provided context. Returns undefined if either colorContextName or colorSlug are not provided.
getColorObjectByAttributeValues
Provided an array of color objects as set by the theme or by the editor defaults, and the values of the defined color or custom color returns a color object describing the color.
Parameters
- colors
Array: Array of color objects as set by the theme or by the editor defaults. - definedColor
?string: A string containing the color slug. - customColor
?string: A string containing the customColor value.
Returns
?Object: If definedColor is passed and the name is found in colors, the color object exactly as set by the theme or editor defaults is returned. Otherwise, an object that just sets the color is defined.
getColorObjectByColorValue
Provided an array of color objects as set by the theme or by the editor defaults, and a color value returns the color object matching that value or undefined.
Parameters
- colors
Array: Array of color objects as set by the theme or by the editor defaults. - colorValue
?string: A string containing the color value.
Returns
?Object: Color object included in the colors array whose color property equals colorValue. Returns undefined if no color object matches this requirement.
getComputedFluidTypographyValue
Computes a fluid font-size value that uses clamp(). A minimum and maximum font size OR a single font size can be specified.
If a single font size is specified, it is scaled up and down using a logarithmic scale.
Usage
// Calculate fluid font-size value from a minimum and maximum value.
const fontSize = getComputedFluidTypographyValue( {
minimumFontSize: '20px',
maximumFontSize: '45px',
} );
// Calculate fluid font-size value from a single font size.
const fontSize = getComputedFluidTypographyValue( {
fontSize: '30px',
} );Parameters
- args
Object: - args.minimumViewportWidth
?string: Minimum viewport size from which type will have fluidity. Optional if fontSize is specified. - args.maximumViewportWidth
?string: Maximum size up to which type will have fluidity. Optional if fontSize is specified. - args.fontSize
[string|number]: Size to derive maximumFontSize and minimumFontSize from, if necessary. Optional if minimumFontSize and maximumFontSize are specified. - args.maximumFontSize
?string: Maximum font size for any clamp() calculation. Optional. - args.minimumFontSize
?string: Minimum font size for any clamp() calculation. Optional. - args.scaleFactor
?number: A scale factor to determine how fast a font scales within boundaries. Optional. - args.minimumFontSizeLimit
?string: The smallest a calculated font size may be. Optional.
Returns
string|null: A font-size value using clamp().
getCustomValueFromPreset
Converts a spacing preset into a custom value.
Parameters
- value
string: Value to convert - spacingSizes
Array: Array of the current spacing preset objects
Returns
string: Mapping of the spacing preset to its equivalent custom value.
getFontSize
Returns the font size object based on an array of named font sizes and the namedFontSize and customFontSize values. If namedFontSize is undefined or not found in fontSizes an object with just the size value based on customFontSize is returned.
Parameters
- fontSizes
Array: Array of font size objects containing at least the "name" and "size" values as properties. - fontSizeAttribute
?string: Content of the font size attribute (slug). - customFontSizeAttribute
?number: Contents of the custom font size attribute (value).
Returns
?Object: If fontSizeAttribute is set and an equal slug is found in fontSizes it returns the font size object for that slug. Otherwise, an object with just the size value based on customFontSize is returned.
getFontSizeClass
Returns a class based on fontSizeName.
Parameters
- fontSizeSlug
string: Slug of the fontSize.
Returns
string | undefined: String with the class corresponding to the fontSize passed. The class is generated by appending 'has-' followed by fontSizeSlug in kebabCase and ending with '-font-size'.
getFontSizeObjectByValue
Returns the corresponding font size object for a given value.
Parameters
- fontSizes
Array: Array of font size objects. - value
number: Font size value.
Returns
Object: Font size object.
getGradientSlugByValue
Retrieves the gradient slug per slug.
Parameters
- gradients
Array: Gradient Palette - value
string: Gradient value
Returns
string: Gradient slug.
getGradientValueBySlug
Retrieves the gradient value per slug.
Parameters
- gradients
Array: Gradient Palette - slug
string: Gradient slug
Returns
string: Gradient value.
getPxFromCssUnit
Deprecated
This function was accidentally exposed for mobile/native usage.
Returns
string: Empty string.
getSpacingPresetCssVar
Converts a spacing preset into a custom value.
Parameters
- value
string: Value to convert.
Returns
string | undefined: CSS var string for given spacing preset value.
getTypographyClassesAndStyles
Provides the CSS class names and inline styles for a block's typography support attributes.
Parameters
- attributes
Object: Block attributes. - settings
Object|boolean: Merged theme.json settings
Returns
Object: Typography block support derived CSS classes & styles.
HeadingLevelDropdown
Dropdown for selecting a heading level (1 through 6) or paragraph (0).
Parameters
- props
WPHeadingLevelDropdownProps: Component props.
Returns
ComponentType: The toolbar.
HeightControl
HeightControl renders a linked unit control and range control for adjusting the height of a block.
Related
Parameters
- props
Object: - props.label
?string: A label for the control. - props.onChange
( value: string ) => void: Called when the height changes. - props.value
string: The current height value.
Returns
Component: The component to be rendered.
InnerBlocks
Related
Inserter
Undocumented declaration.
InspectorAdvancedControls
Undocumented declaration.
InspectorControls
Related
isValueSpacingPreset
Checks is given value is a spacing preset.
Parameters
- value
string: Value to check
Returns
boolean: Return true if value is string in format var:preset|spacing|.
JustifyContentControl
Related
JustifyToolbar
Related
LineHeightControl
Related
MediaPlaceholder
Related
MediaReplaceFlow
Related
MediaUpload
Related
MediaUploadCheck
Related
MultiSelectScrollIntoView
Deprecated
Scrolls the multi block selection end into view if not in view already. This is important to do after selection by keyboard.
NavigableToolbar
Undocumented declaration.
ObserveTyping
Related
PanelColorSettings
Undocumented declaration.
PlainText
Related
privateApis
Private @wordpress/block-editor APIs.
RecursionProvider
A React context provider for use with the useHasRecursion hook to prevent recursive renders.
Wrap block content with this provider and provide the same uniqueId prop as used with useHasRecursion.
Parameters
- props
Object: - props.uniqueId
*: Any value that acts as a unique identifier for a block instance. - props.blockName
string: Optional block name. - props.children
JSX.Element: React children.
Returns
JSX.Element: A React element.
RichText
Related
RichTextShortcut
Undocumented declaration.
RichTextToolbarButton
Undocumented declaration.
SETTINGS_DEFAULTS
The default editor settings
Type Definition
- SETTINGS_DEFAULT
Object
Properties
- alignWide
boolean: Enable/Disable Wide/Full Alignments - supportsLayout
boolean: Enable/disable layouts support in container blocks. - imageEditing
boolean: Image Editing settings set to false to disable. - imageSizes
Array: Available image sizes - maxWidth
number: Max width to constraint resizing - allowedBlockTypes
boolean|Array: Allowed block types - hasFixedToolbar
boolean: Whether or not the editor toolbar is fixed - distractionFree
boolean: Whether or not the editor UI is distraction free - focusMode
boolean: Whether the focus mode is enabled or not - styles
Array: Editor Styles - keepCaretInsideBlock
boolean: Whether caret should move between blocks in edit mode - bodyPlaceholder
string: Empty post placeholder - titlePlaceholder
string: Empty title placeholder - canLockBlocks
boolean: Whether the user can manage Block Lock state - codeEditingEnabled
boolean: Whether or not the user can switch to the code editor - generateAnchors
boolean: Enable/Disable auto anchor generation for Heading blocks - enableOpenverseMediaCategory
boolean: Enable/Disable the Openverse media category in the inserter. - clearBlockSelection
boolean: Whether the block editor should clear selection on mousedown when a block is not clicked. - __experimentalCanUserUseUnfilteredHTML
boolean: Whether the user should be able to use unfiltered HTML or the HTML should be filtered e.g., to remove elements considered insecure like iframes. - __experimentalBlockDirectory
boolean: Whether the user has enabled the Block Directory - __experimentalBlockPatterns
Array: Array of objects representing the block patterns - __experimentalBlockPatternCategories
Array: Array of objects representing the block pattern categories
SkipToSelectedBlock
Related
store
Store definition for the block editor namespace.
Related
storeConfig
Block editor data store configuration.
Related
ToolSelector
Undocumented declaration.
transformStyles
Applies a series of CSS rule transforms to wrap selectors inside a given class and/or rewrite URLs depending on the parameters passed.
Parameters
- styles
EditorStyle[]: CSS rules. - wrapperSelector
string: Wrapper selector. - transformOptions
TransformOptions: Additional options for style transformation.
Returns
Array: converted rules.
Typewriter
Ensures that the text selection keeps the same vertical distance from the viewport during keyboard events within this component. The vertical distance can vary. It is the last clicked or scrolled to position.
URLInput
Related
URLInputButton
Related
URLPopover
Related
useBlockBindingsUtils
Retrieves the existing utils needed to update the block bindings metadata. They can be used to create, modify, or remove connections from the existing block attributes.
It contains the following utils:
updateBlockBindings: Updates the value of the bindings connected to block attributes. It can be used to remove a specific binding by setting the value toundefined.removeAllBlockBindings: Removes the bindings property of themetadataattribute.
Usage
import { useBlockBindingsUtils } from '@wordpress/block-editor';
const { updateBlockBindings, removeAllBlockBindings } = useBlockBindingsUtils();
// Update url and alt attributes.
updateBlockBindings( {
url: {
source: 'core/post-meta',
args: {
key: 'url_custom_field',
},
},
alt: {
source: 'core/post-meta',
args: {
key: 'text_custom_field',
},
},
} );
// Remove binding from url attribute.
updateBlockBindings( { url: undefined } );
// Remove bindings from all attributes.
removeAllBlockBindings();Parameters
- clientId
?string: Optional block client ID. If not set, it will use the current block client ID from the context.
Returns
?WPBlockBindingsUtils: Object containing the block bindings utils.
Changelog
6.7.0 Introduced in WordPress core.
useBlockCommands
Undocumented declaration.
useBlockDisplayInformation
Hook used to try to find a matching block variation and return the appropriate information for display reasons. In order to to try to find a match we need to things: 1. Block's client id to extract it's current attributes. 2. A block variation should have set isActive prop to a proper function.
If for any reason a block variation match cannot be found, the returned information come from the Block Type. If no blockType is found with the provided clientId, returns null.
Parameters
- clientId
string: Block's client id.
Returns
?WPBlockDisplayInformation: Block's display information, ornullwhen the block or its type not found.
useBlockEditContext
The useBlockEditContext hook provides information about the block this hook is being used in. It returns an object with the name, isSelected state, and the clientId of the block. It is useful if you want to create custom hooks that need access to the current blocks clientId but don't want to rely on the data getting passed in as a parameter.
Returns
Object: Block edit context
useBlockEditingMode
Allows a block to restrict the user interface that is displayed for editing that block and its inner blocks.
Usage
function MyBlock( { attributes, setAttributes } ) {
useBlockEditingMode( 'disabled' );
return <div { ...useBlockProps() }></div>;
}mode can be one of three options:
'disabled': Prevents editing the block entirely, i.e. it cannot be selected.'contentOnly': Hides all non-content UI, e.g. auxiliary controls in the toolbar, the block movers, block settings.'default': Allows editing the block as normal.
The mode is inherited by all of the block's inner blocks, unless they have their own mode.
If called outside of a block context, the mode is applied to all blocks.
Parameters
- mode
?BlockEditingMode: The editing mode to apply. If undefined, the current editing mode is not changed.
Returns
BlockEditingMode: The current editing mode.
useBlockProps
This hook is used to lightly mark an element as a block element. The element should be the outermost element of a block. Call this hook and pass the returned props to the element to mark as a block. If you define a ref for the element, it is important to pass the ref to this hook, which the hook in turn will pass to the component through the props it returns. Optionally, you can also pass any other props through this hook, and they will be merged and returned.
Use of this hook on the outermost element of a block is required if using API >= v2.
Usage
import { useBlockProps } from '@wordpress/block-editor';
export default function Edit() {
const blockProps = useBlockProps( {
className: 'my-custom-class',
style: {
color: '#222222',
backgroundColor: '#eeeeee',
},
} );
return <div { ...blockProps }></div>;
}Parameters
- props
Object: Optional. Props to pass to the element. Must contain the ref if one is defined. - options
Object: Options for internal use only. - options.__unstableIsHtml
boolean:
Returns
Object: Props to pass to the element to mark as a block.
useCachedTruthy
Keeps an up-to-date copy of the passed value and returns it. If value becomes falsy, it will return the last truthy copy.
Parameters
- value
any:
Returns
any: value
useHasRecursion
A React hook for keeping track of blocks previously rendered up in the block tree. Blocks susceptible to recursion can use this hook in their Edit function to prevent said recursion.
Use this with the RecursionProvider component, using the same uniqueId value for both the hook and the provider.
Parameters
- uniqueId
*: Any value that acts as a unique identifier for a block instance. - blockName
string: Optional block name.
Returns
boolean: A boolean describing whether the provided id has already been rendered.
useInnerBlocksProps
This hook is used to lightly mark an element as an inner blocks wrapper element. Call this hook and pass the returned props to the element to mark as an inner blocks wrapper, automatically rendering inner blocks as children. If you define a ref for the element, it is important to pass the ref to this hook, which the hook in turn will pass to the component through the props it returns. Optionally, you can also pass any other props through this hook, and they will be merged and returned.
Related
Parameters
- props
Object: Optional. Props to pass to the element. Must contain the ref if one is defined. - options
Object: Optional. Inner blocks options.
useSetting
Deprecated 6.5.0 Use useSettings instead.
Hook that retrieves the given setting for the block instance in use.
It looks up the setting first in the block instance hierarchy. If none is found, it'll look it up in the block editor settings.
Usage
const isEnabled = useSetting( 'typography.dropCap' );Parameters
- path
string: The path to the setting.
Returns
any: Returns the value defined for the setting.
useSettings
Hook that retrieves the given settings for the block instance in use.
It looks up the settings first in the block instance hierarchy. If none are found, it'll look them up in the block editor settings.
Usage
const [ fixed, sticky ] = useSettings( 'position.fixed', 'position.sticky' );Parameters
- paths
string[]: The paths to the settings.
Returns
any[]: Returns the values defined for the settings.
useStyleOverride
Override a block editor settings style. Leave the ID blank to create a new style.
Parameters
- override
Object: Override object. - override.id
?string: Id of the style override, leave blank to create a new style. - override.css
string: CSS to apply.
Warning
Related
withColorContext
Undocumented declaration.
withColors
A higher-order component, which handles color logic for class generation color value, retrieval and color attribute setting.
For use with the default editor/theme color palette.
Usage
export default compose(
withColors( 'backgroundColor', { textColor: 'color' } ),
MyColorfulComponent
);Parameters
- colorTypes
...(Object|string): The arguments can be strings or objects. If the argument is an object, it should contain the color attribute name as key and the color context as value. If the argument is a string the value should be the color attribute name, the color context is computed by applying a kebab case transform to the value. Color context represents the context/place where the color is going to be used. The class name of the color is generated using 'has' followed by the color name and ending with the color context all in kebab case e.g: has-green-background-color.
Returns
Function: Higher-order component.
withFontSizes
Higher-order component, which handles font size logic for class generation, font size value retrieval, and font size change handling.
Parameters
- fontSizeNames
...(Object|string): The arguments should all be strings. Each string contains the font size attribute name e.g: 'fontSize'.
Returns
Function: Higher-order component.
WritingFlow
Handles selection and navigation across blocks. This component should be wrapped around BlockList.
Parameters
- props
Object: Component properties. - props.children
Element: Children to be rendered.
Contributing to this package
This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.
To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.