-
Notifications
You must be signed in to change notification settings - Fork 4k
/
index.js
353 lines (333 loc) · 8.75 KB
/
index.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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
/**
* WordPress dependencies
*/
import { serialize } from '@wordpress/blocks';
import { useSelect, useDispatch } from '@wordpress/data';
import {
BlockSettingsMenuControls,
useBlockProps,
Warning,
store as blockEditorStore,
RecursionProvider,
useHasRecursion,
InspectorControls,
__experimentalBlockPatternsList as BlockPatternsList,
BlockControls,
} from '@wordpress/block-editor';
import {
PanelBody,
Spinner,
Modal,
MenuItem,
ToolbarButton,
} from '@wordpress/components';
import { useAsyncList } from '@wordpress/compose';
import { __, sprintf } from '@wordpress/i18n';
import { store as coreStore } from '@wordpress/core-data';
import { useState } from '@wordpress/element';
import { store as noticesStore } from '@wordpress/notices';
/**
* Internal dependencies
*/
import TemplatePartPlaceholder from './placeholder';
import TemplatePartSelectionModal from './selection-modal';
import { TemplatePartAdvancedControls } from './advanced-controls';
import TemplatePartInnerBlocks from './inner-blocks';
import { createTemplatePartId } from './utils/create-template-part-id';
import {
useAlternativeBlockPatterns,
useAlternativeTemplateParts,
useTemplatePartArea,
} from './utils/hooks';
function ReplaceButton( {
isEntityAvailable,
area,
templatePartId,
isTemplatePartSelectionOpen,
setIsTemplatePartSelectionOpen,
} ) {
// This hook fetches patterns, so don't run it unconditionally in the main
// edit function!
const { templateParts } = useAlternativeTemplateParts(
area,
templatePartId
);
const hasReplacements = !! templateParts.length;
const canReplace =
isEntityAvailable &&
hasReplacements &&
( area === 'header' || area === 'footer' );
if ( ! canReplace ) {
return null;
}
return (
<MenuItem
onClick={ () => {
setIsTemplatePartSelectionOpen( true );
} }
aria-expanded={ isTemplatePartSelectionOpen }
aria-haspopup="dialog"
>
{ __( 'Replace' ) }
</MenuItem>
);
}
function TemplatesList( { area, clientId, isEntityAvailable, onSelect } ) {
// This hook fetches patterns, so don't run it unconditionally in the main
// edit function!
const blockPatterns = useAlternativeBlockPatterns( area, clientId );
const canReplace =
isEntityAvailable &&
!! blockPatterns.length &&
( area === 'header' || area === 'footer' );
const shownTemplates = useAsyncList( blockPatterns );
if ( ! canReplace ) {
return null;
}
return (
<PanelBody title={ __( 'Design' ) }>
<BlockPatternsList
label={ __( 'Templates' ) }
blockPatterns={ blockPatterns }
shownPatterns={ shownTemplates }
onClickPattern={ onSelect }
showTitle={ false }
/>
</PanelBody>
);
}
export default function TemplatePartEdit( {
attributes,
setAttributes,
clientId,
} ) {
const { createSuccessNotice } = useDispatch( noticesStore );
const { editEntityRecord } = useDispatch( coreStore );
const currentTheme = useSelect(
( select ) => select( coreStore ).getCurrentTheme()?.stylesheet,
[]
);
const { slug, theme = currentTheme, tagName, layout = {} } = attributes;
const templatePartId = createTemplatePartId( theme, slug );
const hasAlreadyRendered = useHasRecursion( templatePartId );
const [ isTemplatePartSelectionOpen, setIsTemplatePartSelectionOpen ] =
useState( false );
const {
isResolved,
hasInnerBlocks,
isMissing,
area,
onNavigateToEntityRecord,
title,
canEditTemplate,
} = useSelect(
( select ) => {
const { getEditedEntityRecord, hasFinishedResolution } =
select( coreStore );
const { getBlockCount, getSettings } = select( blockEditorStore );
const getEntityArgs = [
'postType',
'wp_template_part',
templatePartId,
];
const entityRecord = templatePartId
? getEditedEntityRecord( ...getEntityArgs )
: null;
const _area = entityRecord?.area || attributes.area;
const hasResolvedEntity = templatePartId
? hasFinishedResolution(
'getEditedEntityRecord',
getEntityArgs
)
: false;
const _canEditTemplate =
select( coreStore ).canUser( 'create', 'templates' ) ?? false;
return {
hasInnerBlocks: getBlockCount( clientId ) > 0,
isResolved: hasResolvedEntity,
isMissing:
hasResolvedEntity &&
( ! entityRecord ||
Object.keys( entityRecord ).length === 0 ),
area: _area,
onNavigateToEntityRecord:
getSettings().onNavigateToEntityRecord,
title: entityRecord?.title,
canEditTemplate: _canEditTemplate,
};
},
[ templatePartId, attributes.area, clientId ]
);
const areaObject = useTemplatePartArea( area );
const blockProps = useBlockProps();
const isPlaceholder = ! slug;
const isEntityAvailable = ! isPlaceholder && ! isMissing && isResolved;
const TagName = tagName || areaObject.tagName;
const onPatternSelect = async ( pattern ) => {
await editEntityRecord(
'postType',
'wp_template_part',
templatePartId,
{
blocks: pattern.blocks,
content: serialize( pattern.blocks ),
}
);
createSuccessNotice(
sprintf(
/* translators: %s: template part title. */
__( 'Template Part "%s" updated.' ),
title || slug
),
{
type: 'snackbar',
}
);
};
// We don't want to render a missing state if we have any inner blocks.
// A new template part is automatically created if we have any inner blocks but no entity.
if (
! hasInnerBlocks &&
( ( slug && ! theme ) || ( slug && isMissing ) )
) {
return (
<TagName { ...blockProps }>
<Warning>
{ sprintf(
/* translators: %s: Template part slug */
__(
'Template part has been deleted or is unavailable: %s'
),
slug
) }
</Warning>
</TagName>
);
}
if ( isEntityAvailable && hasAlreadyRendered ) {
return (
<TagName { ...blockProps }>
<Warning>
{ __( 'Block cannot be rendered inside itself.' ) }
</Warning>
</TagName>
);
}
return (
<>
<RecursionProvider uniqueId={ templatePartId }>
{ isEntityAvailable &&
onNavigateToEntityRecord &&
canEditTemplate && (
<BlockControls group="other">
<ToolbarButton
onClick={ () =>
onNavigateToEntityRecord( {
postId: templatePartId,
postType: 'wp_template_part',
} )
}
>
{ __( 'Edit' ) }
</ToolbarButton>
</BlockControls>
) }
<InspectorControls group="advanced">
<TemplatePartAdvancedControls
tagName={ tagName }
setAttributes={ setAttributes }
isEntityAvailable={ isEntityAvailable }
templatePartId={ templatePartId }
defaultWrapper={ areaObject.tagName }
hasInnerBlocks={ hasInnerBlocks }
/>
</InspectorControls>
{ isPlaceholder && (
<TagName { ...blockProps }>
<TemplatePartPlaceholder
area={ attributes.area }
templatePartId={ templatePartId }
clientId={ clientId }
setAttributes={ setAttributes }
onOpenSelectionModal={ () =>
setIsTemplatePartSelectionOpen( true )
}
/>
</TagName>
) }
<BlockSettingsMenuControls>
{ ( { selectedClientIds } ) => {
// Only enable for single selection that matches the current block.
// Ensures menu item doesn't render multiple times.
if (
! (
selectedClientIds.length === 1 &&
clientId === selectedClientIds[ 0 ]
)
) {
return null;
}
return (
<ReplaceButton
{ ...{
isEntityAvailable,
area,
clientId,
templatePartId,
isTemplatePartSelectionOpen,
setIsTemplatePartSelectionOpen,
} }
/>
);
} }
</BlockSettingsMenuControls>
<InspectorControls>
<TemplatesList
area={ area }
clientId={ clientId }
isEntityAvailable={ isEntityAvailable }
onSelect={ ( pattern ) => onPatternSelect( pattern ) }
/>
</InspectorControls>
{ isEntityAvailable && (
<TemplatePartInnerBlocks
tagName={ TagName }
blockProps={ blockProps }
postId={ templatePartId }
hasInnerBlocks={ hasInnerBlocks }
layout={ layout }
/>
) }
{ ! isPlaceholder && ! isResolved && (
<TagName { ...blockProps }>
<Spinner />
</TagName>
) }
</RecursionProvider>
{ isTemplatePartSelectionOpen && (
<Modal
overlayClassName="block-editor-template-part__selection-modal"
title={ sprintf(
// Translators: %s as template part area title ("Header", "Footer", etc.).
__( 'Choose a %s' ),
areaObject.label.toLowerCase()
) }
onRequestClose={ () =>
setIsTemplatePartSelectionOpen( false )
}
isFullScreen
>
<TemplatePartSelectionModal
templatePartId={ templatePartId }
clientId={ clientId }
area={ area }
setAttributes={ setAttributes }
onClose={ () =>
setIsTemplatePartSelectionOpen( false )
}
/>
</Modal>
) }
</>
);
}