-
Notifications
You must be signed in to change notification settings - Fork 4.2k
/
block-hooks.js
258 lines (231 loc) · 6.93 KB
/
block-hooks.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { Fragment, useMemo } from '@wordpress/element';
import {
__experimentalHStack as HStack,
PanelBody,
ToggleControl,
} from '@wordpress/components';
import { createBlock, store as blocksStore } from '@wordpress/blocks';
import { useDispatch, useSelect } from '@wordpress/data';
/**
* Internal dependencies
*/
import { BlockIcon, InspectorControls } from '../components';
import { store as blockEditorStore } from '../store';
const EMPTY_OBJECT = {};
function BlockHooksControlPure( {
name,
clientId,
metadata: { ignoredHookedBlocks = [] } = {},
} ) {
const blockTypes = useSelect(
( select ) => select( blocksStore ).getBlockTypes(),
[]
);
// A hooked block added via a filter will not be exposed through a block
// type's `blockHooks` property; however, if the containing layout has been
// modified, it will be present in the anchor block's `ignoredHookedBlocks`
// metadata.
const hookedBlocksForCurrentBlock = useMemo(
() =>
blockTypes?.filter(
( { name: blockName, blockHooks } ) =>
( blockHooks && name in blockHooks ) ||
ignoredHookedBlocks.includes( blockName )
),
[ blockTypes, name, ignoredHookedBlocks ]
);
const { blockIndex, rootClientId, innerBlocksLength } = useSelect(
( select ) => {
const { getBlocks, getBlockIndex, getBlockRootClientId } =
select( blockEditorStore );
return {
blockIndex: getBlockIndex( clientId ),
innerBlocksLength: getBlocks( clientId )?.length,
rootClientId: getBlockRootClientId( clientId ),
};
},
[ clientId ]
);
const hookedBlockClientIds = useSelect(
( select ) => {
const { getBlocks, getGlobalBlockCount } =
select( blockEditorStore );
const _hookedBlockClientIds = hookedBlocksForCurrentBlock.reduce(
( clientIds, block ) => {
// If the block doesn't exist anywhere in the block tree,
// we know that we have to set the toggle to disabled.
if ( getGlobalBlockCount( block.name ) === 0 ) {
return clientIds;
}
const relativePosition = block?.blockHooks?.[ name ];
let candidates;
switch ( relativePosition ) {
case 'before':
case 'after':
// Any of the current block's siblings (with the right block type) qualifies
// as a hooked block (inserted `before` or `after` the current one), as the block
// might've been automatically inserted and then moved around a bit by the user.
candidates = getBlocks( rootClientId );
break;
case 'first_child':
case 'last_child':
// Any of the current block's child blocks (with the right block type) qualifies
// as a hooked first or last child block, as the block might've been automatically
// inserted and then moved around a bit by the user.
candidates = getBlocks( clientId );
break;
case undefined:
// If we haven't found a blockHooks field with a relative position for the hooked
// block, it means that it was added by a filter. In this case, we look for the block
// both among the current block's siblings and its children.
candidates = [
...getBlocks( rootClientId ),
...getBlocks( clientId ),
];
break;
}
const hookedBlock = candidates?.find(
( candidate ) => candidate.name === block.name
);
// If the block exists in the designated location, we consider it hooked
// and show the toggle as enabled.
if ( hookedBlock ) {
return {
...clientIds,
[ block.name ]: hookedBlock.clientId,
};
}
// If no hooked block was found in any of its designated locations,
// we set the toggle to disabled.
return clientIds;
},
{}
);
if ( Object.values( _hookedBlockClientIds ).length > 0 ) {
return _hookedBlockClientIds;
}
return EMPTY_OBJECT;
},
[ hookedBlocksForCurrentBlock, name, clientId, rootClientId ]
);
const { insertBlock, removeBlock } = useDispatch( blockEditorStore );
if ( ! hookedBlocksForCurrentBlock.length ) {
return null;
}
// Group by block namespace (i.e. prefix before the slash).
const groupedHookedBlocks = hookedBlocksForCurrentBlock.reduce(
( groups, block ) => {
const [ namespace ] = block.name.split( '/' );
if ( ! groups[ namespace ] ) {
groups[ namespace ] = [];
}
groups[ namespace ].push( block );
return groups;
},
{}
);
const insertBlockIntoDesignatedLocation = ( block, relativePosition ) => {
switch ( relativePosition ) {
case 'before':
case 'after':
insertBlock(
block,
relativePosition === 'after' ? blockIndex + 1 : blockIndex,
rootClientId, // Insert as a child of the current block's parent
false
);
break;
case 'first_child':
case 'last_child':
insertBlock(
block,
// TODO: It'd be great if insertBlock() would accept negative indices for insertion.
relativePosition === 'first_child' ? 0 : innerBlocksLength,
clientId, // Insert as a child of the current block.
false
);
break;
case undefined:
// If we do not know the relative position, it is because the block was
// added via a filter. In this case, we default to inserting it after the
// current block.
insertBlock(
block,
blockIndex + 1,
rootClientId, // Insert as a child of the current block's parent
false
);
break;
}
};
return (
<InspectorControls>
<PanelBody
className="block-editor-hooks__block-hooks"
title={ __( 'Plugins' ) }
initialOpen
>
<p className="block-editor-hooks__block-hooks-helptext">
{ __(
'Manage the inclusion of blocks added automatically by plugins.'
) }
</p>
{ Object.keys( groupedHookedBlocks ).map( ( vendor ) => {
return (
<Fragment key={ vendor }>
<h3>{ vendor }</h3>
{ groupedHookedBlocks[ vendor ].map( ( block ) => {
const checked =
block.name in hookedBlockClientIds;
return (
<ToggleControl
checked={ checked }
key={ block.title }
label={
<HStack justify="flex-start">
<BlockIcon
icon={ block.icon }
/>
<span>{ block.title }</span>
</HStack>
}
onChange={ () => {
if ( ! checked ) {
// Create and insert block.
const relativePosition =
block.blockHooks[ name ];
insertBlockIntoDesignatedLocation(
createBlock( block.name ),
relativePosition
);
return;
}
// Remove block.
removeBlock(
hookedBlockClientIds[
block.name
],
false
);
} }
/>
);
} ) }
</Fragment>
);
} ) }
</PanelBody>
</InspectorControls>
);
}
export default {
edit: BlockHooksControlPure,
attributeKeys: [ 'metadata' ],
hasSupport() {
return true;
},
};