@elementor/editor-variables 0.13.0 → 0.15.0

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

@@ -0,0 +1,60 @@
+import * as React from 'react';
+import { useId, useRef } from 'react';
+import { useBoundProp } from '@elementor/editor-controls';
+import { stringPropTypeUtil } from '@elementor/editor-props';
+import { ColorFilterIcon } from '@elementor/icons';
+import { bindPopover, bindTrigger, Box, Popover, usePopupState } from '@elementor/ui';
+
+import { SIZE, VariableTag } from '../components/ui/variable-tag';
+import { VariableSelectionPopover } from '../components/variable-selection-popover';
+import { useVariable } from '../hooks/use-prop-variables';
+import { fontVariablePropTypeUtil } from '../prop-types/font-variable-prop-type';
+
+export const FontVariableControl = () => {
+	const { setValue: setFontFamily } = useBoundProp();
+	const { value: variableValue } = useBoundProp( fontVariablePropTypeUtil );
+
+	const anchorRef = useRef< HTMLDivElement >( null );
+
+	const popupId = useId();
+	const popupState = usePopupState( {
+		variant: 'popover',
+		popupId: `elementor-variables-list-${ popupId }`,
+	} );
+
+	const selectedVariable = useVariable( variableValue );
+	if ( ! selectedVariable ) {
+		throw new Error( `Global font variable ${ variableValue } not found` );
+	}
+
+	const unlinkVariable = () => {
+		setFontFamily( stringPropTypeUtil.create( selectedVariable.value ) );
+	};
+
+	return (
+		<Box ref={ anchorRef }>
+			<VariableTag
+				label={ selectedVariable.label }
+				startIcon={ <ColorFilterIcon fontSize={ SIZE } /> }
+				onUnlink={ unlinkVariable }
+				{ ...bindTrigger( popupState ) }
+			/>
+			<Popover
+				disableScrollLock
+				anchorEl={ anchorRef.current }
+				anchorOrigin={ { vertical: 'bottom', horizontal: 'right' } }
+				transformOrigin={ { vertical: 'top', horizontal: 'right' } }
+				PaperProps={ {
+					sx: { my: 1 },
+				} }
+				{ ...bindPopover( popupState ) }
+			>
+				<VariableSelectionPopover
+					selectedVariable={ selectedVariable }
+					closePopover={ popupState.close }
+					propTypeKey={ fontVariablePropTypeUtil.key }
+				/>
+			</Popover>
+		</Box>
+	);
+};

package/src/create-style-variables-repository.ts

@@ -1,6 +1,7 @@
-import { type StyleVariables, type Variables, type VariableValue } from './types';
+import { type StyleVariables, type Variable } from './types';
 
 type VariablesChangeCallback = ( variables: StyleVariables ) => void;
+type Variables = Record< string, Variable >;
 
 export const createStyleVariablesRepository = () => {
 	const variables: StyleVariables = {};
@@ -20,7 +21,7 @@ export const createStyleVariablesRepository = () => {
 		}
 	};
 
-	const shouldUpdate = ( key: string, newValue: VariableValue ): boolean => {
+	const shouldUpdate = ( key: string, newValue: string ): boolean => {
 		return ! ( key in variables ) || variables[ key ] !== newValue;
 	};
 

package/src/hooks/use-prop-color-variable-action.tsx

@@ -3,7 +3,8 @@ import { type PopoverActionProps, useBoundProp } from '@elementor/editor-editing
 import { ColorFilterIcon } from '@elementor/icons';
 import { __ } from '@wordpress/i18n';
 
-import { ColorVariablesSelection } from '../components/color-variables-selection';
+import { VariableSelectionPopover } from '../components/variable-selection-popover';
+import { colorVariablePropTypeUtil } from '../prop-types/color-variable-prop-type';
 import { supportsColorVariables } from '../utils';
 
 export const usePropColorVariableAction = (): PopoverActionProps => {
@@ -15,6 +16,10 @@ export const usePropColorVariableAction = (): PopoverActionProps => {
 		visible,
 		icon: ColorFilterIcon,
 		title: __( 'Variables', 'elementor' ),
-		popoverContent: ( { closePopover } ) => <ColorVariablesSelection onSelect={ closePopover } />,
+		content: ( { close: closePopover } ) => {
+			return (
+				<VariableSelectionPopover closePopover={ closePopover } propTypeKey={ colorVariablePropTypeUtil.key } />
+			);
+		},
 	};
 };

package/src/hooks/use-prop-font-variable-action.tsx

@@ -3,7 +3,8 @@ import { type PopoverActionProps, useBoundProp } from '@elementor/editor-editing
 import { ColorFilterIcon } from '@elementor/icons';
 import { __ } from '@wordpress/i18n';
 
-import { FontVariablesSelection } from '../components/font-variables-selection';
+import { VariableSelectionPopover } from '../components/variable-selection-popover';
+import { fontVariablePropTypeUtil } from '../prop-types/font-variable-prop-type';
 import { supportsFontVariables } from '../utils';
 
 export const usePropFontVariableAction = (): PopoverActionProps => {
@@ -15,6 +16,10 @@ export const usePropFontVariableAction = (): PopoverActionProps => {
 		visible,
 		icon: ColorFilterIcon,
 		title: __( 'Variables', 'elementor' ),
-		popoverContent: ( { closePopover } ) => <FontVariablesSelection onSelect={ closePopover } />,
+		content: ( { close: closePopover } ) => {
+			return (
+				<VariableSelectionPopover closePopover={ closePopover } propTypeKey={ fontVariablePropTypeUtil.key } />
+			);
+		},
 	};
 };

package/src/hooks/use-prop-variables.ts

@@ -2,14 +2,8 @@ import { useMemo } from 'react';
 import { type PropKey } from '@elementor/editor-props';
 
 import { service } from '../service';
-import { type TVariable } from '../storage';
-import { styleVariablesRepository } from '../style-variables-repository';
 import { type Variable } from '../types';
 
-export const usePropVariables = ( propKey: PropKey ) => {
-	return useMemo( () => normalizeVariables( propKey ), [ propKey ] );
-};
-
 export const useVariable = ( key: string ) => {
 	const variables = service.variables();
 
@@ -23,13 +17,31 @@ export const useVariable = ( key: string ) => {
 	};
 };
 
+export const useFilteredVariables = ( searchValue: string, propTypeKey: string ) => {
+	const variables = usePropVariables( propTypeKey );
+
+	const filteredVariables = variables.filter( ( { label } ) => {
+		return label.toLowerCase().includes( searchValue.toLowerCase() );
+	} );
+
+	return {
+		list: filteredVariables,
+		hasMatches: filteredVariables.length > 0,
+		isSourceNotEmpty: variables.length > 0,
+	};
+};
+
+const usePropVariables = ( propKey: PropKey ) => {
+	return useMemo( () => normalizeVariables( propKey ), [ propKey ] );
+};
+
+const isNotDeleted = ( { deleted }: { deleted?: boolean } ) => ! deleted;
+
 const normalizeVariables = ( propKey: string ) => {
 	const variables = service.variables();
 
-	styleVariablesRepository.update( variables );
-
 	return Object.entries( variables )
-		.filter( ( [ , { type } ] ) => type === propKey )
+		.filter( ( [ , variable ] ) => variable.type === propKey && isNotDeleted( variable ) )
 		.map( ( [ key, { label, value } ] ) => ( {
 			key,
 			label,
@@ -38,10 +50,19 @@ const normalizeVariables = ( propKey: string ) => {
 };
 
 export const createVariable = ( newVariable: Variable ): Promise< string > => {
-	return service.create( newVariable ).then( ( { id, variable }: { id: string; variable: TVariable } ) => {
-		styleVariablesRepository.update( {
-			[ id ]: variable,
-		} );
+	return service.create( newVariable ).then( ( { id }: { id: string } ) => {
+		return id;
+	} );
+};
+
+export const updateVariable = ( updateId: string, { value, label }: { value: string; label: string } ) => {
+	return service.update( updateId, { value, label } ).then( ( { id }: { id: string } ) => {
+		return id;
+	} );
+};
+
+export const deleteVariable = ( deleteId: string ) => {
+	return service.delete( deleteId ).then( ( { id }: { id: string } ) => {
 		return id;
 	} );
 };

package/src/init-color-variables.ts

@@ -1,7 +1,14 @@
 import { styleTransformersRegistry } from '@elementor/editor-canvas';
+import { injectIntoRepeaterItemIcon, injectIntoRepeaterItemLabel } from '@elementor/editor-controls';
 import { controlActionsMenu, registerControlReplacement } from '@elementor/editor-editing-panel';
+import { backgroundColorOverlayPropTypeUtil, type PropValue, shadowPropTypeUtil } from '@elementor/editor-props';
 
-import { ColorVariablesSelectionControl } from './controls/color-variables-selection-control';
+import {
+	BackgroundRepeaterColorIndicator,
+	BackgroundRepeaterLabel,
+	BoxShadowRepeaterColorIndicator,
+} from './components/variables-repeater-item-slot';
+import { ColorVariableControl } from './controls/color-variable-control';
 import { usePropColorVariableAction } from './hooks/use-prop-color-variable-action';
 import { colorVariablePropTypeUtil } from './prop-types/color-variable-prop-type';
 import { variableTransformer } from './transformers/variable-transformer';
@@ -9,9 +16,19 @@ import { hasAssignedColorVariable } from './utils';
 
 const { registerPopoverAction } = controlActionsMenu;
 
-export function initColorVariables() {
+const conditions = {
+	backgroundOverlay: ( { value: prop }: { value: PropValue } ) => {
+		return hasAssignedColorVariable( backgroundColorOverlayPropTypeUtil.extract( prop )?.color );
+	},
+
+	boxShadow: ( { value: prop }: { value: PropValue } ) => {
+		return hasAssignedColorVariable( shadowPropTypeUtil.extract( prop )?.color );
+	},
+};
+
+function registerControlsAndActions() {
 	registerControlReplacement( {
-		component: ColorVariablesSelectionControl,
+		component: ColorVariableControl,
 		condition: ( { value } ) => hasAssignedColorVariable( value ),
 	} );
 
@@ -19,6 +36,37 @@ export function initColorVariables() {
 		id: 'color-variables',
 		useProps: usePropColorVariableAction,
 	} );
+}
+
+function registerRepeaterItemIcons() {
+	injectIntoRepeaterItemIcon( {
+		id: 'color-variables-background-icon',
+		component: BackgroundRepeaterColorIndicator,
+		condition: conditions.backgroundOverlay,
+	} );
 
+	injectIntoRepeaterItemIcon( {
+		id: 'color-variables-icon',
+		component: BoxShadowRepeaterColorIndicator,
+		condition: conditions.boxShadow,
+	} );
+}
+
+function registerRepeaterItemLabels() {
+	injectIntoRepeaterItemLabel( {
+		id: 'color-variables-label',
+		component: BackgroundRepeaterLabel,
+		condition: conditions.backgroundOverlay,
+	} );
+}
+
+function registerStyleTransformers() {
 	styleTransformersRegistry.register( colorVariablePropTypeUtil.key, variableTransformer );
 }
+
+export function initColorVariables() {
+	registerControlsAndActions();
+	registerRepeaterItemIcons();
+	registerRepeaterItemLabels();
+	registerStyleTransformers();
+}

package/src/init-font-variables.ts

@@ -1,7 +1,7 @@
 import { styleTransformersRegistry } from '@elementor/editor-canvas';
 import { controlActionsMenu, registerControlReplacement } from '@elementor/editor-editing-panel';
 
-import { FontVariablesSelectionControl } from './controls/font-variables-selection-control';
+import { FontVariableControl } from './controls/font-variable-control';
 import { usePropFontVariableAction } from './hooks/use-prop-font-variable-action';
 import { fontVariablePropTypeUtil } from './prop-types/font-variable-prop-type';
 import { variableTransformer } from './transformers/variable-transformer';
@@ -11,7 +11,7 @@ const { registerPopoverAction } = controlActionsMenu;
 
 export function initFontVariables() {
 	registerControlReplacement( {
-		component: FontVariablesSelectionControl,
+		component: FontVariableControl,
 		condition: ( { value } ) => hasAssignedFontVariable( value ),
 	} );
 

package/src/service.ts

@@ -1,5 +1,7 @@
 import { apiClient } from './api';
-import { OP_RW, Storage, type TVariable, type TVariablesList } from './storage';
+import { OP_RW, Storage, type TVariablesList } from './storage';
+import { styleVariablesRepository } from './style-variables-repository';
+import { type Variable } from './types';
 
 const storage = new Storage();
 
@@ -29,11 +31,13 @@ export const service = {
 
 				storage.fill( variables, watermark );
 
+				styleVariablesRepository.update( variables );
+
 				return variables;
 			} );
 	},
 
-	create: ( { type, label, value }: TVariable ) => {
+	create: ( { type, label, value }: Variable ) => {
 		return apiClient
 			.create( type, label, value )
 			.then( ( response ) => {
@@ -54,6 +58,10 @@ export const service = {
 
 				storage.add( variableId, createdVariable );
 
+				styleVariablesRepository.update( {
+					[ variableId ]: createdVariable,
+				} );
+
 				return {
 					id: variableId,
 					variable: createdVariable,
@@ -61,7 +69,7 @@ export const service = {
 			} );
 	},
 
-	update: ( id: string, { label, value }: TVariable ) => {
+	update: ( id: string, { label, value }: Omit< Variable, 'type' > ) => {
 		return apiClient
 			.update( id, label, value )
 			.then( ( response ) => {
@@ -82,6 +90,10 @@ export const service = {
 
 				storage.update( variableId, updatedVariable );
 
+				styleVariablesRepository.update( {
+					[ variableId ]: updatedVariable,
+				} );
+
 				return {
 					id: variableId,
 					variable: updatedVariable,
@@ -110,6 +122,10 @@ export const service = {
 
 				storage.update( variableId, deletedVariable );
 
+				styleVariablesRepository.update( {
+					[ variableId ]: deletedVariable,
+				} );
+
 				return {
 					id: variableId,
 					variable: deletedVariable,
@@ -138,6 +154,10 @@ export const service = {
 
 				storage.update( variableId, restoredVariable );
 
+				styleVariablesRepository.update( {
+					[ variableId ]: restoredVariable,
+				} );
+
 				return {
 					id: variableId,
 					variable: restoredVariable,

package/src/storage.ts

@@ -34,8 +34,12 @@ export class Storage {
 	}
 
 	fill( variables: TVariablesList, watermark: number ) {
+		this.state.variables = {};
+		if ( variables && Object.keys( variables ).length ) {
+			this.state.variables = variables;
+		}
+
 		this.state.watermark = watermark;
-		this.state.variables = variables;
 
 		localStorage.setItem( STORAGE_WATERMARK_KEY, this.state.watermark.toString() );
 		localStorage.setItem( STORAGE_KEY, JSON.stringify( this.state.variables ) );

package/src/types.ts

@@ -1,15 +1,19 @@
-export type VariableKey = string;
-
-export type VariableValue = string;
+import type * as React from 'react';
+import { type VirtualizedItem } from '@elementor/editor-ui';
 
 export type Variable = {
-	value: VariableValue;
+	key?: string;
 	label: string;
+	value: string;
 	type: string;
+	deleted?: boolean;
+	deleted_at?: string;
 };
 
-export type Variables = {
-	[ key: VariableKey ]: Variable;
-};
+export type StyleVariables = Record< string, string >;
 
-export type StyleVariables = Record< VariableKey, VariableValue >;
+export type ExtendedVirtualizedItem = VirtualizedItem< 'item', string > & {
+	icon: React.ReactNode;
+	secondaryText: string;
+	onEdit?: () => void;
+};

package/src/components/styled-menu-item.tsx

@@ -1,10 +0,0 @@
-import { MenuItem, styled } from '@elementor/ui';
-
-export const StyledMenuItem = styled( MenuItem )( () => ( {
-	pl: 2,
-	pr: 1,
-	py: 0.5,
-	'&:hover .MuiSvgIcon-root': {
-		opacity: 1,
-	},
-} ) );

package/src/components/variables-selection-popover.tsx

@@ -1,119 +0,0 @@
-import * as React from 'react';
-import { useId, useRef } from 'react';
-import { PopoverHeader } from '@elementor/editor-ui';
-import { ColorFilterIcon, DetachIcon, PlusIcon } from '@elementor/icons';
-import {
-	bindPopover,
-	bindTrigger,
-	Box,
-	IconButton,
-	Popover,
-	Stack,
-	Typography,
-	UnstableTag as Tag,
-	usePopupState,
-} from '@elementor/ui';
-import { __ } from '@wordpress/i18n';
-
-import { colorVariablePropTypeUtil } from '../prop-types/color-variable-prop-type';
-import { fontVariablePropTypeUtil } from '../prop-types/font-variable-prop-type';
-import { type Variable } from '../types';
-import { ColorVariableCreation } from './color-variable-creation';
-import { FontVariableCreation } from './font-variable-creation';
-
-type Props = {
-	selectedVariable: Variable;
-	unlinkVariable: () => void;
-	children: ( { closePopover }: { closePopover: () => void } ) => React.ReactNode;
-	startTagAdornment?: React.ReactNode;
-};
-
-const SIZE = 'tiny';
-
-export const VariablesSelectionPopover = ( {
-	selectedVariable,
-	unlinkVariable,
-	startTagAdornment,
-	children,
-}: Props ) => {
-	const id = useId();
-	const popupState = usePopupState( { variant: 'popover', popupId: `elementor-variables-action-${ id }` } );
-	const creationPopupState = usePopupState( { variant: 'popover', popupId: `elementor-variables-creation-${ id }` } );
-
-	const closePopover = () => popupState.close();
-
-	const handleCreateButtonClick = ( event: React.MouseEvent ) => {
-		closePopover();
-		bindTrigger( creationPopupState ).onClick( event );
-	};
-
-	const anchorRef = useRef< HTMLDivElement >( null );
-	const { label } = selectedVariable;
-
-	const colorCreationEnabled = colorVariablePropTypeUtil.key === selectedVariable.type;
-	const fontCreationEnabled = fontVariablePropTypeUtil.key === selectedVariable.type;
-
-	return (
-		<Box ref={ anchorRef }>
-			<Tag
-				fullWidth
-				showActionsOnHover
-				{ ...bindTrigger( popupState ) }
-				startIcon={
-					<Stack spacing={ 1 } direction="row" alignItems="center">
-						{ startTagAdornment }
-						<ColorFilterIcon fontSize={ 'inherit' } sx={ { mr: 1 } } />
-					</Stack>
-				}
-				label={
-					<Box sx={ { display: 'inline-grid' } }>
-						<Typography sx={ { textOverflow: 'ellipsis', overflowX: 'hidden' } } variant="subtitle2">
-							{ label }
-						</Typography>
-					</Box>
-				}
-				actions={
-					<IconButton size={ SIZE } onClick={ unlinkVariable } aria-label={ __( 'Unlink', 'elementor' ) }>
-						<DetachIcon fontSize={ SIZE } />
-					</IconButton>
-				}
-			/>
-			<Popover
-				{ ...bindPopover( popupState ) }
-				disableScrollLock
-				anchorEl={ anchorRef.current }
-				anchorOrigin={ { vertical: 'bottom', horizontal: 'right' } }
-				transformOrigin={ { vertical: 'top', horizontal: 'right' } }
-			>
-				<PopoverHeader
-					title={ __( 'Variables', 'elementor' ) }
-					onClose={ closePopover }
-					icon={ <ColorFilterIcon fontSize={ SIZE } /> }
-					actions={ [
-						<IconButton
-							key="createVariable"
-							{ ...bindTrigger( creationPopupState ) }
-							size={ SIZE }
-							onClick={ handleCreateButtonClick }
-						>
-							<PlusIcon fontSize={ SIZE } />
-						</IconButton>,
-					] }
-				/>
-				{ children?.( { closePopover } ) }
-			</Popover>
-
-			<Box ref={ anchorRef }>
-				<Popover
-					{ ...bindPopover( creationPopupState ) }
-					anchorEl={ anchorRef.current }
-					anchorOrigin={ { vertical: 'bottom', horizontal: 'right' } }
-					transformOrigin={ { vertical: 'top', horizontal: 'right' } }
-				>
-					{ colorCreationEnabled && <ColorVariableCreation onClose={ creationPopupState.close } /> }
-					{ fontCreationEnabled && <FontVariableCreation onClose={ creationPopupState.close } /> }
-				</Popover>
-			</Box>
-		</Box>
-	);
-};

package/src/controls/color-variables-selection-control.tsx

@@ -1,34 +0,0 @@
-import * as React from 'react';
-import { useBoundProp } from '@elementor/editor-controls';
-import { colorPropTypeUtil } from '@elementor/editor-props';
-
-import { ColorIndicator } from '../components/color-indicator';
-import { ColorVariablesSelection } from '../components/color-variables-selection';
-import { VariablesSelectionPopover } from '../components/variables-selection-popover';
-import { useVariable } from '../hooks/use-prop-variables';
-import { colorVariablePropTypeUtil } from '../prop-types/color-variable-prop-type';
-
-export const ColorVariablesSelectionControl = () => {
-	const { setValue } = useBoundProp();
-	const { value: variableValue } = useBoundProp( colorVariablePropTypeUtil );
-
-	const selectedVariable = useVariable( variableValue );
-
-	if ( ! selectedVariable ) {
-		throw new Error( `Global color variable ${ variableValue } not found` );
-	}
-
-	const unlinkVariable = () => {
-		setValue( colorPropTypeUtil.create( selectedVariable.value ) );
-	};
-
-	return (
-		<VariablesSelectionPopover
-			selectedVariable={ selectedVariable }
-			unlinkVariable={ unlinkVariable }
-			startTagAdornment={ <ColorIndicator size="inherit" component="span" value={ selectedVariable.value } /> }
-		>
-			{ ( { closePopover } ) => <ColorVariablesSelection onSelect={ closePopover } /> }
-		</VariablesSelectionPopover>
-	);
-};

package/src/controls/font-variables-selection-control.tsx

@@ -1,29 +0,0 @@
-import * as React from 'react';
-import { useBoundProp } from '@elementor/editor-controls';
-import { stringPropTypeUtil } from '@elementor/editor-props';
-
-import { FontVariablesSelection } from '../components/font-variables-selection';
-import { VariablesSelectionPopover } from '../components/variables-selection-popover';
-import { useVariable } from '../hooks/use-prop-variables';
-import { fontVariablePropTypeUtil } from '../prop-types/font-variable-prop-type';
-
-export const FontVariablesSelectionControl = () => {
-	const { setValue: setFontFamily } = useBoundProp();
-	const { value: variableValue } = useBoundProp( fontVariablePropTypeUtil );
-
-	const selectedVariable = useVariable( variableValue );
-
-	if ( ! selectedVariable ) {
-		throw new Error( `Global font variable ${ variableValue } not found` );
-	}
-
-	const unlinkVariable = () => {
-		setFontFamily( stringPropTypeUtil.create( selectedVariable.value ) );
-	};
-
-	return (
-		<VariablesSelectionPopover selectedVariable={ selectedVariable } unlinkVariable={ unlinkVariable }>
-			{ ( { closePopover } ) => <FontVariablesSelection onSelect={ closePopover } /> }
-		</VariablesSelectionPopover>
-	);
-};