@wordpress/block-editor Edit

This module allows you to create and use standalone block editors.

Installation Installation

Install the module

npm install @wordpress/block-editor --save

This package assumes that your code will run in an ES2015+ environment. If you’re using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.

Top ↑

Usage Usage

import {
    BlockEditorProvider,
    BlockList
} from '@wordpress/block-editor';
import { useState } from '@wordpress/element';

function MyEditorComponent () {
    const [ blocks, updateBlocks ] = useState( [] );

    return (
        <BlockEditorProvider
            value={ blocks }
            onInput={ updateBlocks }
            onChange={ updateBlocks }
        >
            <WritingFlow>
                <ObserveTyping>
                    <BlockList />
                </ObserveTyping>
            </WritingFlow>
            <Popover.Slot />
        </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 passe 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).

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';

Top ↑

API API

# AlignmentToolbar

Undocumented declaration.

# Autocomplete

Related

# BlockAlignmentToolbar

Undocumented declaration.

# BlockBreadcrumb

Block breadcrumb component, displaying the hierarchy of the current block selection as a breadcrumb.

Returns

  • WPElement: Block Breadcrumb.

# BlockControls

Undocumented declaration.

# BlockEdit

Undocumented declaration.

# BlockEditorKeyboardShortcuts

Undocumented declaration.

# BlockEditorProvider

Undocumented declaration.

# BlockFormatControls

Undocumented declaration.

# BlockIcon

Undocumented declaration.

# BlockInspector

Undocumented declaration.

# BlockList

Undocumented declaration.

# BlockMover

Undocumented declaration.

# BlockNavigationDropdown

Undocumented declaration.

# BlockPreview

BlockPreview renders a preview of a block or array of blocks.

Related

Parameters

  • blocks (Array|Object): A block instance (object) or an array of blocks to be previewed.
  • viewportWidth number: Width of the preview container in pixels. Controls at what size the blocks will be rendered inside the preview. Default: 700.

Returns

  • WPComponent: The component to be rendered.

# BlockSelectionClearer

Undocumented declaration.

# BlockSettingsMenu

Undocumented declaration.

# BlockTitle

Undocumented declaration.

# BlockToolbar

Undocumented declaration.

# BlockVerticalAlignmentToolbar

Related

# ButtonBlockerAppender

Related

# ColorPalette

Undocumented declaration.

# ColorPaletteControl

Undocumented declaration.

# ContrastChecker

Undocumented declaration.

# CopyHandler

Undocumented declaration.

# 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

Undocumented declaration.

# 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.

# 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

  • ?string: 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: 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’.

# InnerBlocks

Related

# Inserter

Undocumented declaration.

# InspectorAdvancedControls

Undocumented declaration.

# InspectorControls

Related

# MediaPlaceholder

Related

# MediaUpload

Related

# MediaUploadCheck

Related

# MultiBlocksSwitcher

Undocumented declaration.

# MultiSelectScrollIntoView

Undocumented declaration.

# NavigableToolbar

Undocumented declaration.

# ObserveTyping

Related

# PanelColorSettings

Undocumented declaration.

# PlainText

Related

# PreserveScrollInReorder

Undocumented declaration.

# 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
  • availableLegacyWidgets Array: Array of objects representing the legacy widgets available.
  • colors Array: Palette colors
  • disableCustomColors boolean: Whether or not the custom colors are disabled
  • fontSizes Array: Available font sizes
  • disableCustomFontSizes boolean: Whether or not the custom font sizes are disabled
  • 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
  • hasPermissionsToManageWidgets boolean: Whether or not the user is able to manage widgets.
  • focusMode boolean: Whether the focus mode is enabled or not
  • styles Array: Editor Styles
  • isRTL boolean: Whether the editor is in RTL mode
  • bodyPlaceholder string: Empty post placeholder
  • titlePlaceholder string: Empty title placeholder
  • codeEditingEnabled boolean: Whether or not the user can switch to the code editor
  • showInserterHelpPanel boolean: Whether or not the inserter help panel is shown
  • __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.
  • __experimentalEnableLegacyWidgetBlock boolean: Whether the user has enabled the Legacy Widget Block
  • __experimentalBlockDirectory boolean: Whether the user has enabled the Block Directory
  • __experimentalEnableFullSiteEditing boolean: Whether the user has enabled Full Site Editing

# SkipToSelectedBlock

Undocumented declaration.

# storeConfig

Block editor data store configuration.

Related

Type

  • Object

# 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 Array: CSS rules.
  • wrapperClassName string: Wrapper Class Name.

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

# useBlockEditContext

Undocumented declaration.

# Warning

Undocumented declaration.

# 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

Undocumented declaration.

Code is Poetry.