-
Notifications
You must be signed in to change notification settings - Fork 4k
/
dimensions.js
363 lines (338 loc) · 9.63 KB
/
dimensions.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
354
355
356
357
358
359
360
361
362
363
/**
* External dependencies
*/
import classnames from 'classnames';
/**
* WordPress dependencies
*/
import {
__experimentalToolsPanelItem as ToolsPanelItem,
__experimentalVStack as VStack,
} from '@wordpress/components';
import { Platform, useState } from '@wordpress/element';
import { __ } from '@wordpress/i18n';
import { getBlockSupport } from '@wordpress/blocks';
import { useDispatch } from '@wordpress/data';
/**
* Internal dependencies
*/
import InspectorControls from '../components/inspector-controls';
import {
GapEdit,
hasGapSupport,
hasGapValue,
resetGap,
useIsGapDisabled,
} from './gap';
import {
MarginEdit,
MarginVisualizer,
hasMarginSupport,
hasMarginValue,
resetMargin,
useIsMarginDisabled,
} from './margin';
import {
MinHeightEdit,
hasMinHeightSupport,
hasMinHeightValue,
resetMinHeight,
useIsMinHeightDisabled,
} from './min-height';
import {
PaddingEdit,
PaddingVisualizer,
hasPaddingSupport,
hasPaddingValue,
resetPadding,
useIsPaddingDisabled,
} from './padding';
import {
ChildLayoutEdit,
hasChildLayoutSupport,
hasChildLayoutValue,
resetChildLayout,
useIsChildLayoutDisabled,
childLayoutOrientation,
} from './child-layout';
import useSetting from '../components/use-setting';
import { store as blockEditorStore } from '../store';
import { unlock } from '../lock-unlock';
export const DIMENSIONS_SUPPORT_KEY = 'dimensions';
export const SPACING_SUPPORT_KEY = 'spacing';
export const ALL_SIDES = [ 'top', 'right', 'bottom', 'left' ];
export const AXIAL_SIDES = [ 'vertical', 'horizontal' ];
function useVisualizerMouseOver() {
const [ isMouseOver, setIsMouseOver ] = useState( false );
const { hideBlockInterface, showBlockInterface } = unlock(
useDispatch( blockEditorStore )
);
const onMouseOver = ( e ) => {
e.stopPropagation();
hideBlockInterface();
setIsMouseOver( true );
};
const onMouseOut = ( e ) => {
e.stopPropagation();
showBlockInterface();
setIsMouseOver( false );
};
return { isMouseOver, onMouseOver, onMouseOut };
}
/**
* Inspector controls for dimensions support.
*
* @param {Object} props Block props.
*
* @return {WPElement} Inspector controls for dimensions and spacing support features.
*/
export function DimensionsPanel( props ) {
const isGapDisabled = useIsGapDisabled( props );
const isPaddingDisabled = useIsPaddingDisabled( props );
const isMarginDisabled = useIsMarginDisabled( props );
const isMinHeightDisabled = useIsMinHeightDisabled( props );
const isChildLayoutDisabled = useIsChildLayoutDisabled( props );
const isDisabled = useIsDimensionsDisabled( props );
const isSupported = hasDimensionsSupport( props );
const spacingSizes = useSetting( 'spacing.spacingSizes' );
const paddingMouseOver = useVisualizerMouseOver();
const marginMouseOver = useVisualizerMouseOver();
if ( isDisabled || ! isSupported ) {
return null;
}
const defaultDimensionsControls = getBlockSupport( props.name, [
DIMENSIONS_SUPPORT_KEY,
'__experimentalDefaultControls',
] );
const defaultSpacingControls = getBlockSupport( props.name, [
SPACING_SUPPORT_KEY,
'__experimentalDefaultControls',
] );
const createResetAllFilter =
( attribute, featureSet ) => ( newAttributes ) => ( {
...newAttributes,
style: {
...newAttributes.style,
[ featureSet ]: {
...newAttributes.style?.[ featureSet ],
[ attribute ]: undefined,
},
},
} );
const spacingClassnames = classnames( {
'tools-panel-item-spacing': spacingSizes && spacingSizes.length > 0,
} );
const { __unstableParentLayout: parentLayout } = props;
return (
<>
<InspectorControls group="dimensions">
{ ! isPaddingDisabled && (
<ToolsPanelItem
className={ spacingClassnames }
hasValue={ () => hasPaddingValue( props ) }
label={ __( 'Padding' ) }
onDeselect={ () => resetPadding( props ) }
resetAllFilter={ createResetAllFilter(
'padding',
'spacing'
) }
isShownByDefault={ defaultSpacingControls?.padding }
panelId={ props.clientId }
>
<PaddingEdit
onMouseOver={ paddingMouseOver.onMouseOver }
onMouseOut={ paddingMouseOver.onMouseOut }
{ ...props }
/>
</ToolsPanelItem>
) }
{ ! isMarginDisabled && (
<ToolsPanelItem
className={ spacingClassnames }
hasValue={ () => hasMarginValue( props ) }
label={ __( 'Margin' ) }
onDeselect={ () => resetMargin( props ) }
resetAllFilter={ createResetAllFilter(
'margin',
'spacing'
) }
isShownByDefault={ defaultSpacingControls?.margin }
panelId={ props.clientId }
>
<MarginEdit
onMouseOver={ marginMouseOver.onMouseOver }
onMouseOut={ marginMouseOver.onMouseOut }
{ ...props }
/>
</ToolsPanelItem>
) }
{ ! isGapDisabled && (
<ToolsPanelItem
className={ spacingClassnames }
hasValue={ () => hasGapValue( props ) }
label={ __( 'Block spacing' ) }
onDeselect={ () => resetGap( props ) }
resetAllFilter={ createResetAllFilter(
'blockGap',
'spacing'
) }
isShownByDefault={ defaultSpacingControls?.blockGap }
panelId={ props.clientId }
>
<GapEdit { ...props } />
</ToolsPanelItem>
) }
{ ! isMinHeightDisabled && (
<ToolsPanelItem
hasValue={ () => hasMinHeightValue( props ) }
label={ __( 'Min. height' ) }
onDeselect={ () => resetMinHeight( props ) }
resetAllFilter={ createResetAllFilter(
'minHeight',
'dimensions'
) }
isShownByDefault={
defaultDimensionsControls?.minHeight
}
panelId={ props.clientId }
>
<MinHeightEdit { ...props } />
</ToolsPanelItem>
) }
{ ! isChildLayoutDisabled && (
<VStack
as={ ToolsPanelItem }
spacing={ 2 }
hasValue={ () => hasChildLayoutValue( props ) }
label={ childLayoutOrientation( parentLayout ) }
onDeselect={ () => resetChildLayout( props ) }
resetAllFilter={ createResetAllFilter(
'selfStretch',
'layout'
) }
isShownByDefault={ false }
panelId={ props.clientId }
>
<ChildLayoutEdit { ...props } />
</VStack>
) }
</InspectorControls>
{ ! isPaddingDisabled && (
<PaddingVisualizer
forceShow={ paddingMouseOver.isMouseOver }
{ ...props }
/>
) }
{ ! isMarginDisabled && (
<MarginVisualizer
forceShow={ marginMouseOver.isMouseOver }
{ ...props }
/>
) }
</>
);
}
/**
* Determine whether there is dimensions related block support.
*
* @param {Object} props Block props.
*
* @return {boolean} Whether there is support.
*/
export function hasDimensionsSupport( props ) {
if ( Platform.OS !== 'web' ) {
return false;
}
const { name: blockName } = props;
return (
hasGapSupport( blockName ) ||
hasMinHeightSupport( blockName ) ||
hasPaddingSupport( blockName ) ||
hasMarginSupport( blockName ) ||
hasChildLayoutSupport( props )
);
}
/**
* Determines whether dimensions support has been disabled.
*
* @param {Object} props Block properties.
*
* @return {boolean} If spacing support is completely disabled.
*/
const useIsDimensionsDisabled = ( props = {} ) => {
const gapDisabled = useIsGapDisabled( props );
const minHeightDisabled = useIsMinHeightDisabled( props );
const paddingDisabled = useIsPaddingDisabled( props );
const marginDisabled = useIsMarginDisabled( props );
const childLayoutDisabled = useIsChildLayoutDisabled( props );
return (
gapDisabled &&
minHeightDisabled &&
paddingDisabled &&
marginDisabled &&
childLayoutDisabled
);
};
/**
* Custom hook to retrieve which padding/margin/blockGap is supported
* e.g. top, right, bottom or left.
*
* Sides are opted into by default. It is only if a specific side is set to
* false that it is omitted.
*
* @param {string} blockName Block name.
* @param {string} feature The feature custom sides relate to e.g. padding or margins.
*
* @return {string[] | undefined} Strings representing the custom sides available.
*/
export function useCustomSides( blockName, feature ) {
const support = getBlockSupport( blockName, SPACING_SUPPORT_KEY );
// Skip when setting is boolean as theme isn't setting arbitrary sides.
if ( ! support || typeof support[ feature ] === 'boolean' ) {
return;
}
// Return if the setting is an array of sides (e.g. `[ 'top', 'bottom' ]`).
if ( Array.isArray( support[ feature ] ) ) {
return support[ feature ];
}
// Finally, attempt to return `.sides` if the setting is an object.
if ( support[ feature ]?.sides ) {
return support[ feature ].sides;
}
}
/**
* Custom hook to determine whether the sides configured in the
* block support are valid. A dimension property cannot declare
* support for a mix of axial and individual sides.
*
* @param {string} blockName Block name.
* @param {string} feature The feature custom sides relate to e.g. padding or margins.
*
* @return {boolean} If the feature has a valid configuration of sides.
*/
export function useIsDimensionsSupportValid( blockName, feature ) {
const sides = useCustomSides( blockName, feature );
if (
sides &&
sides.some( ( side ) => ALL_SIDES.includes( side ) ) &&
sides.some( ( side ) => AXIAL_SIDES.includes( side ) )
) {
// eslint-disable-next-line no-console
console.warn(
`The ${ feature } support for the "${ blockName }" block can not be configured to support both axial and arbitrary sides.`
);
return false;
}
if (
sides?.length &&
feature === 'blockGap' &&
! AXIAL_SIDES.every( ( side ) => sides.includes( side ) )
) {
// eslint-disable-next-line no-console
console.warn(
`The ${ feature } support for the "${ blockName }" block can not be configured to support arbitrary sides.`
);
return false;
}
return true;
}