Add getBlockClientId docs

WordPress · Jan 3, 2020 · 96fd5fb · 96fd5fb
1 parent 48389d4
commit 96fd5fb
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/block-editor/src/utils/dom.js b/packages/block-editor/src/utils/dom.js
@@ -87,6 +87,13 @@ export function hasInnerBlocksContext( element ) {
 	return !! element.querySelector( '.block-editor-block-list__layout' );
 }
 
+/**
+ * Finds the block client ID given any DOM node inside the block.
+ *
+ * @param {Node} node DOM node.
+ *
+ * @return {?string} Client ID or undefined if the node is not part of a block.
+ */
 export function getBlockClientId( node ) {
 	if ( node.nodeType !== node.ELEMENT_NODE ) {
 		node = node.parentElement;