UNPKG

@wordpress/block-editor

Version:
193 lines (162 loc) 6.62 kB
"use strict"; var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault"); Object.defineProperty(exports, "__esModule", { value: true }); exports.default = void 0; exports.useInnerBlocksProps = useInnerBlocksProps; var _element = require("@wordpress/element"); var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")); var _blocks = require("@wordpress/blocks"); var _buttonBlockAppender = _interopRequireDefault(require("./button-block-appender")); var _defaultBlockAppender = _interopRequireDefault(require("./default-block-appender")); var _useNestedSettingsUpdate = _interopRequireDefault(require("./use-nested-settings-update")); var _useInnerBlockTemplateSync = _interopRequireDefault(require("./use-inner-block-template-sync")); var _useBlockContext = _interopRequireDefault(require("./use-block-context")); var _blockList = _interopRequireDefault(require("../block-list")); var _context = require("../block-edit/context"); var _useBlockSync = _interopRequireDefault(require("../provider/use-block-sync")); var _blockContext = require("../block-context"); var _layout = require("../block-list/layout"); /** * WordPress dependencies */ /** * Internal dependencies */ /** * Internal dependencies */ /** * This hook is used to lightly mark an element as an inner blocks wrapper * element. Call this hook and pass the returned props to the element to mark as * an inner blocks wrapper, automatically rendering inner blocks as children. If * you define a ref for the element, it is important to pass the ref to this * hook, which the hook in turn will pass to the component through the props it * returns. Optionally, you can also pass any other props through this hook, and * they will be merged and returned. * * @param {Object} props Optional. Props to pass to the element. Must contain * the ref if one is defined. * @param {Object} options Optional. Inner blocks options. * * @see https://github.com/WordPress/gutenberg/blob/master/packages/block-editor/src/components/inner-blocks/README.md */ function useInnerBlocksProps(props = {}, options = {}) { const fallbackRef = (0, _element.useRef)(); const { clientId } = (0, _context.useBlockEditContext)(); const ref = props.ref || fallbackRef; const InnerBlocks = options.value && options.onChange ? ControlledInnerBlocks : UncontrolledInnerBlocks; return { ...props, ref, children: (0, _element.createElement)(InnerBlocks, (0, _extends2.default)({}, options, { clientId: clientId, wrapperRef: ref })) }; } /** * InnerBlocks is a component which allows a single block to have multiple blocks * as children. The UncontrolledInnerBlocks component is used whenever the inner * blocks are not controlled by another entity. In other words, it is normally * used for inner blocks in the post editor * * @param {Object} props The component props. */ function UncontrolledInnerBlocks(props) { const { clientId, allowedBlocks, prioritizedInserterBlocks, __experimentalDefaultBlock, __experimentalDirectInsert, template, templateLock, templateInsertUpdatesSelection, __experimentalCaptureToolbars: captureToolbars, orientation, renderAppender, renderFooterAppender, parentWidth, horizontal, contentResizeMode, contentStyle, onAddBlock, onDeleteBlock, marginVertical, marginHorizontal, horizontalAlignment, filterInnerBlocks, blockWidth, __experimentalLayout: layout = _layout.defaultLayout, gridProperties } = props; const context = (0, _useBlockContext.default)(clientId); (0, _useNestedSettingsUpdate.default)(clientId, allowedBlocks, prioritizedInserterBlocks, __experimentalDefaultBlock, __experimentalDirectInsert, templateLock, captureToolbars, orientation, layout); (0, _useInnerBlockTemplateSync.default)(clientId, template, templateLock, templateInsertUpdatesSelection); return (0, _element.createElement)(_layout.LayoutProvider, { value: layout }, (0, _element.createElement)(_blockContext.BlockContextProvider, { value: context }, (0, _element.createElement)(_blockList.default, { marginVertical: marginVertical, marginHorizontal: marginHorizontal, rootClientId: clientId, renderAppender: renderAppender, renderFooterAppender: renderFooterAppender, withFooter: false, orientation: orientation, parentWidth: parentWidth, horizontalAlignment: horizontalAlignment, horizontal: horizontal, contentResizeMode: contentResizeMode, contentStyle: contentStyle, onAddBlock: onAddBlock, onDeleteBlock: onDeleteBlock, filterInnerBlocks: filterInnerBlocks, gridProperties: gridProperties, blockWidth: blockWidth }))); } /** * The controlled inner blocks component wraps the uncontrolled inner blocks * component with the blockSync hook. This keeps the innerBlocks of the block in * the block-editor store in sync with the blocks of the controlling entity. An * example of an inner block controller is a template part block, which provides * its own blocks from the template part entity data source. * * @param {Object} props The component props. */ function ControlledInnerBlocks(props) { (0, _useBlockSync.default)(props); return (0, _element.createElement)(UncontrolledInnerBlocks, props); } /** * Wrapped InnerBlocks component which detects whether to use the controlled or * uncontrolled variations of the InnerBlocks component. This is the component * which should be used throughout the application. * * @param {Object} props The component props. */ const InnerBlocks = props => { const { clientId } = (0, _context.useBlockEditContext)(); const allProps = { clientId, ...props }; // Detects if the InnerBlocks should be controlled by an incoming value. return props.value && props.onChange ? (0, _element.createElement)(ControlledInnerBlocks, allProps) : (0, _element.createElement)(UncontrolledInnerBlocks, allProps); }; // Expose default appender placeholders as components. InnerBlocks.DefaultBlockAppender = _defaultBlockAppender.default; InnerBlocks.ButtonBlockAppender = _buttonBlockAppender.default; useInnerBlocksProps.save = _blocks.__unstableGetInnerBlocksProps; InnerBlocks.Content = () => useInnerBlocksProps.save().children; /** * @see https://github.com/WordPress/gutenberg/blob/HEAD/packages/block-editor/src/components/inner-blocks/README.md */ var _default = InnerBlocks; exports.default = _default; //# sourceMappingURL=index.native.js.map