UNPKG

@wordpress/components

Version:
80 lines (72 loc) 2.52 kB
import _extends from "@babel/runtime/helpers/esm/extends"; import { createElement } from "@wordpress/element"; /** * External dependencies */ import classnames from 'classnames'; /** * WordPress dependencies */ import { useResizeObserver } from '@wordpress/compose'; /** * Internal dependencies */ import Icon from '../icon'; /** * Renders a placeholder. Normally used by blocks to render their empty state. * * @param {Object} props The component props. * @param {WPIcon} props.icon An icon rendered before the label. * @param {WPElement} props.children Children to be rendered. * @param {string} props.label Title of the placeholder. * @param {string} props.instructions Instructions of the placeholder. * @param {string} props.className Class to set on the container div. * @param {Object} props.notices A rendered notices list. * @param {Object} props.preview Preview to be rendered in the placeholder. * @param {boolean} props.isColumnLayout Whether a column layout should be used. * * @return {Object} The rendered placeholder. */ function Placeholder({ icon, children, label, instructions, className, notices, preview, isColumnLayout, ...additionalProps }) { const [resizeListener, { width }] = useResizeObserver(); // Since `useResizeObserver` will report a width of `null` until after the // first render, avoid applying any modifier classes until width is known. let modifierClassNames; if (typeof width === 'number') { modifierClassNames = { 'is-large': width >= 320, 'is-medium': width >= 160 && width < 320, 'is-small': width < 160 }; } const classes = classnames('components-placeholder', className, modifierClassNames); const fieldsetClasses = classnames('components-placeholder__fieldset', { 'is-column-layout': isColumnLayout }); return createElement("div", _extends({}, additionalProps, { className: classes }), resizeListener, notices, preview && createElement("div", { className: "components-placeholder__preview" }, preview), createElement("div", { className: "components-placeholder__label" }, createElement(Icon, { icon: icon }), label), !!instructions && createElement("div", { className: "components-placeholder__instructions" }, instructions), createElement("div", { className: fieldsetClasses }, children)); } export default Placeholder; //# sourceMappingURL=index.js.map