@wordpress/editor
Version:
Enhanced block editor for WordPress posts.
67 lines (66 loc) • 2.5 kB
JavaScript
/**
* WordPress dependencies
*/
import { createSlotFill, PanelBody } from '@wordpress/components';
import { usePluginContext } from '@wordpress/plugins';
import { jsx as _jsx } from "react/jsx-runtime";
const {
Fill,
Slot
} = createSlotFill('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).
*
* @param {Object} props Component props.
* @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.
* @param {Element} props.children Children to be rendered
*
* @example
* ```jsx
* // Using ESNext syntax
* import { __ } from '@wordpress/i18n';
* import { PluginPrePublishPanel } from '@wordpress/editor';
*
* const MyPluginPrePublishPanel = () => (
* <PluginPrePublishPanel
* className="my-plugin-pre-publish-panel"
* title={ __( 'My panel title' ) }
* initialOpen={ true }
* >
* { __( 'My panel content' ) }
* </PluginPrePublishPanel>
* );
* ```
*
* @return {Component} The component to be rendered.
*/
const PluginPrePublishPanel = ({
children,
className,
title,
initialOpen = false,
icon
}) => {
const {
icon: pluginIcon
} = usePluginContext();
return /*#__PURE__*/_jsx(Fill, {
children: /*#__PURE__*/_jsx(PanelBody, {
className: className,
initialOpen: initialOpen || !title,
title: title,
icon: icon !== null && icon !== void 0 ? icon : pluginIcon,
children: children
})
});
};
PluginPrePublishPanel.Slot = Slot;
export default PluginPrePublishPanel;
//# sourceMappingURL=index.js.map