From 78b39255a68638a03dce738894994516f71396dc Mon Sep 17 00:00:00 2001 From: Riad Benguella Date: Fri, 18 Oct 2019 12:26:16 +0100 Subject: [PATCH] Adding JSDoc for the parents selector --- .../developers/data/data-core-block-editor.md | 11 ++++++++++- packages/block-editor/src/store/selectors.js | 8 ++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/designers-developers/developers/data/data-core-block-editor.md b/docs/designers-developers/developers/data/data-core-block-editor.md index 11db9dd6608ec9..c0289d9689ac28 100644 --- a/docs/designers-developers/developers/data/data-core-block-editor.md +++ b/docs/designers-developers/developers/data/data-core-block-editor.md @@ -191,7 +191,16 @@ _Returns_ # **getBlockParents** -Undocumented declaration. +Given a block client ID, returns the list of all its parents. + +_Parameters_ + +- _state_ `Object`: Editor state. +- _clientId_ `string`: Block from which to find root client ID. + +_Returns_ + +- `Array`: ClientIDs of the parent blocks. # **getBlockRootClientId** diff --git a/packages/block-editor/src/store/selectors.js b/packages/block-editor/src/store/selectors.js index e50996354c8218..3db525cec3da63 100644 --- a/packages/block-editor/src/store/selectors.js +++ b/packages/block-editor/src/store/selectors.js @@ -418,6 +418,14 @@ export function getBlockRootClientId( state, clientId ) { null; } +/** + * Given a block client ID, returns the list of all its parents. + * + * @param {Object} state Editor state. + * @param {string} clientId Block from which to find root client ID. + * + * @return {Array} ClientIDs of the parent blocks. + */ export const getBlockParents = createSelector( ( state, clientId ) => { const parents = [];