Skip to content

Latest commit

 

History

History
431 lines (314 loc) · 8.66 KB

README.md

File metadata and controls

431 lines (314 loc) · 8.66 KB

Extending the post editor UI

Extending the editor UI can be accomplished with the registerPlugin API, allowing you to define all your plugin's UI elements in one place.

Refer to the plugins module documentation for more information.

Plugin Components

The following components can be used with the registerPlugin (see documentation) API. They can be found in the global variable wp.editPost when defining wp-edit-post as a script dependency.

PluginBlockSettingsMenuItem

Renders a new item in the block settings menu.

Example:

{% codetabs %}

{% ES5 %}

var __ = wp.i18n.__;
var PluginBlockSettingsMenuItem = wp.editPost.PluginBlockSettingsMenuItem;

function doOnClick(){
	// To be called when the user clicks the menu item.
}

function MyPluginBlockSettingsMenuItem() {
	return el(
		PluginBlockSettingsMenuItem,
		{
			allowedBlockNames: [ 'core/paragraph' ],
			icon: 'dashicon-name',
			label: __( 'Menu item text' ),
			onClick: doOnClick,
		}
	);
}

{% ESNext %}

import { __ } from wp.i18n;
import { PluginBlockSettingsMenuItem } from wp.editPost;

const doOnClick = ( ) => {
    // To be called when the user clicks the menu item.
};

const MyPluginBlockSettingsMenuItem = () => (
    <PluginBlockSettingsMenuItem
		allowedBlockNames=[ 'core/paragraph' ]
		icon='dashicon-name'
		label=__( 'Menu item text' )
		onClick={ doOnClick } />
);

{% end %}

Props

allowedBlockNames

An array containing a whitelist of block names for which the item should be shown. If this prop is not present the item will be rendered for any block. If multiple blocks are selected, it'll be shown if and only if all of them are in the whitelist.

  • Type: Array
  • Required: No
  • Default: Menu item is shown for any block
icon

The Dashicon icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.

  • Type: String | Element
  • Required: No
  • Default: Menu item wil be rendered without icon
label

A string containing the menu item text.

  • Type: String
  • Required: Yes
onClick

The callback function to be executed when the user clicks the menu item.

  • Type: function
  • Required: Yes

PluginSidebar

Renders a sidebar when activated. The contents within the PluginSidebar will appear as content within the sidebar.

If you wish to display the sidebar, you can with use the PluginSidebarMoreMenuItem component or the wp.data.dispatch API:

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

Example:

{% codetabs %}

{% ES5 %}

var __ = wp.i18n.__;
var el = wp.element.createElement;
var PanelBody = wp.components.PanelBody;
var PluginSidebar = wp.editPost.PluginSidebar;


function MyPluginSidebar() {
	return el(
			PluginSidebar,
			{
				name: 'my-sidebar',
				title: 'My sidebar title',
				icon: 'smiley',
			},
			el(
				PanelBody,
				{},
				__( 'My sidebar content' )
			)
	);
}

{% ESNext %}

const { __ } = wp.i18n;
const { PanelBody } = wp.components;
const { PluginSidebar } = wp.editPost;

const MyPluginSidebar = () => (
	<PluginSidebar
		name="my-sidebar"
		title="My sidebar title"
		icon="smiley"
	>
		<PanelBody>
			{ __( 'My sidebar content' ) }
		</PanelBody>
	</PluginSidebar>
);

{% end %}

Props

name

A string identifying the sidebar. Must be unique for every sidebar registered within the scope of your plugin.

  • Type: String
  • Required: Yes
title

Title displayed at the top of the sidebar.

  • Type: String
  • Required: Yes
isPinnable

Whether to allow to pin sidebar to toolbar.

  • Type: Boolean
  • Required: No
  • Default: true
icon

The Dashicon icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.

  • Type: String | Element
  • Required: No
  • Default: inherits from the plugin

PluginSidebarMoreMenuItem

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.

Example:

{% codetabs %}

{% ES5 %}

var __ = wp.i18n.__;
var PluginSidebarMoreMenuItem = wp.editPost.PluginSidebarMoreMenuItem;
var el = wp.element.createElement;

function MySidebarMoreMenuItem() {
	return el(
		PluginSidebarMoreMenuItem,
		{
			target: 'my-sidebar',
			icon: 'smiley',
		},
		__( 'My sidebar title' )
	)
}

{% ESNext %}

const { __ } = wp.i18n;
const { PluginSidebarMoreMenuItem } = wp.editPost;

const MySidebarMoreMenuItem = () => (
	<PluginSidebarMoreMenuItem
		target="my-sidebar"
		icon="smiley"
	>
		{ __( 'My sidebar title' ) }
	</PluginSidebarMoreMenuItem>
);

{% end %}

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.

  • Type: String
  • Required: Yes
icon

The Dashicon icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.

  • Type: String | Element
  • Required: No
  • Default: inherits from the plugin

PluginPostStatusInfo

Renders a row in the Status & Visibility panel of the Document sidebar. It should be noted that this is named and implemented around the function it serves and not its location, which may change in future iterations.

Example:

{% codetabs %}

{% ES5 %}

var __ = wp.i18n.__;
var PluginPostStatusInfo = wp.editPost.PluginPostStatusInfo;
var el = wp.element.createElement;

function MyPluginPostStatusInfo() {
	return el(
		PluginPostStatusInfo,
		{
			className: 'my-plugin-post-status-info',
		},
		__( 'My post status info' )
	)
}

{% ESNext %}

const { __ } = wp.i18n;
const { PluginPostStatusInfo } = wp.editPost;

const MyPluginPostStatusInfo = () => (
	<PluginPostStatusInfo
		className="my-plugin-post-status-info"
	>
		{ __( 'My post status info' ) }
	</PluginPostStatusInfo>
);

{% end %}

Props

className

An optional class name added to the row.

  • Type: String
  • Required: No

PluginPrePublishPanel

Renders provided content to the pre-publish side panel in the publish flow (side panel that opens when a user first pushes "Publish" from the main editor).

Example:

{% codetabs %}

{% ES5 %}

var __ = wp.i18n.__;
var PluginPrePublishPanel = wp.editPost.PluginPrePublishPanel;
var el = wp.element.createElement;

function MyPluginPrePublishPanel() {
	return el(
		PluginPrePublishPanel,
		{
			className: 'my-plugin-pre-publish-panel',
			title: __( 'My panel title' ),
			initialOpen: true,
		},
		__( 'My panel content' )
	);
}

{% ESNext %}

const { __ } = wp.i18n;
const { PluginPrePublishPanel } = wp.editPost;

const MyPluginPrePublishPanel = () => (
	<PluginPrePublishPanel
		className="my-plugin-pre-publish-panel"
		title={ __( 'My panel title' ) }
		initialOpen={ true }
	>
	    { __( 'My panel content' ) }
	</PluginPrePublishPanel>
);

{% end %}

Props

className

An optional class name added to the panel.

  • Type: String
  • Required: No
title

Title displayed at the top of the panel.

  • Type: String
  • Required: No
initialOpen

Whether to have the panel initially opened. When no title is provided it is always opened.

  • Type: Boolean
  • Required: No
  • Default: false

PluginPostPublishPanel

Renders provided content to the post-publish panel in the publish flow (side panel that opens after a user publishes the post).

Example:

{% codetabs %}

{% ES5 %}

var __ = wp.i18n.__;
var PluginPostPublishPanel = wp.editPost.PluginPostPublishPanel;
var el = wp.element.createElement;

function MyPluginPostPublishPanel() {
	return el(
		PluginPostPublishPanel,
		{
			className: 'my-plugin-post-publish-panel',
			title: __( 'My panel title' ),
			initialOpen: true,
		},
		__( 'My panel content' )
	);
}

{% ESNext %}

const { __ } = wp.i18n;
const { PluginPostPublishPanel } = wp.editPost;

const MyPluginPostPublishPanel = () => (
	<PluginPostPublishPanel
		className="my-plugin-post-publish-panel"
		title={ __( 'My panel title' ) }
		initialOpen={ true }
	>
        { __( 'My panel content' ) }
	</PluginPostPublishPanel>
);

{% end %}

Props

className

An optional class name added to the panel.

  • Type: String
  • Required: No
title

Title displayed at the top of the panel.

  • Type: String
  • Required: No
initialOpen

Whether to have the panel initially opened. When no title is provided it is always opened.

  • Type: Boolean
  • Required: No
  • Default: false