@wordpress/edit-post
Version:
Edit Post module for WordPress.
83 lines (79 loc) • 2.5 kB
JavaScript
import { createElement } from "@wordpress/element";
/**
* WordPress dependencies
*/
import { compose } from '@wordpress/compose';
import { withPluginContext } from '@wordpress/plugins';
import { createSlotFill, PanelBody } from '@wordpress/components';
const {
Fill,
Slot
} = createSlotFill('PluginPostPublishPanel');
const PluginPostPublishPanelFill = ({
children,
className,
title,
initialOpen = false,
icon
}) => createElement(Fill, null, createElement(PanelBody, {
className: className,
initialOpen: initialOpen || !title,
title: title,
icon: icon
}, children));
/**
* Renders provided content to the post-publish panel in the publish flow
* (side panel that opens after a user publishes the post).
*
* @param {Object} props Component properties.
* @param {string} [props.className] An optional class name added to the panel.
* @param {string} [props.title] Title displayed at the top of the panel.
* @param {boolean} [props.initialOpen=false] Whether to have the panel initially opened. When no title is provided it is always opened.
* @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.
*
* @example
* ```js
* // Using ES5 syntax
* var __ = wp.i18n.__;
* var PluginPostPublishPanel = wp.editPost.PluginPostPublishPanel;
*
* function MyPluginPostPublishPanel() {
* return wp.element.createElement(
* PluginPostPublishPanel,
* {
* className: 'my-plugin-post-publish-panel',
* title: __( 'My panel title' ),
* initialOpen: true,
* },
* __( 'My panel content' )
* );
* }
* ```
*
* @example
* ```jsx
* // Using ESNext syntax
* import { __ } from '@wordpress/i18n';
* import { PluginPostPublishPanel } from '@wordpress/edit-post';
*
* const MyPluginPostPublishPanel = () => (
* <PluginPostPublishPanel
* className="my-plugin-post-publish-panel"
* title={ __( 'My panel title' ) }
* initialOpen={ true }
* >
* { __( 'My panel content' ) }
* </PluginPostPublishPanel>
* );
* ```
*
* @return {WPComponent} The component to be rendered.
*/
const PluginPostPublishPanel = compose(withPluginContext((context, ownProps) => {
return {
icon: ownProps.icon || context.icon
};
}))(PluginPostPublishPanelFill);
PluginPostPublishPanel.Slot = Slot;
export default PluginPostPublishPanel;
//# sourceMappingURL=index.js.map