@wordpress/block-editor 12.1.0 → 12.2.0

package/build/store/private-selectors.js

@@ -1,11 +1,34 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.getBlockEditingMode = void 0;
 exports.getLastInsertedBlocksClientIds = getLastInsertedBlocksClientIds;
 exports.isBlockInterfaceHidden = isBlockInterfaceHidden;
 
+var _rememo = _interopRequireDefault(require("rememo"));
+
+var _data = require("@wordpress/data");
+
+var _blocks = require("@wordpress/blocks");
+
+var _selectors = require("./selectors");
+
+/**
+ * External dependencies
+ */
+
+/**
+ * WordPress dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+
 /**
  * Returns true if the block interface is hidden, or false otherwise.
  *
@@ -29,4 +52,69 @@ function getLastInsertedBlocksClientIds(state) {
 
   return state === null || state === void 0 ? void 0 : (_state$lastBlockInser = state.lastBlockInserted) === null || _state$lastBlockInser === void 0 ? void 0 : _state$lastBlockInser.clientIds;
 }
+/**
+ * @typedef {import('../components/block-editing-mode').BlockEditingMode} BlockEditingMode
+ */
+
+/**
+ * Returns the block editing mode for a given block.
+ *
+ * The mode can be one of three options:
+ *
+ * - `'disabled'`: Prevents editing the block entirely, i.e. it cannot be
+ *   selected.
+ * - `'contentOnly'`: Hides all non-content UI, e.g. auxiliary controls in the
+ *   toolbar, the block movers, block settings.
+ * - `'default'`: Allows editing the block as normal.
+ *
+ * Blocks can set a mode using the `useBlockEditingMode` hook.
+ *
+ * The mode is inherited by all of the block's inner blocks, unless they have
+ * their own mode.
+ *
+ * A template lock can also set a mode. If the template lock is `'contentOnly'`,
+ * the block's mode is overridden to `'contentOnly'` if the block has a content
+ * role attribute, or `'disabled'` otherwise.
+ *
+ * @see useBlockEditingMode
+ *
+ * @param {Object} state    Global application state.
+ * @param {string} clientId The block client ID, or `''` for the root container.
+ *
+ * @return {BlockEditingMode} The block editing mode. One of `'disabled'`,
+ *                            `'contentOnly'`, or `'default'`.
+ */
+
+
+const getBlockEditingMode = (0, _data.createRegistrySelector)(select => function (state) {
+  let clientId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+  const explicitEditingMode = getExplcitBlockEditingMode(state, clientId);
+  const rootClientId = (0, _selectors.getBlockRootClientId)(state, clientId);
+  const templateLock = (0, _selectors.getTemplateLock)(state, rootClientId);
+  const name = (0, _selectors.getBlockName)(state, clientId);
+
+  const isContent = select(_blocks.store).__experimentalHasContentRoleAttribute(name);
+
+  if (explicitEditingMode === 'disabled' || templateLock === 'contentOnly' && !isContent) {
+    return 'disabled';
+  }
+
+  if (explicitEditingMode === 'contentOnly' || templateLock === 'contentOnly' && isContent) {
+    return 'contentOnly';
+  }
+
+  return 'default';
+});
+exports.getBlockEditingMode = getBlockEditingMode;
+const getExplcitBlockEditingMode = (0, _rememo.default)(function (state) {
+  var _state$blockEditingMo;
+
+  let clientId = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+
+  while (!state.blockEditingModes.has(clientId) && state.blocks.parents.has(clientId)) {
+    clientId = state.blocks.parents.get(clientId);
+  }
+
+  return (_state$blockEditingMo = state.blockEditingModes.get(clientId)) !== null && _state$blockEditingMo !== void 0 ? _state$blockEditingMo : 'default';
+}, state => [state.blockEditingModes, state.blocks.parents]);
 //# sourceMappingURL=private-selectors.js.map

package/build/store/private-selectors.js.map

@@ -1 +1 @@
-{"version":3,"sources":["@wordpress/block-editor/src/store/private-selectors.js"],"names":["isBlockInterfaceHidden","state","getLastInsertedBlocksClientIds","lastBlockInserted","clientIds"],"mappings":";;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,sBAAT,CAAiCC,KAAjC,EAAyC;AAC/C,SAAOA,KAAK,CAACD,sBAAb;AACA;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASE,8BAAT,CAAyCD,KAAzC,EAAiD;AAAA;;AACvD,SAAOA,KAAP,aAAOA,KAAP,gDAAOA,KAAK,CAAEE,iBAAd,0DAAO,sBAA0BC,SAAjC;AACA","sourcesContent":["/**\n * Returns true if the block interface is hidden, or false otherwise.\n *\n * @param {Object} state Global application state.\n *\n * @return {boolean} Whether the block toolbar is hidden.\n */\nexport function isBlockInterfaceHidden( state ) {\n\treturn state.isBlockInterfaceHidden;\n}\n\n/**\n * Gets the client ids of the last inserted blocks.\n *\n * @param {Object} state Global application state.\n * @return {Array|undefined} Client Ids of the last inserted block(s).\n */\nexport function getLastInsertedBlocksClientIds( state ) {\n\treturn state?.lastBlockInserted?.clientIds;\n}\n"]}
+{"version":3,"sources":["@wordpress/block-editor/src/store/private-selectors.js"],"names":["isBlockInterfaceHidden","state","getLastInsertedBlocksClientIds","lastBlockInserted","clientIds","getBlockEditingMode","select","clientId","explicitEditingMode","getExplcitBlockEditingMode","rootClientId","templateLock","name","isContent","blocksStore","__experimentalHasContentRoleAttribute","blockEditingModes","has","blocks","parents","get"],"mappings":";;;;;;;;;;;AAGA;;AAKA;;AACA;;AAKA;;AAdA;AACA;AACA;;AAGA;AACA;AACA;;AAIA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,sBAAT,CAAiCC,KAAjC,EAAyC;AAC/C,SAAOA,KAAK,CAACD,sBAAb;AACA;AAED;AACA;AACA;AACA;AACA;AACA;;;AACO,SAASE,8BAAT,CAAyCD,KAAzC,EAAiD;AAAA;;AACvD,SAAOA,KAAP,aAAOA,KAAP,gDAAOA,KAAK,CAAEE,iBAAd,0DAAO,sBAA0BC,SAAjC;AACA;AAED;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACO,MAAMC,mBAAmB,GAAG,kCAChCC,MAAF,IACC,UAAEL,KAAF,EAA4B;AAAA,MAAnBM,QAAmB,uEAAR,EAAQ;AAC3B,QAAMC,mBAAmB,GAAGC,0BAA0B,CACrDR,KADqD,EAErDM,QAFqD,CAAtD;AAIA,QAAMG,YAAY,GAAG,qCAAsBT,KAAtB,EAA6BM,QAA7B,CAArB;AACA,QAAMI,YAAY,GAAG,gCAAiBV,KAAjB,EAAwBS,YAAxB,CAArB;AACA,QAAME,IAAI,GAAG,6BAAcX,KAAd,EAAqBM,QAArB,CAAb;;AACA,QAAMM,SAAS,GACdP,MAAM,CAAEQ,aAAF,CAAN,CAAsBC,qCAAtB,CACCH,IADD,CADD;;AAIA,MACCJ,mBAAmB,KAAK,UAAxB,IACEG,YAAY,KAAK,aAAjB,IAAkC,CAAEE,SAFvC,EAGE;AACD,WAAO,UAAP;AACA;;AACD,MACCL,mBAAmB,KAAK,aAAxB,IACEG,YAAY,KAAK,aAAjB,IAAkCE,SAFrC,EAGE;AACD,WAAO,aAAP;AACA;;AACD,SAAO,SAAP;AACA,CA3BgC,CAA5B;;AA8BP,MAAMJ,0BAA0B,GAAG,qBAClC,UAAER,KAAF,EAA4B;AAAA;;AAAA,MAAnBM,QAAmB,uEAAR,EAAQ;;AAC3B,SACC,CAAEN,KAAK,CAACe,iBAAN,CAAwBC,GAAxB,CAA6BV,QAA7B,CAAF,IACAN,KAAK,CAACiB,MAAN,CAAaC,OAAb,CAAqBF,GAArB,CAA0BV,QAA1B,CAFD,EAGE;AACDA,IAAAA,QAAQ,GAAGN,KAAK,CAACiB,MAAN,CAAaC,OAAb,CAAqBC,GAArB,CAA0Bb,QAA1B,CAAX;AACA;;AACD,kCAAON,KAAK,CAACe,iBAAN,CAAwBI,GAAxB,CAA6Bb,QAA7B,CAAP,yEAAkD,SAAlD;AACA,CATiC,EAUhCN,KAAF,IAAa,CAAEA,KAAK,CAACe,iBAAR,EAA2Bf,KAAK,CAACiB,MAAN,CAAaC,OAAxC,CAVqB,CAAnC","sourcesContent":["/**\n * External dependencies\n */\nimport createSelector from 'rememo';\n\n/**\n * WordPress dependencies\n */\nimport { createRegistrySelector } from '@wordpress/data';\nimport { store as blocksStore } from '@wordpress/blocks';\n\n/**\n * Internal dependencies\n */\nimport {\n\tgetBlockRootClientId,\n\tgetTemplateLock,\n\tgetBlockName,\n} from './selectors';\n\n/**\n * Returns true if the block interface is hidden, or false otherwise.\n *\n * @param {Object} state Global application state.\n *\n * @return {boolean} Whether the block toolbar is hidden.\n */\nexport function isBlockInterfaceHidden( state ) {\n\treturn state.isBlockInterfaceHidden;\n}\n\n/**\n * Gets the client ids of the last inserted blocks.\n *\n * @param {Object} state Global application state.\n * @return {Array|undefined} Client Ids of the last inserted block(s).\n */\nexport function getLastInsertedBlocksClientIds( state ) {\n\treturn state?.lastBlockInserted?.clientIds;\n}\n\n/**\n * @typedef {import('../components/block-editing-mode').BlockEditingMode} BlockEditingMode\n */\n\n/**\n * Returns the block editing mode for a given block.\n *\n * The mode can be one of three options:\n *\n * - `'disabled'`: Prevents editing the block entirely, i.e. it cannot be\n *   selected.\n * - `'contentOnly'`: Hides all non-content UI, e.g. auxiliary controls in the\n *   toolbar, the block movers, block settings.\n * - `'default'`: Allows editing the block as normal.\n *\n * Blocks can set a mode using the `useBlockEditingMode` hook.\n *\n * The mode is inherited by all of the block's inner blocks, unless they have\n * their own mode.\n *\n * A template lock can also set a mode. If the template lock is `'contentOnly'`,\n * the block's mode is overridden to `'contentOnly'` if the block has a content\n * role attribute, or `'disabled'` otherwise.\n *\n * @see useBlockEditingMode\n *\n * @param {Object} state    Global application state.\n * @param {string} clientId The block client ID, or `''` for the root container.\n *\n * @return {BlockEditingMode} The block editing mode. One of `'disabled'`,\n *                            `'contentOnly'`, or `'default'`.\n */\nexport const getBlockEditingMode = createRegistrySelector(\n\t( select ) =>\n\t\t( state, clientId = '' ) => {\n\t\t\tconst explicitEditingMode = getExplcitBlockEditingMode(\n\t\t\t\tstate,\n\t\t\t\tclientId\n\t\t\t);\n\t\t\tconst rootClientId = getBlockRootClientId( state, clientId );\n\t\t\tconst templateLock = getTemplateLock( state, rootClientId );\n\t\t\tconst name = getBlockName( state, clientId );\n\t\t\tconst isContent =\n\t\t\t\tselect( blocksStore ).__experimentalHasContentRoleAttribute(\n\t\t\t\t\tname\n\t\t\t\t);\n\t\t\tif (\n\t\t\t\texplicitEditingMode === 'disabled' ||\n\t\t\t\t( templateLock === 'contentOnly' && ! isContent )\n\t\t\t) {\n\t\t\t\treturn 'disabled';\n\t\t\t}\n\t\t\tif (\n\t\t\t\texplicitEditingMode === 'contentOnly' ||\n\t\t\t\t( templateLock === 'contentOnly' && isContent )\n\t\t\t) {\n\t\t\t\treturn 'contentOnly';\n\t\t\t}\n\t\t\treturn 'default';\n\t\t}\n);\n\nconst getExplcitBlockEditingMode = createSelector(\n\t( state, clientId = '' ) => {\n\t\twhile (\n\t\t\t! state.blockEditingModes.has( clientId ) &&\n\t\t\tstate.blocks.parents.has( clientId )\n\t\t) {\n\t\t\tclientId = state.blocks.parents.get( clientId );\n\t\t}\n\t\treturn state.blockEditingModes.get( clientId ) ?? 'default';\n\t},\n\t( state ) => [ state.blockEditingModes, state.blocks.parents ]\n);\n"]}

package/build/store/reducer.js

@@ -5,6 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.blockEditingModes = blockEditingModes;
 exports.blockListSettings = void 0;
 exports.blockVisibility = blockVisibility;
 exports.blocks = void 0;
@@ -1916,6 +1917,39 @@ function temporarilyEditingAsBlocks() {
 
   return state;
 }
+/**
+ * Reducer returning a map of block client IDs to block editing modes.
+ *
+ * @param {Map}    state  Current state.
+ * @param {Object} action Dispatched action.
+ *
+ * @return {Map} Updated state.
+ */
+
+
+function blockEditingModes() {
+  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new Map();
+  let action = arguments.length > 1 ? arguments[1] : undefined;
+
+  switch (action.type) {
+    case 'SET_BLOCK_EDITING_MODE':
+      return new Map(state).set(action.clientId, action.mode);
+
+    case 'UNSET_BLOCK_EDITING_MODE':
+      {
+        const newState = new Map(state);
+        newState.delete(action.clientId);
+        return newState;
+      }
+
+    case 'RESET_BLOCKS':
+      {
+        return state.has('') ? new Map().set('', state.get('')) : state;
+      }
+  }
+
+  return state;
+}
 
 const combinedReducers = (0, _data.combineReducers)({
   blocks,
@@ -1938,7 +1972,8 @@ const combinedReducers = (0, _data.combineReducers)({
   highlightedBlock,
   lastBlockInserted,
   temporarilyEditingAsBlocks,
-  blockVisibility
+  blockVisibility,
+  blockEditingModes
 });
 
 function withAutomaticChangeReset(reducer) {