@elementor/editor-variables 0.15.0 → 0.16.0

package/src/components/color-variable-creation.tsx

@@ -1,24 +1,16 @@
 import * as React from 'react';
-import { useRef, useState } from 'react';
+import { useState } from 'react';
 import { PopoverContent, useBoundProp } from '@elementor/editor-controls';
 import { PopoverScrollableContent } from '@elementor/editor-editing-panel';
 import { PopoverHeader } from '@elementor/editor-ui';
 import { ArrowLeftIcon, BrushIcon } from '@elementor/icons';
-import {
-	Button,
-	CardActions,
-	Divider,
-	FormLabel,
-	Grid,
-	IconButton,
-	TextField,
-	UnstableColorField,
-} from '@elementor/ui';
+import { Button, CardActions, Divider, IconButton } from '@elementor/ui';
 import { __ } from '@wordpress/i18n';
 
 import { createVariable } from '../hooks/use-prop-variables';
 import { colorVariablePropTypeUtil } from '../prop-types/color-variable-prop-type';
-import { usePopoverContentRef } from './variable-selection-popover.context';
+import { ColorField } from './fields/color-field';
+import { LabelField } from './fields/label-field';
 
 const SIZE = 'tiny';
 
@@ -33,9 +25,6 @@ export const ColorVariableCreation = ( { onGoBack, onClose }: Props ) => {
 	const [ color, setColor ] = useState( '' );
 	const [ label, setLabel ] = useState( '' );
 
-	const defaultRef = useRef< HTMLDivElement >( null );
-	const anchorRef = usePopoverContentRef() ?? defaultRef;
-
 	const resetFields = () => {
 		setColor( '' );
 		setLabel( '' );
@@ -57,10 +46,12 @@ export const ColorVariableCreation = ( { onGoBack, onClose }: Props ) => {
 		} );
 	};
 
-	const isFormInvalid = () => {
-		return ! color?.trim() || ! label?.trim();
+	const hasEmptyValue = () => {
+		return '' === color.trim() || '' === label.trim();
 	};
 
+	const isSubmitDisabled = hasEmptyValue();
+
 	return (
 		<PopoverScrollableContent height="auto">
 			<PopoverHeader
@@ -81,44 +72,12 @@ export const ColorVariableCreation = ( { onGoBack, onClose }: Props ) => {
 			<Divider />
 
 			<PopoverContent p={ 2 }>
-				<Grid container gap={ 0.75 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<FormLabel size="tiny">{ __( 'Name', 'elementor' ) }</FormLabel>
-					</Grid>
-					<Grid item xs={ 12 }>
-						<TextField
-							size="tiny"
-							fullWidth
-							value={ label }
-							onChange={ ( e: React.ChangeEvent< HTMLInputElement > ) => setLabel( e.target.value ) }
-						/>
-					</Grid>
-				</Grid>
-
-				<Grid container gap={ 0.75 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<FormLabel size="tiny">{ __( 'Value', 'elementor' ) }</FormLabel>
-					</Grid>
-					<Grid item xs={ 12 }>
-						<UnstableColorField
-							size="tiny"
-							fullWidth
-							value={ color }
-							onChange={ setColor }
-							slotProps={ {
-								colorPicker: {
-									anchorEl: anchorRef.current,
-									anchorOrigin: { vertical: 'top', horizontal: 'right' },
-									transformOrigin: { vertical: 'top', horizontal: -10 },
-								},
-							} }
-						/>
-					</Grid>
-				</Grid>
+				<LabelField value={ label } onChange={ setLabel } />
+				<ColorField value={ color } onChange={ setColor } />
 			</PopoverContent>
 
 			<CardActions sx={ { pt: 0.5, pb: 1 } }>
-				<Button size="small" variant="contained" disabled={ isFormInvalid() } onClick={ handleCreate }>
+				<Button size="small" variant="contained" disabled={ isSubmitDisabled } onClick={ handleCreate }>
 					{ __( 'Create', 'elementor' ) }
 				</Button>
 			</CardActions>

package/src/components/color-variable-edit.tsx

@@ -1,22 +1,17 @@
 import * as React from 'react';
-import { useRef, useState } from 'react';
-import { PopoverContent } from '@elementor/editor-controls';
-import { PopoverHeader, PopoverScrollableContent } from '@elementor/editor-ui';
+import { useState } from 'react';
+import { PopoverContent, useBoundProp } from '@elementor/editor-controls';
+import { PopoverScrollableContent } from '@elementor/editor-editing-panel';
+import { PopoverHeader } from '@elementor/editor-ui';
 import { ArrowLeftIcon, BrushIcon, TrashIcon } from '@elementor/icons';
-import {
-	Button,
-	CardActions,
-	Divider,
-	FormLabel,
-	Grid,
-	IconButton,
-	TextField,
-	UnstableColorField,
-} from '@elementor/ui';
+import { Button, CardActions, Divider, IconButton } from '@elementor/ui';
 import { __ } from '@wordpress/i18n';
 
 import { deleteVariable, updateVariable, useVariable } from '../hooks/use-prop-variables';
-import { usePopoverContentRef } from './variable-selection-popover.context';
+import { colorVariablePropTypeUtil } from '../prop-types/color-variable-prop-type';
+import { ColorField } from './fields/color-field';
+import { LabelField } from './fields/label-field';
+import { DeleteConfirmationDialog } from './ui/delete-confirmation-dialog';
 
 const SIZE = 'tiny';
 
@@ -28,14 +23,14 @@ type Props = {
 };
 
 export const ColorVariableEdit = ( { onClose, onGoBack, onSubmit, editId }: Props ) => {
+	const { setValue: notifyBoundPropChange, value: assignedValue } = useBoundProp( colorVariablePropTypeUtil );
+	const [ deleteConfirmation, setDeleteConfirmation ] = useState( false );
+
 	const variable = useVariable( editId );
 	if ( ! variable ) {
 		throw new Error( `Global color variable not found` );
 	}
 
-	const defaultRef = useRef< HTMLDivElement >( null );
-	const anchorRef = usePopoverContentRef() ?? defaultRef;
-
 	const [ color, setColor ] = useState( variable.value );
 	const [ label, setLabel ] = useState( variable.label );
 
@@ -44,90 +39,100 @@ export const ColorVariableEdit = ( { onClose, onGoBack, onSubmit, editId }: Prop
 			value: color,
 			label,
 		} ).then( () => {
+			maybeTriggerBoundPropChange();
 			onSubmit?.();
 		} );
 	};
 
 	const handleDelete = () => {
 		deleteVariable( editId ).then( () => {
+			maybeTriggerBoundPropChange();
 			onSubmit?.();
 		} );
 	};
 
-	const noValueChanged = () => color === variable.value && label === variable.label;
-	const hasEmptyValue = () => '' === color.trim() || '' === label.trim();
-	const isSaveDisabled = () => noValueChanged() || hasEmptyValue();
+	const maybeTriggerBoundPropChange = () => {
+		if ( editId === assignedValue ) {
+			notifyBoundPropChange( editId );
+		}
+	};
+
+	const handleDeleteConfirmation = () => {
+		setDeleteConfirmation( true );
+	};
+
+	const closeDeleteDialog = () => () => {
+		setDeleteConfirmation( false );
+	};
 
 	const actions = [];
 
 	actions.push(
-		<IconButton key="delete" size={ SIZE } aria-label={ __( 'Delete', 'elementor' ) } onClick={ handleDelete }>
+		<IconButton
+			key="delete"
+			size={ SIZE }
+			aria-label={ __( 'Delete', 'elementor' ) }
+			onClick={ handleDeleteConfirmation }
+		>
 			<TrashIcon fontSize={ SIZE } />
 		</IconButton>
 	);
 
+	const hasEmptyValues = () => {
+		return ! color.trim() || ! label.trim();
+	};
+
+	const noValueChanged = () => {
+		return color === variable.value && label === variable.label;
+	};
+
+	const isSubmitDisabled = noValueChanged() || hasEmptyValues();
+
 	return (
-		<PopoverScrollableContent height="auto">
-			<PopoverHeader
-				title={ __( 'Edit variable', 'elementor' ) }
-				onClose={ onClose }
-				icon={
-					<>
-						{ onGoBack && (
-							<IconButton size={ SIZE } aria-label={ __( 'Go Back', 'elementor' ) } onClick={ onGoBack }>
-								<ArrowLeftIcon fontSize={ SIZE } />
-							</IconButton>
-						) }
-						<BrushIcon fontSize={ SIZE } />
-					</>
-				}
-				actions={ actions }
-			/>
-
-			<Divider />
-
-			<PopoverContent p={ 2 }>
-				<Grid container gap={ 0.75 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<FormLabel size="tiny">{ __( 'Name', 'elementor' ) }</FormLabel>
-					</Grid>
-					<Grid item xs={ 12 }>
-						<TextField
-							size="tiny"
-							fullWidth
-							value={ label }
-							onChange={ ( e: React.ChangeEvent< HTMLInputElement > ) => setLabel( e.target.value ) }
-						/>
-					</Grid>
-				</Grid>
-
-				<Grid container gap={ 0.75 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<FormLabel size="tiny">{ __( 'Value', 'elementor' ) }</FormLabel>
-					</Grid>
-					<Grid item xs={ 12 }>
-						<UnstableColorField
-							size="tiny"
-							fullWidth
-							value={ color }
-							onChange={ setColor }
-							slotProps={ {
-								colorPicker: {
-									anchorEl: anchorRef.current,
-									anchorOrigin: { vertical: 'top', horizontal: 'right' },
-									transformOrigin: { vertical: 'top', horizontal: -10 },
-								},
-							} }
-						/>
-					</Grid>
-				</Grid>
-			</PopoverContent>
-
-			<CardActions sx={ { pt: 0.5, pb: 1 } }>
-				<Button size="small" variant="contained" disabled={ isSaveDisabled() } onClick={ handleUpdate }>
-					{ __( 'Save', 'elementor' ) }
-				</Button>
-			</CardActions>
-		</PopoverScrollableContent>
+		<>
+			<PopoverScrollableContent height="auto">
+				<PopoverHeader
+					title={ __( 'Edit variable', 'elementor' ) }
+					onClose={ onClose }
+					icon={
+						<>
+							{ onGoBack && (
+								<IconButton
+									size={ SIZE }
+									aria-label={ __( 'Go Back', 'elementor' ) }
+									onClick={ onGoBack }
+								>
+									<ArrowLeftIcon fontSize={ SIZE } />
+								</IconButton>
+							) }
+							<BrushIcon fontSize={ SIZE } />
+						</>
+					}
+					actions={ actions }
+				/>
+
+				<Divider />
+
+				<PopoverContent p={ 2 }>
+					<LabelField value={ label } onChange={ setLabel } />
+					<ColorField value={ color } onChange={ setColor } />
+				</PopoverContent>
+
+				<CardActions sx={ { pt: 0.5, pb: 1 } }>
+					<Button size="small" variant="contained" disabled={ isSubmitDisabled } onClick={ handleUpdate }>
+						{ __( 'Save', 'elementor' ) }
+					</Button>
+				</CardActions>
+			</PopoverScrollableContent>
+
+			{ deleteConfirmation && (
+				<DeleteConfirmationDialog
+					open
+					label={ label }
+					onConfirm={ handleDelete }
+					closeDialog={ closeDeleteDialog() }
+				/>
+			) }
+		</>
 	);
 };

package/src/components/fields/color-field.tsx

@@ -0,0 +1,54 @@
+import * as React from 'react';
+import { useRef, useState } from 'react';
+import { FormHelperText, FormLabel, Grid, UnstableColorField } from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
+
+import { validateValue } from '../../utils/validations';
+import { usePopoverContentRef } from '../variable-selection-popover.context';
+
+type ColorFieldProps = {
+	value: string;
+	onChange: ( value: string ) => void;
+};
+
+export const ColorField = ( { value, onChange }: ColorFieldProps ) => {
+	const [ color, setColor ] = useState( value );
+	const [ errorMessage, setErrorMessage ] = useState( '' );
+
+	const defaultRef = useRef< HTMLDivElement >( null );
+	const anchorRef = usePopoverContentRef() ?? defaultRef;
+
+	const handleChange = ( newValue: string ) => {
+		setColor( newValue );
+
+		const errorMsg = validateValue( newValue );
+		setErrorMessage( errorMsg );
+
+		onChange( errorMsg ? '' : newValue );
+	};
+
+	return (
+		<Grid container gap={ 0.75 } alignItems="center">
+			<Grid item xs={ 12 }>
+				<FormLabel size="tiny">{ __( 'Value', 'elementor' ) }</FormLabel>
+			</Grid>
+			<Grid item xs={ 12 }>
+				<UnstableColorField
+					size="tiny"
+					fullWidth
+					value={ color }
+					onChange={ handleChange }
+					error={ errorMessage ?? undefined }
+					slotProps={ {
+						colorPicker: {
+							anchorEl: anchorRef.current,
+							anchorOrigin: { vertical: 'top', horizontal: 'right' },
+							transformOrigin: { vertical: 'top', horizontal: -10 },
+						},
+					} }
+				/>
+				{ errorMessage && <FormHelperText error>{ errorMessage }</FormHelperText> }
+			</Grid>
+		</Grid>
+	);
+};

package/src/components/fields/font-field.tsx

@@ -0,0 +1,85 @@
+import * as React from 'react';
+import { useRef, useState } from 'react';
+import { FontFamilySelector } from '@elementor/editor-controls';
+import { useFontFamilies, useSectionWidth } from '@elementor/editor-editing-panel';
+import { ChevronDownIcon } from '@elementor/icons';
+import {
+	bindPopover,
+	bindTrigger,
+	FormHelperText,
+	FormLabel,
+	Grid,
+	Popover,
+	UnstableTag,
+	usePopupState,
+} from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
+
+import { validateValue } from '../../utils/validations';
+import { usePopoverContentRef } from '../variable-selection-popover.context';
+
+type FontFieldProps = {
+	value: string;
+	onChange: ( value: string ) => void;
+};
+
+export const FontField = ( { value, onChange }: FontFieldProps ) => {
+	const [ fontFamily, setFontFamily ] = useState( value );
+	const [ errorMessage, setErrorMessage ] = useState( '' );
+
+	const defaultRef = useRef< HTMLDivElement >( null );
+	const anchorRef = usePopoverContentRef() ?? defaultRef;
+
+	const fontPopoverState = usePopupState( { variant: 'popover' } );
+
+	const fontFamilies = useFontFamilies();
+	const sectionWidth = useSectionWidth();
+
+	const handleChange = ( newValue: string ) => {
+		setFontFamily( newValue );
+
+		const errorMsg = validateValue( newValue );
+		setErrorMessage( errorMsg );
+
+		onChange( errorMsg ? '' : newValue );
+	};
+
+	const handleFontFamilyChange = ( newFontFamily: string ) => {
+		handleChange( newFontFamily );
+		fontPopoverState.close();
+	};
+
+	return (
+		<Grid container gap={ 0.75 } alignItems="center">
+			<Grid item xs={ 12 }>
+				<FormLabel size="tiny">{ __( 'Value', 'elementor' ) }</FormLabel>
+			</Grid>
+			<Grid item xs={ 12 }>
+				<UnstableTag
+					variant="outlined"
+					label={ fontFamily }
+					endIcon={ <ChevronDownIcon fontSize="tiny" /> }
+					{ ...bindTrigger( fontPopoverState ) }
+					fullWidth
+				/>
+				<Popover
+					disablePortal
+					disableScrollLock
+					anchorEl={ anchorRef.current }
+					anchorOrigin={ { vertical: 'top', horizontal: 'right' } }
+					transformOrigin={ { vertical: 'top', horizontal: -20 } }
+					{ ...bindPopover( fontPopoverState ) }
+				>
+					<FontFamilySelector
+						fontFamilies={ fontFamilies }
+						fontFamily={ fontFamily }
+						onFontFamilyChange={ handleFontFamilyChange }
+						onClose={ fontPopoverState.close }
+						sectionWidth={ sectionWidth }
+					/>
+				</Popover>
+				{ errorMessage && <FormHelperText error>{ errorMessage }</FormHelperText> }
+			</Grid>
+		</Grid>
+	);
+};

package/src/components/fields/label-field.tsx

@@ -0,0 +1,54 @@
+import * as React from 'react';
+import { useId, useState } from 'react';
+import { FormHelperText, FormLabel, Grid, TextField } from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
+
+import { labelHint, validateLabel, VARIABLE_LABEL_MAX_LENGTH } from '../../utils/validations';
+
+type LabelFieldProps = {
+	value: string;
+	onChange: ( value: string ) => void;
+};
+
+export const LabelField = ( { value, onChange }: LabelFieldProps ) => {
+	const [ label, setLabel ] = useState( value );
+	const [ errorMessage, setErrorMessage ] = useState( '' );
+	const [ noticeMessage, setNoticeMessage ] = useState( () => labelHint( value ) );
+
+	const handleChange = ( newValue: string ) => {
+		setLabel( newValue );
+
+		const errorMsg = validateLabel( newValue );
+		const hintMsg = labelHint( newValue );
+
+		setErrorMessage( errorMsg );
+		setNoticeMessage( errorMsg ? '' : hintMsg );
+
+		onChange( errorMsg ? '' : newValue );
+	};
+
+	const id = useId();
+
+	return (
+		<Grid container gap={ 0.75 } alignItems="center">
+			<Grid item xs={ 12 }>
+				<FormLabel htmlFor={ id } size="tiny">
+					{ __( 'Name', 'elementor' ) }
+				</FormLabel>
+			</Grid>
+			<Grid item xs={ 12 }>
+				<TextField
+					id={ id }
+					size="tiny"
+					fullWidth
+					value={ label }
+					error={ !! errorMessage }
+					onChange={ ( e: React.ChangeEvent< HTMLInputElement > ) => handleChange( e.target.value ) }
+					inputProps={ { maxLength: VARIABLE_LABEL_MAX_LENGTH } }
+				/>
+				{ errorMessage && <FormHelperText error>{ errorMessage }</FormHelperText> }
+				{ noticeMessage && <FormHelperText>{ noticeMessage }</FormHelperText> }
+			</Grid>
+		</Grid>
+	);
+};

package/src/components/font-variable-creation.tsx

@@ -1,27 +1,16 @@
 import * as React from 'react';
-import { useRef, useState } from 'react';
-import { FontFamilySelector, PopoverContent, useBoundProp } from '@elementor/editor-controls';
-import { PopoverScrollableContent, useFontFamilies, useSectionWidth } from '@elementor/editor-editing-panel';
+import { useState } from 'react';
+import { PopoverContent, useBoundProp } from '@elementor/editor-controls';
+import { PopoverScrollableContent } from '@elementor/editor-editing-panel';
 import { PopoverHeader } from '@elementor/editor-ui';
-import { ArrowLeftIcon, ChevronDownIcon, TextIcon } from '@elementor/icons';
-import {
-	bindPopover,
-	bindTrigger,
-	Button,
-	CardActions,
-	Divider,
-	FormLabel,
-	Grid,
-	IconButton,
-	Popover,
-	TextField,
-	UnstableTag,
-	usePopupState,
-} from '@elementor/ui';
+import { ArrowLeftIcon, TextIcon } from '@elementor/icons';
+import { Button, CardActions, Divider, IconButton } from '@elementor/ui';
 import { __ } from '@wordpress/i18n';
 
 import { createVariable } from '../hooks/use-prop-variables';
 import { fontVariablePropTypeUtil } from '../prop-types/font-variable-prop-type';
+import { FontField } from './fields/font-field';
+import { LabelField } from './fields/label-field';
 
 const SIZE = 'tiny';
 
@@ -31,15 +20,11 @@ type Props = {
 };
 
 export const FontVariableCreation = ( { onClose, onGoBack }: Props ) => {
-	const fontFamilies = useFontFamilies();
 	const { setValue: setVariable } = useBoundProp( fontVariablePropTypeUtil );
 
 	const [ fontFamily, setFontFamily ] = useState( '' );
 	const [ label, setLabel ] = useState( '' );
 
-	const anchorRef = useRef< HTMLDivElement >( null );
-	const fontPopoverState = usePopupState( { variant: 'popover' } );
-
 	const resetFields = () => {
 		setFontFamily( '' );
 		setLabel( '' );
@@ -61,11 +46,11 @@ export const FontVariableCreation = ( { onClose, onGoBack }: Props ) => {
 		} );
 	};
 
-	const isFormInvalid = () => {
-		return ! fontFamily?.trim() || ! label?.trim();
+	const hasEmptyValue = () => {
+		return '' === fontFamily.trim() || '' === label.trim();
 	};
 
-	const sectionWidth = useSectionWidth();
+	const isSubmitDisabled = hasEmptyValue();
 
 	return (
 		<PopoverScrollableContent height="auto">
@@ -87,56 +72,12 @@ export const FontVariableCreation = ( { onClose, onGoBack }: Props ) => {
 			<Divider />
 
 			<PopoverContent p={ 2 }>
-				<Grid container gap={ 0.75 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<FormLabel size="tiny">{ __( 'Name', 'elementor' ) }</FormLabel>
-					</Grid>
-					<Grid item xs={ 12 }>
-						<TextField
-							size="tiny"
-							fullWidth
-							value={ label }
-							onChange={ ( e: React.ChangeEvent< HTMLInputElement > ) => setLabel( e.target.value ) }
-						/>
-					</Grid>
-				</Grid>
-
-				<Grid container gap={ 0.75 } alignItems="center">
-					<Grid item xs={ 12 }>
-						<FormLabel size="tiny">{ __( 'Value', 'elementor' ) }</FormLabel>
-					</Grid>
-					<Grid item xs={ 12 }>
-						<>
-							<UnstableTag
-								variant="outlined"
-								label={ fontFamily }
-								endIcon={ <ChevronDownIcon fontSize="tiny" /> }
-								{ ...bindTrigger( fontPopoverState ) }
-								fullWidth
-							/>
-							<Popover
-								disablePortal
-								disableScrollLock
-								anchorEl={ anchorRef.current }
-								anchorOrigin={ { vertical: 'top', horizontal: 'right' } }
-								transformOrigin={ { vertical: 'top', horizontal: -20 } }
-								{ ...bindPopover( fontPopoverState ) }
-							>
-								<FontFamilySelector
-									fontFamilies={ fontFamilies }
-									fontFamily={ fontFamily }
-									onFontFamilyChange={ setFontFamily }
-									onClose={ fontPopoverState.close }
-									sectionWidth={ sectionWidth }
-								/>
-							</Popover>
-						</>
-					</Grid>
-				</Grid>
+				<LabelField value={ label } onChange={ setLabel } />
+				<FontField value={ fontFamily } onChange={ setFontFamily } />
 			</PopoverContent>
 
 			<CardActions sx={ { pt: 0.5, pb: 1 } }>
-				<Button size="small" variant="contained" disabled={ isFormInvalid() } onClick={ handleCreate }>
+				<Button size="small" variant="contained" disabled={ isSubmitDisabled } onClick={ handleCreate }>
 					{ __( 'Create', 'elementor' ) }
 				</Button>
 			</CardActions>