@elementor/editor-controls 0.13.0 → 0.14.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elementor/editor-controls",
   "description": "This package contains the controls model and utils for the Elementor editor",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "private": false,
   "author": "Elementor Team",
   "homepage": "https://elementor.com/",
@@ -40,14 +40,14 @@
     "dev": "tsup --config=../../tsup.dev.ts"
   },
   "dependencies": {
-    "@elementor/editor-props": "0.9.2",
+    "@elementor/editor-props": "0.9.3",
     "@elementor/env": "0.3.5",
     "@elementor/http": "0.1.3",
     "@elementor/icons": "1.31.0",
     "@elementor/session": "0.1.0",
     "@elementor/ui": "1.26.0",
-    "@elementor/utils": "0.3.1",
-    "@elementor/wp-media": "0.4.1",
+    "@elementor/utils": "0.4.0",
+    "@elementor/wp-media": "0.4.2",
     "@wordpress/i18n": "^5.13.0"
   },
   "devDependencies": {

package/src/components/repeater.tsx

@@ -238,6 +238,7 @@ const RepeaterItem = ( {
 						</IconButton>
 					</>
 				}
+				sx={ { backgroundColor: 'background.paper' } }
 			/>
 			<Popover
 				disablePortal

package/src/controls/background-control/background-overlay/background-image-overlay/background-image-overlay-repeat.tsx

@@ -31,7 +31,7 @@ const repeatControlOptions: ToggleButtonGroupItem< Repeaters >[] = [
 	},
 	{
 		value: 'no-repeat',
-		label: __( 'No-Repeat', 'elementor' ),
+		label: __( 'No-repeat', 'elementor' ),
 		renderContent: ( { size } ) => <XIcon fontSize={ size } />,
 		showTooltip: true,
 	},

package/src/controls/background-control/background-overlay/background-image-overlay/background-image-overlay-size.tsx

@@ -88,12 +88,18 @@ export const BackgroundImageOverlaySize = () => {
 						<PopoverGridContainer>
 							<Grid item xs={ 6 }>
 								<PropKeyProvider bind={ 'width' }>
-									<SizeControl startIcon={ <ArrowsMoveHorizontalIcon fontSize={ 'tiny' } /> } />
+									<SizeControl
+										startIcon={ <ArrowsMoveHorizontalIcon fontSize={ 'tiny' } /> }
+										extendedValues={ [ 'auto' ] }
+									/>
 								</PropKeyProvider>
 							</Grid>
 							<Grid item xs={ 6 }>
 								<PropKeyProvider bind={ 'height' }>
-									<SizeControl startIcon={ <ArrowsMoveVerticalIcon fontSize={ 'tiny' } /> } />
+									<SizeControl
+										startIcon={ <ArrowsMoveVerticalIcon fontSize={ 'tiny' } /> }
+										extendedValues={ [ 'auto' ] }
+									/>
 								</PropKeyProvider>
 							</Grid>
 						</PopoverGridContainer>

package/src/controls/font-family-control.tsx

@@ -71,7 +71,7 @@ export const FontFamilyControl = createControl( ( { fontFamilies } ) => {
 				<Stack>
 					<Stack direction="row" alignItems="center" pl={ 1.5 } pr={ 0.5 } py={ 1.5 }>
 						<EditIcon fontSize={ SIZE } sx={ { mr: 0.5 } } />
-						<Typography variant="subtitle2">{ __( 'Font Family', 'elementor' ) }</Typography>
+						<Typography variant="subtitle2">{ __( 'Font family', 'elementor' ) }</Typography>
 						<IconButton size={ SIZE } sx={ { ml: 'auto' } } onClick={ handleClose }>
 							<XIcon fontSize={ SIZE } />
 						</IconButton>
@@ -82,7 +82,7 @@ export const FontFamilyControl = createControl( ( { fontFamilies } ) => {
 							fullWidth
 							size={ SIZE }
 							value={ searchValue }
-							placeholder={ __( 'Search', 'elementor' ) }
+							placeholder={ __( 'Search fonts…', 'elementor' ) }
 							onChange={ handleSearch }
 							InputProps={ {
 								startAdornment: (

package/src/controls/gap-control.tsx

@@ -21,7 +21,7 @@ export const GapControl = createControl( ( { label }: { label: string } ) => {
 
 	const onLinkToggle = () => {
 		if ( ! isLinked ) {
-			setSizeValue( directionValue?.column.value );
+			setSizeValue( directionValue?.column?.value );
 			return;
 		}
 

package/src/controls/image-control.tsx

@@ -22,7 +22,7 @@ export const ImageControl = createControl(
 			<PropProvider { ...propContext }>
 				<Stack gap={ 1.5 }>
 					<PropKeyProvider bind={ 'src' }>
-						<ControlLabel> { __( 'Choose image', 'elementor' ) } </ControlLabel>
+						<ControlLabel> { __( 'Image', 'elementor' ) } </ControlLabel>
 						<ImageMediaControl />
 					</PropKeyProvider>
 					<PropKeyProvider bind={ 'size' }>

package/src/controls/image-media-control.tsx

@@ -66,7 +66,7 @@ export const ImageMediaControl = createControl( ( props: ImageMediaControlProps
 							startIcon={ <UploadIcon /> }
 							onClick={ () => open( { mode: 'upload' } ) }
 						>
-							{ __( 'Upload image', 'elementor' ) }
+							{ __( 'Upload', 'elementor' ) }
 						</Button>
 					</Stack>
 				</CardOverlay>

package/src/controls/link-control.tsx

@@ -12,6 +12,7 @@ import { type HttpResponse, httpService } from '@elementor/http';
 import { MinusIcon, PlusIcon } from '@elementor/icons';
 import { useSessionStorage } from '@elementor/session';
 import { Collapse, Divider, Grid, IconButton, Stack, Switch } from '@elementor/ui';
+import { debounce } from '@elementor/utils';
 import { __ } from '@wordpress/i18n';
 
 import { PropKeyProvider, PropProvider, useBoundProp } from '../bound-prop-context';
@@ -191,7 +192,7 @@ const SwitchControl = () => {
 	return (
 		<Grid container alignItems="center" flexWrap="nowrap" justifyContent="space-between">
 			<Grid item>
-				<ControlLabel>{ __( 'Open in new tab', 'elementor' ) }</ControlLabel>
+				<ControlLabel>{ __( 'Open in a new tab', 'elementor' ) }</ControlLabel>
 			</Grid>
 			<Grid item>
 				<Switch checked={ value } onClick={ onClick } />
@@ -238,15 +239,3 @@ function generateFirstLoadedOption( unionValue: LinkPropValue[ 'value' ] | null
 		  ]
 		: [];
 }
-
-function debounce< TArgs extends unknown[] >( fn: ( ...args: TArgs ) => unknown, timeout: number ) {
-	let timer: ReturnType< typeof setTimeout >;
-
-	return ( ...args: TArgs ) => {
-		clearTimeout( timer );
-
-		timer = setTimeout( () => {
-			fn( ...args );
-		}, timeout );
-	};
-}

package/src/controls/linked-dimensions-control.tsx

@@ -7,111 +7,131 @@ import { __ } from '@wordpress/i18n';
 import { PropKeyProvider, PropProvider, useBoundProp } from '../bound-prop-context';
 import { ControlLabel } from '../components/control-label';
 import { createControl } from '../create-control';
-import { SizeControl } from './size-control';
+import { type ExtendedValue, SizeControl } from './size-control';
 
-export const LinkedDimensionsControl = createControl( ( { label }: { label: string } ) => {
-	const { value: dimensionsValue, setValue: setDimensionsValue, propType } = useBoundProp( dimensionsPropTypeUtil );
-	const { value: sizeValue, setValue: setSizeValue } = useBoundProp( sizePropTypeUtil );
+export const LinkedDimensionsControl = createControl(
+	( { label, extendedValues }: { label: string; extendedValues?: ExtendedValue[] } ) => {
+		const {
+			value: dimensionsValue,
+			setValue: setDimensionsValue,
+			propType,
+		} = useBoundProp( dimensionsPropTypeUtil );
+		const { value: sizeValue, setValue: setSizeValue } = useBoundProp( sizePropTypeUtil );
 
-	const isLinked = ! dimensionsValue && ! sizeValue ? true : !! sizeValue;
+		const isLinked = ! dimensionsValue && ! sizeValue ? true : !! sizeValue;
 
-	const onLinkToggle = () => {
-		if ( ! isLinked ) {
-			setSizeValue( dimensionsValue?.top?.value );
-			return;
-		}
+		const onLinkToggle = () => {
+			if ( ! isLinked ) {
+				setSizeValue( dimensionsValue?.top?.value );
+				return;
+			}
 
-		const value = sizeValue ? sizePropTypeUtil.create( sizeValue ) : null;
+			const value = sizeValue ? sizePropTypeUtil.create( sizeValue ) : null;
 
-		setDimensionsValue( {
-			top: value,
-			right: value,
-			bottom: value,
-			left: value,
-		} );
-	};
+			setDimensionsValue( {
+				top: value,
+				right: value,
+				bottom: value,
+				left: value,
+			} );
+		};
 
-	const LinkedIcon = isLinked ? LinkIcon : DetachIcon;
+		const LinkedIcon = isLinked ? LinkIcon : DetachIcon;
 
-	return (
-		<PropProvider propType={ propType } value={ dimensionsValue } setValue={ setDimensionsValue }>
-			<Stack direction="row" gap={ 2 } flexWrap="nowrap">
-				<ControlLabel>{ label }</ControlLabel>
-				<ToggleButton
-					aria-label={ __( 'Link inputs', 'elementor' ) }
-					size={ 'tiny' }
-					value={ 'check' }
-					selected={ isLinked }
-					sx={ { marginLeft: 'auto' } }
-					onChange={ onLinkToggle }
-				>
-					<LinkedIcon fontSize={ 'tiny' } />
-				</ToggleButton>
-			</Stack>
-			<Stack direction="row" gap={ 2 } flexWrap="nowrap">
-				<Grid container gap={ 1 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<ControlLabel>{ __( 'Top', 'elementor' ) }</ControlLabel>
-					</Grid>
-					<Grid item xs={ 12 }>
-						<Control
-							bind={ 'top' }
-							startIcon={ <SideTopIcon fontSize={ 'tiny' } /> }
-							isLinked={ isLinked }
-						/>
-					</Grid>
-				</Grid>
-				<Grid container gap={ 1 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<ControlLabel>{ __( 'Right', 'elementor' ) }</ControlLabel>
-					</Grid>
-					<Grid item xs={ 12 }>
-						<Control
-							bind={ 'right' }
-							startIcon={ <SideRightIcon fontSize={ 'tiny' } /> }
-							isLinked={ isLinked }
-						/>
+		return (
+			<PropProvider propType={ propType } value={ dimensionsValue } setValue={ setDimensionsValue }>
+				<Stack direction="row" gap={ 2 } flexWrap="nowrap">
+					<ControlLabel>{ label }</ControlLabel>
+					<ToggleButton
+						aria-label={ __( 'Link Inputs', 'elementor' ) }
+						size={ 'tiny' }
+						value={ 'check' }
+						selected={ isLinked }
+						sx={ { marginLeft: 'auto' } }
+						onChange={ onLinkToggle }
+					>
+						<LinkedIcon fontSize={ 'tiny' } />
+					</ToggleButton>
+				</Stack>
+				<Stack direction="row" gap={ 2 } flexWrap="nowrap">
+					<Grid container gap={ 1 } alignItems="center">
+						<Grid item xs={ 12 }>
+							<ControlLabel>{ __( 'Top', 'elementor' ) }</ControlLabel>
+						</Grid>
+						<Grid item xs={ 12 }>
+							<Control
+								bind={ 'top' }
+								startIcon={ <SideTopIcon fontSize={ 'tiny' } /> }
+								isLinked={ isLinked }
+								extendedValues={ extendedValues }
+							/>
+						</Grid>
 					</Grid>
-				</Grid>
-			</Stack>
-			<Stack direction="row" gap={ 2 } flexWrap="nowrap">
-				<Grid container gap={ 1 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<ControlLabel>{ __( 'Bottom', 'elementor' ) }</ControlLabel>
+					<Grid container gap={ 1 } alignItems="center">
+						<Grid item xs={ 12 }>
+							<ControlLabel>{ __( 'Right', 'elementor' ) }</ControlLabel>
+						</Grid>
+						<Grid item xs={ 12 }>
+							<Control
+								bind={ 'right' }
+								startIcon={ <SideRightIcon fontSize={ 'tiny' } /> }
+								isLinked={ isLinked }
+								extendedValues={ extendedValues }
+							/>
+						</Grid>
 					</Grid>
-					<Grid item xs={ 12 }>
-						<Control
-							bind={ 'bottom' }
-							startIcon={ <SideBottomIcon fontSize={ 'tiny' } /> }
-							isLinked={ isLinked }
-						/>
+				</Stack>
+				<Stack direction="row" gap={ 2 } flexWrap="nowrap">
+					<Grid container gap={ 1 } alignItems="center">
+						<Grid item xs={ 12 }>
+							<ControlLabel>{ __( 'Bottom', 'elementor' ) }</ControlLabel>
+						</Grid>
+						<Grid item xs={ 12 }>
+							<Control
+								bind={ 'bottom' }
+								startIcon={ <SideBottomIcon fontSize={ 'tiny' } /> }
+								isLinked={ isLinked }
+								extendedValues={ extendedValues }
+							/>
+						</Grid>
 					</Grid>
-				</Grid>
-				<Grid container gap={ 1 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<ControlLabel>{ __( 'Left', 'elementor' ) }</ControlLabel>
+					<Grid container gap={ 1 } alignItems="center">
+						<Grid item xs={ 12 }>
+							<ControlLabel>{ __( 'Left', 'elementor' ) }</ControlLabel>
+						</Grid>
+						<Grid item xs={ 12 }>
+							<Control
+								bind={ 'left' }
+								startIcon={ <SideLeftIcon fontSize={ 'tiny' } /> }
+								isLinked={ isLinked }
+								extendedValues={ extendedValues }
+							/>
+						</Grid>
 					</Grid>
-					<Grid item xs={ 12 }>
-						<Control
-							bind={ 'left' }
-							startIcon={ <SideLeftIcon fontSize={ 'tiny' } /> }
-							isLinked={ isLinked }
-						/>
-					</Grid>
-				</Grid>
-			</Stack>
-		</PropProvider>
-	);
-} );
+				</Stack>
+			</PropProvider>
+		);
+	}
+);
 
-const Control = ( { bind, startIcon, isLinked }: { bind: PropKey; startIcon: React.ReactNode; isLinked: boolean } ) => {
+const Control = ( {
+	bind,
+	startIcon,
+	isLinked,
+	extendedValues,
+}: {
+	bind: PropKey;
+	startIcon: React.ReactNode;
+	isLinked: boolean;
+	extendedValues?: ExtendedValue[];
+} ) => {
 	if ( isLinked ) {
-		return <SizeControl startIcon={ startIcon } />;
+		return <SizeControl startIcon={ startIcon } extendedValues={ extendedValues } />;
 	}
 
 	return (
 		<PropKeyProvider bind={ bind }>
-			<SizeControl startIcon={ startIcon } />
+			<SizeControl startIcon={ startIcon } extendedValues={ extendedValues } />
 		</PropKeyProvider>
 	);
 };

package/src/controls/size-control.tsx

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { sizePropTypeUtil } from '@elementor/editor-props';
+import { sizePropTypeUtil, stringPropTypeUtil } from '@elementor/editor-props';
 import { InputAdornment } from '@elementor/ui';
 
 import { useBoundProp } from '../bound-prop-context';
@@ -8,6 +8,7 @@ import ControlActions from '../control-actions/control-actions';
 import { createControl } from '../create-control';
 import { useSyncExternalState } from '../hooks/use-sync-external-state';
 
+export type ExtendedValue = 'auto';
 export type Unit = 'px' | '%' | 'em' | 'rem' | 'vw' | 'vh';
 
 const defaultUnits: Unit[] = [ 'px', '%', 'em', 'rem', 'vw', 'vh' ];
@@ -19,34 +20,98 @@ type SizeControlProps = {
 	placeholder?: string;
 	startIcon?: React.ReactNode;
 	units?: Unit[];
+	extendedValues?: ExtendedValue[];
 };
 
-export const SizeControl = createControl( ( { units = defaultUnits, placeholder, startIcon }: SizeControlProps ) => {
-	const { value, setValue } = useBoundProp( sizePropTypeUtil );
-
-	const [ state, setState ] = useSyncExternalState( {
-		external: value,
-		setExternal: setValue,
-		persistWhen: ( controlValue ) => !! controlValue?.size || controlValue?.size === 0,
-		fallback: ( controlValue ) => ( { unit: controlValue?.unit || defaultUnit, size: defaultSize } ),
-	} );
-
-	const handleUnitChange = ( unit: Unit ) => {
-		setState( ( prev ) => ( {
-			size: prev?.size ?? defaultSize,
-			unit,
-		} ) );
-	};
+export const SizeControl = createControl(
+	( { units = defaultUnits, extendedValues = [], placeholder, startIcon }: SizeControlProps ) => {
+		const { value: sizeValue, setValue: setSizeValue } = useBoundProp( sizePropTypeUtil );
+
+		const [ state, setState ] = useSyncExternalState( {
+			external: sizeValue,
+			setExternal: setSizeValue,
+			persistWhen: ( controlValue ) => !! controlValue?.size || controlValue?.size === 0,
+			fallback: ( controlValue ) => ( { unit: controlValue?.unit || defaultUnit, size: defaultSize } ),
+		} );
+
+		const handleUnitChange = ( unit: Unit ) => {
+			setState( ( prev ) => ( {
+				size: prev?.size ?? defaultSize,
+				unit,
+			} ) );
+		};
+
+		const handleSizeChange = ( event: React.ChangeEvent< HTMLInputElement > ) => {
+			const { value: size } = event.target;
+
+			setState( ( prev ) => ( {
+				...prev,
+				size: size || size === '0' ? parseFloat( size ) : defaultSize,
+			} ) );
+		};
 
-	const handleSizeChange = ( event: React.ChangeEvent< HTMLInputElement > ) => {
-		const { value: size } = event.target;
+		const inputProps = {
+			size: state.size,
+			unit: state.unit,
+			placeholder,
+			startIcon,
+			units,
+			extendedValues,
+			handleSizeChange,
+			handleUnitChange,
+		};
 
-		setState( ( prev ) => ( {
-			...prev,
-			size: size || size === '0' ? parseFloat( size ) : defaultSize,
-		} ) );
+		if ( extendedValues?.length ) {
+			return <ExtendedSizeInput { ...inputProps } />;
+		}
+		return <SizeInput { ...inputProps } />;
+	}
+);
+
+const ExtendedSizeInput = ( props: SizeInputProps ) => {
+	const { value: stringValue, setValue: setStringValue } = useBoundProp( stringPropTypeUtil );
+	const { extendedValues = [] } = props;
+
+	const unit = ( stringValue ?? props.unit ) as Unit;
+
+	const handleUnitChange = ( newUnit: Unit ) => {
+		if ( extendedValues.includes( newUnit as ExtendedValue ) ) {
+			setStringValue( newUnit );
+		} else {
+			props.handleUnitChange( newUnit );
+		}
 	};
 
+	return (
+		<SizeInput
+			{ ...props }
+			units={ [ ...props.units, ...( extendedValues as unknown as Unit[] ) ] }
+			handleUnitChange={ handleUnitChange }
+			unit={ unit }
+		/>
+	);
+};
+
+type SizeInputProps = {
+	unit: Unit;
+	size: number;
+	placeholder?: string;
+	startIcon?: React.ReactNode;
+	units: Unit[];
+	extendedValues?: ExtendedValue[];
+	handleUnitChange: ( unit: Unit ) => void;
+	handleSizeChange: ( event: React.ChangeEvent< HTMLInputElement > ) => void;
+};
+
+const SizeInput = ( {
+	units,
+	handleUnitChange,
+	handleSizeChange,
+	placeholder,
+	startIcon,
+	size,
+	unit,
+}: SizeInputProps ) => {
 	return (
 		<ControlActions>
 			<TextFieldInnerSelection
@@ -54,7 +119,7 @@ export const SizeControl = createControl( ( { units = defaultUnits, placeholder,
 					<SelectionEndAdornment
 						options={ units }
 						onClick={ handleUnitChange }
-						value={ state?.unit ?? defaultUnit }
+						value={ unit ?? defaultUnit }
 					/>
 				}
 				placeholder={ placeholder }
@@ -62,9 +127,9 @@ export const SizeControl = createControl( ( { units = defaultUnits, placeholder,
 					startIcon ? <InputAdornment position="start">{ startIcon }</InputAdornment> : undefined
 				}
 				type="number"
-				value={ Number.isNaN( state?.size ) ? '' : state?.size }
+				value={ Number.isNaN( size ) ? '' : size }
 				onChange={ handleSizeChange }
 			/>
 		</ControlActions>
 	);
-} );
+};

package/src/controls/svg-media-control.tsx

@@ -58,7 +58,7 @@ export const SvgMediaControl = createControl( () => {
 
 	return (
 		<Stack gap={ 1 }>
-			<ControlLabel> { __( 'Choose SVG', 'elementor' ) } </ControlLabel>
+			<ControlLabel> { __( 'SVG', 'elementor' ) } </ControlLabel>
 			<ControlActions>
 				<StyledCard variant="outlined">
 					<StyledCardMediaContainer>
@@ -96,7 +96,7 @@ export const SvgMediaControl = createControl( () => {
 								startIcon={ <UploadIcon /> }
 								onClick={ () => open( { mode: 'upload' } ) }
 							>
-								{ __( 'Upload SVG', 'elementor' ) }
+								{ __( 'Upload', 'elementor' ) }
 							</Button>
 						</Stack>
 					</CardOverlay>

package/src/index.ts

@@ -29,6 +29,7 @@ export type { EqualUnequalItems } from './controls/equal-unequal-sizes-control';
 export type { ControlActionsItems } from './control-actions/control-actions-context';
 export type { PropProviderProps } from './bound-prop-context';
 export type { SetValue } from './bound-prop-context/prop-context';
+export type { ExtendedValue } from './controls/size-control';
 
 // providers
 export { createControlReplacement, ControlReplacementProvider } from './create-control-replacement';