-
Notifications
You must be signed in to change notification settings - Fork 4k
/
utils.ts
358 lines (331 loc) · 10.9 KB
/
utils.ts
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
/**
* WordPress dependencies
*/
import { __, _x } from '@wordpress/i18n';
import { Platform } from '@wordpress/element';
/**
* Internal dependencies
*/
import type { WPUnitControlUnit } from './types';
const isWeb = Platform.OS === 'web';
const allUnits: Record< string, WPUnitControlUnit > = {
px: {
value: 'px',
label: isWeb ? 'px' : __( 'Pixels (px)' ),
a11yLabel: __( 'Pixels (px)' ),
step: 1,
},
'%': {
value: '%',
label: isWeb ? '%' : __( 'Percentage (%)' ),
a11yLabel: __( 'Percent (%)' ),
step: 0.1,
},
em: {
value: 'em',
label: isWeb ? 'em' : __( 'Relative to parent font size (em)' ),
a11yLabel: _x( 'ems', 'Relative to parent font size (em)' ),
step: 0.01,
},
rem: {
value: 'rem',
label: isWeb ? 'rem' : __( 'Relative to root font size (rem)' ),
a11yLabel: _x( 'rems', 'Relative to root font size (rem)' ),
step: 0.01,
},
vw: {
value: 'vw',
label: isWeb ? 'vw' : __( 'Viewport width (vw)' ),
a11yLabel: __( 'Viewport width (vw)' ),
step: 0.1,
},
vh: {
value: 'vh',
label: isWeb ? 'vh' : __( 'Viewport height (vh)' ),
a11yLabel: __( 'Viewport height (vh)' ),
step: 0.1,
},
vmin: {
value: 'vmin',
label: isWeb ? 'vmin' : __( 'Viewport smallest dimension (vmin)' ),
a11yLabel: __( 'Viewport smallest dimension (vmin)' ),
step: 0.1,
},
vmax: {
value: 'vmax',
label: isWeb ? 'vmax' : __( 'Viewport largest dimension (vmax)' ),
a11yLabel: __( 'Viewport largest dimension (vmax)' ),
step: 0.1,
},
ch: {
value: 'ch',
label: isWeb ? 'ch' : __( 'Width of the zero (0) character (ch)' ),
a11yLabel: __( 'Width of the zero (0) character (ch)' ),
step: 0.01,
},
ex: {
value: 'ex',
label: isWeb ? 'ex' : __( 'x-height of the font (ex)' ),
a11yLabel: __( 'x-height of the font (ex)' ),
step: 0.01,
},
cm: {
value: 'cm',
label: isWeb ? 'cm' : __( 'Centimeters (cm)' ),
a11yLabel: __( 'Centimeters (cm)' ),
step: 0.001,
},
mm: {
value: 'mm',
label: isWeb ? 'mm' : __( 'Millimeters (mm)' ),
a11yLabel: __( 'Millimeters (mm)' ),
step: 0.1,
},
in: {
value: 'in',
label: isWeb ? 'in' : __( 'Inches (in)' ),
a11yLabel: __( 'Inches (in)' ),
step: 0.001,
},
pc: {
value: 'pc',
label: isWeb ? 'pc' : __( 'Picas (pc)' ),
a11yLabel: __( 'Picas (pc)' ),
step: 1,
},
pt: {
value: 'pt',
label: isWeb ? 'pt' : __( 'Points (pt)' ),
a11yLabel: __( 'Points (pt)' ),
step: 1,
},
};
/**
* An array of all available CSS length units.
*/
export const ALL_CSS_UNITS = Object.values( allUnits );
/**
* Units of measurements. `a11yLabel` is used by screenreaders.
*/
export const CSS_UNITS = [
allUnits.px,
allUnits[ '%' ],
allUnits.em,
allUnits.rem,
allUnits.vw,
allUnits.vh,
];
export const DEFAULT_UNIT = allUnits.px;
/**
* Handles legacy value + unit handling.
* This component use to manage both incoming value and units separately.
*
* Moving forward, ideally the value should be a string that contains both
* the value and unit, example: '10px'
*
* @param rawValue The raw value as a string (may or may not contain the unit)
* @param fallbackUnit The unit used as a fallback, if not unit is detected in the `value`
* @param allowedUnits Units to derive from.
* @return The extracted quantity and unit. The quantity can be `undefined` in case the raw value
* could not be parsed to a number correctly. The unit can be `undefined` in case the unit parse
* from the raw value could not be matched against the list of allowed units.
*/
export function getParsedQuantityAndUnit(
rawValue?: string | number,
fallbackUnit?: string,
allowedUnits?: WPUnitControlUnit[]
): [ number | undefined, string | undefined ] {
const initialValue = fallbackUnit
? `${ rawValue ?? '' }${ fallbackUnit }`
: rawValue;
return parseQuantityAndUnitFromRawValue( initialValue, allowedUnits );
}
/**
* Checks if units are defined.
*
* @param units List of units.
* @return Whether the list actually contains any units.
*/
export function hasUnits(
units?: WPUnitControlUnit[]
): units is WPUnitControlUnit[] {
// Although the `isArray` check shouldn't be necessary (given the signature of
// this typed function), it's better to stay on the side of caution, since
// this function may be called from un-typed environments.
return Array.isArray( units ) && !! units.length;
}
/**
* Parses a quantity and unit from a raw string value, given a list of allowed
* units and otherwise falling back to the default unit.
*
* @param rawValue The raw value as a string (may or may not contain the unit)
* @param allowedUnits Units to derive from.
* @return The extracted quantity and unit. The quantity can be `undefined` in case the raw value
* could not be parsed to a number correctly. The unit can be `undefined` in case the unit parsed
* from the raw value could not be matched against the list of allowed units.
*/
export function parseQuantityAndUnitFromRawValue(
rawValue?: string | number,
allowedUnits: WPUnitControlUnit[] = ALL_CSS_UNITS
): [ number | undefined, string | undefined ] {
let trimmedValue;
let quantityToReturn;
if ( typeof rawValue !== 'undefined' || rawValue === null ) {
trimmedValue = `${ rawValue }`.trim();
const parsedQuantity = parseFloat( trimmedValue );
quantityToReturn = ! isFinite( parsedQuantity )
? undefined
: parsedQuantity;
}
const unitMatch = trimmedValue?.match( /[\d.\-\+]*\s*(.*)/ );
const matchedUnit = unitMatch?.[ 1 ]?.toLowerCase();
let unitToReturn: string | undefined;
if ( hasUnits( allowedUnits ) ) {
const match = allowedUnits.find(
( item ) => item.value === matchedUnit
);
unitToReturn = match?.value;
} else {
unitToReturn = DEFAULT_UNIT.value;
}
return [ quantityToReturn, unitToReturn ];
}
/**
* Parses quantity and unit from a raw value. Validates parsed value, using fallback
* value if invalid.
*
* @param rawValue The next value.
* @param allowedUnits Units to derive from.
* @param fallbackQuantity The fallback quantity, used in case it's not possible to parse a valid quantity from the raw value.
* @param fallbackUnit The fallback unit, used in case it's not possible to parse a valid unit from the raw value.
* @return The extracted quantity and unit. The quantity can be `undefined` in case the raw value
* could not be parsed to a number correctly, and the `fallbackQuantity` was also `undefined`. The
* unit can be `undefined` only if the unit parsed from the raw value could not be matched against
* the list of allowed units, the `fallbackQuantity` is also `undefined` and the list of
* `allowedUnits` is passed empty.
*/
export function getValidParsedQuantityAndUnit(
rawValue: string | number,
allowedUnits?: WPUnitControlUnit[],
fallbackQuantity?: number,
fallbackUnit?: string
): [ number | undefined, string | undefined ] {
const [ parsedQuantity, parsedUnit ] = parseQuantityAndUnitFromRawValue(
rawValue,
allowedUnits
);
// The parsed value from `parseQuantityAndUnitFromRawValue` should now be
// either a real number or undefined. If undefined, use the fallback value.
const quantityToReturn = parsedQuantity ?? fallbackQuantity;
// If no unit is parsed from the raw value, or if the fallback unit is not
// defined, use the first value from the list of allowed units as fallback.
let unitToReturn = parsedUnit || fallbackUnit;
if ( ! unitToReturn && hasUnits( allowedUnits ) ) {
unitToReturn = allowedUnits[ 0 ].value;
}
return [ quantityToReturn, unitToReturn ];
}
/**
* Takes a unit value and finds the matching accessibility label for the
* unit abbreviation.
*
* @param unit Unit value (example: `px`)
* @return a11y label for the unit abbreviation
*/
export function getAccessibleLabelForUnit( unit: string ): string | undefined {
const match = ALL_CSS_UNITS.find( ( item ) => item.value === unit );
return match?.a11yLabel ? match?.a11yLabel : match?.value;
}
/**
* Filters available units based on values defined a list of allowed unit values.
*
* @param allowedUnitValues Collection of allowed unit value strings.
* @param availableUnits Collection of available unit objects.
* @return Filtered units.
*/
export function filterUnitsWithSettings(
allowedUnitValues: string[] = [],
availableUnits: WPUnitControlUnit[]
): WPUnitControlUnit[] {
// Although the `isArray` check shouldn't be necessary (given the signature of
// this typed function), it's better to stay on the side of caution, since
// this function may be called from un-typed environments.
return Array.isArray( availableUnits )
? availableUnits.filter( ( unit ) =>
allowedUnitValues.includes( unit.value )
)
: [];
}
/**
* Custom hook to retrieve and consolidate units setting from add_theme_support().
* TODO: ideally this hook shouldn't be needed
* https://github.com/WordPress/gutenberg/pull/31822#discussion_r633280823
*
* @param args An object containing units, settingPath & defaultUnits.
* @param args.units Collection of all potentially available units.
* @param args.availableUnits Collection of unit value strings for filtering available units.
* @param args.defaultValues Collection of default values for defined units. Example: `{ px: 350, em: 15 }`.
*
* @return Filtered list of units, with their default values updated following the `defaultValues`
* argument's property.
*/
export const useCustomUnits = ( {
units = ALL_CSS_UNITS,
availableUnits = [],
defaultValues,
}: {
units?: WPUnitControlUnit[];
availableUnits?: string[];
defaultValues?: Record< string, number >;
} ): WPUnitControlUnit[] => {
const customUnitsToReturn = filterUnitsWithSettings(
availableUnits,
units
);
if ( defaultValues ) {
customUnitsToReturn.forEach( ( unit, i ) => {
if ( defaultValues[ unit.value ] ) {
const [ parsedDefaultValue ] = parseQuantityAndUnitFromRawValue(
defaultValues[ unit.value ]
);
customUnitsToReturn[ i ].default = parsedDefaultValue;
}
} );
}
return customUnitsToReturn;
};
/**
* Get available units with the unit for the currently selected value
* prepended if it is not available in the list of units.
*
* This is useful to ensure that the current value's unit is always
* accurately displayed in the UI, even if the intention is to hide
* the availability of that unit.
*
* @param rawValue Selected value to parse.
* @param legacyUnit Legacy unit value, if rawValue needs it appended.
* @param units List of available units.
*
* @return A collection of units containing the unit for the current value.
*/
export function getUnitsWithCurrentUnit(
rawValue?: string | number,
legacyUnit?: string,
units: WPUnitControlUnit[] = ALL_CSS_UNITS
): WPUnitControlUnit[] {
const unitsToReturn = Array.isArray( units ) ? [ ...units ] : [];
const [ , currentUnit ] = getParsedQuantityAndUnit(
rawValue,
legacyUnit,
ALL_CSS_UNITS
);
if (
currentUnit &&
! unitsToReturn.some( ( unit ) => unit.value === currentUnit )
) {
if ( allUnits[ currentUnit ] ) {
unitsToReturn.unshift( allUnits[ currentUnit ] );
}
}
return unitsToReturn;
}