@elementor/editor-variables 0.12.0 → 0.14.0

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

@@ -1,70 +1,116 @@
 import * as React from 'react';
-import { Fragment } from 'react';
+import { useState } from 'react';
 import { useBoundProp } from '@elementor/editor-controls';
-import { EditIcon, TextIcon } from '@elementor/icons';
-import { Box, Divider, ListItemIcon, ListItemText, MenuList } from '@elementor/ui';
+import { PopoverHeader, PopoverMenuList, PopoverSearch, type VirtualizedItem } from '@elementor/editor-ui';
+import { ColorFilterIcon, PlusIcon, SettingsIcon, TextIcon } from '@elementor/icons';
+import { Divider, IconButton } from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
 
-import { usePropVariables } from '../hooks/use-prop-variables';
+import { useFilteredVariables } from '../hooks/use-prop-variables';
 import { fontVariablePropTypeUtil } from '../prop-types/font-variable-prop-type';
-import { type VariableKey } from '../types';
-import { StyledMenuItem } from './styled-menu-item';
+import { type ExtendedVirtualizedItem } from '../types';
+import { MenuItemContent } from './ui/menu-item-content';
+import { NoSearchResults } from './ui/no-search-results';
+import { NoVariables } from './ui/no-variables';
+import { VariablesStyledMenuList } from './ui/styled-menu-list';
+
+const SIZE = 'tiny';
 
 type Props = {
-	onSelect?: () => void;
+	closePopover: () => void;
+	onAdd?: () => void;
+	onEdit?: ( key: string ) => void;
+	onSettings?: () => void;
 };
 
-export const FontVariablesSelection = ( { onSelect }: Props ) => {
+export const FontVariablesSelection = ( { closePopover, onAdd, onEdit, onSettings }: Props ) => {
 	const { value: variable, setValue: setVariable } = useBoundProp( fontVariablePropTypeUtil );
+	const [ searchValue, setSearchValue ] = useState( '' );
 
-	const variables = usePropVariables( fontVariablePropTypeUtil.key );
+	const {
+		list: variables,
+		hasMatches: hasSearchResults,
+		isSourceNotEmpty: hasVariables,
+	} = useFilteredVariables( searchValue, fontVariablePropTypeUtil.key );
 
-	const handleSetVariable = ( key: VariableKey ) => {
+	const handleSetVariable = ( key: string ) => {
 		setVariable( key );
+		closePopover();
+	};
+
+	const actions = [];
+
+	if ( onAdd ) {
+		actions.push(
+			<IconButton key="add" size={ SIZE } onClick={ onAdd }>
+				<PlusIcon fontSize={ SIZE } />
+			</IconButton>
+		);
+	}
 
-		onSelect?.();
+	if ( onSettings ) {
+		actions.push(
+			<IconButton key="settings" size={ SIZE } onClick={ onSettings }>
+				<SettingsIcon fontSize={ SIZE } />
+			</IconButton>
+		);
+	}
+
+	const items: ExtendedVirtualizedItem[] = variables.map( ( { value, label, key } ) => ( {
+		type: 'item' as const,
+		value: key,
+		label,
+		icon: <TextIcon />,
+		secondaryText: value,
+		onEdit: () => onEdit?.( key ),
+	} ) );
+
+	const handleSearch = ( search: string ) => {
+		setSearchValue( search );
+	};
+
+	const handleClearSearch = () => {
+		setSearchValue( '' );
 	};
 
 	return (
-		<Fragment>
+		<>
+			<PopoverHeader
+				title={ __( 'Variables', 'elementor' ) }
+				onClose={ closePopover }
+				icon={ <ColorFilterIcon fontSize={ SIZE } /> }
+				actions={ actions }
+			/>
+
+			{ hasVariables && (
+				<PopoverSearch
+					value={ searchValue }
+					onSearch={ handleSearch }
+					placeholder={ __( 'Search', 'elementor' ) }
+				/>
+			) }
+
 			<Divider />
-			<Box sx={ { overflowY: 'auto', height: 260, width: 220 } }>
-				<MenuList role="listbox" tabIndex={ 0 }>
-					{ variables.map( ( { value, label, key } ) => (
-						<StyledMenuItem
-							key={ key }
-							onClick={ () => handleSetVariable( key ) }
-							selected={ key === variable }
-						>
-							<ListItemIcon>
-								<TextIcon />
-							</ListItemIcon>
-							<ListItemText
-								primary={ label }
-								secondary={ value }
-								primaryTypographyProps={ {
-									variant: 'body2',
-									color: 'text.secondary',
-									style: {
-										lineHeight: 2,
-										display: 'inline-block',
-										overflow: 'hidden',
-										textOverflow: 'ellipsis',
-										whiteSpace: 'nowrap',
-										maxWidth: '81px',
-									},
-								} }
-								secondaryTypographyProps={ {
-									variant: 'caption',
-									color: 'text.tertiary',
-									style: { marginTop: '1px', lineHeight: '1' },
-								} }
-								sx={ { display: 'flex', alignItems: 'center', gap: 1 } }
-							/>
-							<EditIcon color="action" fontSize="inherit" sx={ { mx: 1, opacity: '0' } } />
-						</StyledMenuItem>
-					) ) }
-				</MenuList>
-			</Box>
-		</Fragment>
+
+			{ hasVariables && hasSearchResults && (
+				<PopoverMenuList
+					items={ items }
+					onSelect={ handleSetVariable }
+					onClose={ () => {} }
+					selectedValue={ variable }
+					data-testid="font-variables-list"
+					menuListTemplate={ VariablesStyledMenuList }
+					menuItemContentTemplate={ ( item: VirtualizedItem< 'item', string > ) => (
+						<MenuItemContent item={ item } />
+					) }
+				/>
+			) }
+
+			{ ! hasSearchResults && hasVariables && (
+				<NoSearchResults searchValue={ searchValue } onClear={ handleClearSearch } />
+			) }
+
+			{ ! hasVariables && <NoVariables icon={ <TextIcon fontSize="large" /> } onAdd={ onAdd } /> }
+		</>
 	);
 };

package/src/components/ui/menu-item-content.tsx

@@ -0,0 +1,51 @@
+import * as React from 'react';
+import type { VirtualizedItem } from '@elementor/editor-ui';
+import { EditIcon } from '@elementor/icons';
+import { IconButton, ListItemIcon, ListItemText } from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
+
+const SIZE = 'tiny';
+
+export const MenuItemContent = < T, V extends string >( { item }: { item: VirtualizedItem< T, V > } ) => {
+	const onEdit = item.onEdit as ( ( value: V ) => void ) | undefined;
+
+	return (
+		<>
+			<ListItemIcon>{ item.icon }</ListItemIcon>
+			<ListItemText
+				primary={ item.label || item.value }
+				secondary={ item.secondaryText }
+				primaryTypographyProps={ {
+					variant: 'body2',
+					color: 'text.secondary',
+					style: {
+						lineHeight: 2,
+						display: 'inline-block',
+						overflow: 'hidden',
+						textOverflow: 'ellipsis',
+						whiteSpace: 'nowrap',
+						maxWidth: '81px',
+					},
+				} }
+				secondaryTypographyProps={ {
+					variant: 'caption',
+					color: 'text.tertiary',
+					style: { marginTop: '1px', lineHeight: '1' },
+				} }
+				sx={ { display: 'flex', alignItems: 'center', gap: 1 } }
+			/>
+			{ !! onEdit && (
+				<IconButton
+					sx={ { mx: 1, opacity: '0' } }
+					onClick={ ( e: React.MouseEvent< HTMLButtonElement > ) => {
+						e.stopPropagation();
+						onEdit( item.value );
+					} }
+					aria-label={ __( 'Edit', 'elementor' ) }
+				>
+					<EditIcon color="action" fontSize={ SIZE } />
+				</IconButton>
+			) }
+		</>
+	);
+};

package/src/components/ui/no-search-results.tsx

@@ -0,0 +1,38 @@
+import * as React from 'react';
+import { ColorFilterIcon } from '@elementor/icons';
+import { Link, Stack, Typography } from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
+
+type Props = {
+	searchValue: string;
+	onClear?: () => void;
+};
+
+export const NoSearchResults = ( { searchValue, onClear }: Props ) => {
+	return (
+		<Stack
+			gap={ 1 }
+			alignItems="center"
+			justifyContent="center"
+			height="100%"
+			color="text.secondary"
+			sx={ { p: 2.5, pb: 5.5 } }
+		>
+			<ColorFilterIcon fontSize="large" />
+
+			<Typography align="center" variant="subtitle2">
+				{ __( 'Sorry, nothing matched', 'elementor' ) }
+				<br />
+				&ldquo;{ searchValue }&rdquo;.
+			</Typography>
+
+			<Typography align="center" variant="caption">
+				{ __( 'Try something else.', 'elementor' ) }
+				<br />
+				<Link color="text.secondary" variant="caption" component="button" onClick={ onClear }>
+					{ __( 'Clear & try again', 'elementor' ) }
+				</Link>
+			</Typography>
+		</Stack>
+	);
+};

package/src/components/ui/no-variables.tsx

@@ -0,0 +1,35 @@
+import * as React from 'react';
+import { Button, Stack, Typography } from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
+
+type Props = {
+	icon?: React.ReactNode;
+	onAdd?: () => void;
+};
+
+export const NoVariables = ( { icon, onAdd }: Props ) => (
+	<Stack
+		gap={ 1 }
+		alignItems="center"
+		justifyContent="center"
+		height="100%"
+		color="text.secondary"
+		sx={ { p: 2.5, pb: 5.5 } }
+	>
+		{ icon }
+
+		<Typography align="center" variant="subtitle2">
+			{ __( 'Create your first variable', 'elementor' ) }
+		</Typography>
+
+		<Typography align="center" variant="caption" maxWidth="180px">
+			{ __( 'Variables are saved attributes that you can apply anywhere on your site.', 'elementor' ) }
+		</Typography>
+
+		{ onAdd && (
+			<Button variant="outlined" color="secondary" size="small" onClick={ onAdd }>
+				{ __( 'Create a variable', 'elementor' ) }
+			</Button>
+		) }
+	</Stack>
+);

package/src/components/ui/styled-menu-list.tsx

@@ -0,0 +1,31 @@
+import { MenuList, styled } from '@elementor/ui';
+
+export const VariablesStyledMenuList = styled( MenuList )( ( { theme } ) => ( {
+	'& > li': {
+		height: 32,
+		width: '100%',
+		display: 'flex',
+		alignItems: 'center',
+	},
+	'& > [role="option"]': {
+		...theme.typography.caption,
+		lineHeight: 'inherit',
+		padding: theme.spacing( 0.5, 1, 0.5, 2 ),
+		'&:hover, &:focus': {
+			backgroundColor: theme.palette.action.hover,
+		},
+		'&[aria-selected="true"]': {
+			backgroundColor: theme.palette.action.selected,
+		},
+		cursor: 'pointer',
+		textOverflow: 'ellipsis',
+		position: 'absolute',
+		top: 0,
+		left: 0,
+		'&:hover .MuiIconButton-root, .MuiIconButton-root:focus': {
+			opacity: 1,
+		},
+	},
+	width: '100%',
+	position: 'relative',
+} ) );

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

@@ -0,0 +1,133 @@
+import * as React from 'react';
+import { useRef, useState } from 'react';
+
+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 { ColorVariableEdit } from './color-variable-edit';
+import { ColorVariablesSelection } from './color-variables-selection';
+import { FontVariableCreation } from './font-variable-creation';
+import { FontVariableEdit } from './font-variable-edit';
+import { FontVariablesSelection } from './font-variables-selection';
+
+const VIEW_LIST = 'list';
+const VIEW_ADD = 'add';
+const VIEW_EDIT = 'edit';
+
+type View = typeof VIEW_LIST | typeof VIEW_ADD | typeof VIEW_EDIT;
+
+type Props = {
+	closePopover: () => void;
+	propTypeKey: string;
+	selectedVariable?: Variable;
+};
+
+export const VariableSelectionPopover = ( { closePopover, propTypeKey, selectedVariable }: Props ) => {
+	const [ currentView, setCurrentView ] = useState< View >( VIEW_LIST );
+	const editIdRef = useRef< string >( '' );
+
+	return renderStage( {
+		propTypeKey,
+		currentView,
+		selectedVariable,
+		editIdRef,
+		setCurrentView,
+		closePopover,
+	} );
+};
+
+type StageProps = {
+	propTypeKey: string;
+	currentView: View;
+	selectedVariable?: Variable;
+	editIdRef: React.MutableRefObject< string >;
+	setCurrentView: ( stage: View ) => void;
+	closePopover: () => void;
+};
+
+function renderStage( props: StageProps ): React.ReactNode {
+	const handleSubmitOnEdit = () => {
+		if ( props?.selectedVariable?.key === props.editIdRef.current ) {
+			props.closePopover();
+		} else {
+			props.setCurrentView( VIEW_LIST );
+		}
+	};
+
+	if ( fontVariablePropTypeUtil.key === props.propTypeKey ) {
+		if ( VIEW_LIST === props.currentView ) {
+			return (
+				<FontVariablesSelection
+					closePopover={ props.closePopover }
+					onAdd={ () => {
+						props.setCurrentView( VIEW_ADD );
+					} }
+					onEdit={ ( key ) => {
+						props.editIdRef.current = key;
+						props.setCurrentView( VIEW_EDIT );
+					} }
+				/>
+			);
+		}
+
+		if ( VIEW_ADD === props.currentView ) {
+			return (
+				<FontVariableCreation
+					onGoBack={ () => props.setCurrentView( VIEW_LIST ) }
+					onClose={ props.closePopover }
+				/>
+			);
+		}
+
+		if ( VIEW_EDIT === props.currentView ) {
+			return (
+				<FontVariableEdit
+					editId={ props.editIdRef.current ?? '' }
+					onGoBack={ () => props.setCurrentView( VIEW_LIST ) }
+					onClose={ props.closePopover }
+					onSubmit={ handleSubmitOnEdit }
+				/>
+			);
+		}
+	}
+
+	if ( colorVariablePropTypeUtil.key === props.propTypeKey ) {
+		if ( VIEW_LIST === props.currentView ) {
+			return (
+				<ColorVariablesSelection
+					closePopover={ props.closePopover }
+					onAdd={ () => {
+						props.setCurrentView( VIEW_ADD );
+					} }
+					onEdit={ ( key ) => {
+						props.editIdRef.current = key;
+						props.setCurrentView( VIEW_EDIT );
+					} }
+				/>
+			);
+		}
+
+		if ( VIEW_ADD === props.currentView ) {
+			return (
+				<ColorVariableCreation
+					onGoBack={ () => props.setCurrentView( VIEW_LIST ) }
+					onClose={ props.closePopover }
+				/>
+			);
+		}
+
+		if ( VIEW_EDIT === props.currentView ) {
+			return (
+				<ColorVariableEdit
+					editId={ props.editIdRef.current ?? '' }
+					onGoBack={ () => props.setCurrentView( VIEW_LIST ) }
+					onClose={ props.closePopover }
+					onSubmit={ handleSubmitOnEdit }
+				/>
+			);
+		}
+	}
+
+	return null;
+}

package/src/components/variables-repeater-item-slot.tsx

@@ -0,0 +1,29 @@
+import * as React from 'react';
+import { type BackgroundColorOverlayPropValue, type BoxShadowPropValue, type PropValue } from '@elementor/editor-props';
+
+import { useVariable } from '../hooks/use-prop-variables';
+import { ColorIndicator } from './ui/color-indicator';
+
+const useColorVariable = ( value: BackgroundColorOverlayPropValue | BoxShadowPropValue ) => {
+	const variableId = value?.value?.color?.value;
+
+	return useVariable( variableId || '' );
+};
+
+export const BackgroundRepeaterColorIndicator = ( { value }: { value: PropValue } ) => {
+	const colorVariable = useColorVariable( value as BackgroundColorOverlayPropValue );
+
+	return <ColorIndicator component="span" size="inherit" value={ colorVariable?.value } />;
+};
+
+export const BackgroundRepeaterLabel = ( { value }: { value: PropValue } ) => {
+	const colorVariable = useColorVariable( value as BackgroundColorOverlayPropValue );
+
+	return <span>{ colorVariable?.label }</span>;
+};
+
+export const BoxShadowRepeaterColorIndicator = ( { value }: { value: PropValue } ) => {
+	const colorVariable = useColorVariable( value as BoxShadowPropValue );
+
+	return <ColorIndicator component="span" size="inherit" value={ colorVariable?.value } />;
+};

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

@@ -0,0 +1,90 @@
+import * as React from 'react';
+import { useId, useRef } from 'react';
+import { useBoundProp } from '@elementor/editor-controls';
+import { colorPropTypeUtil } from '@elementor/editor-props';
+import { ColorFilterIcon, DetachIcon } from '@elementor/icons';
+import {
+	bindPopover,
+	bindTrigger,
+	Box,
+	IconButton,
+	Popover,
+	Stack,
+	Typography,
+	UnstableTag as Tag,
+	usePopupState,
+} from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
+
+import { ColorIndicator } from '../components/ui/color-indicator';
+import { VariableSelectionPopover } from '../components/variable-selection-popover';
+import { useVariable } from '../hooks/use-prop-variables';
+import { colorVariablePropTypeUtil } from '../prop-types/color-variable-prop-type';
+
+const SIZE = 'tiny';
+
+export const ColorVariableControl = () => {
+	const { setValue: setColor } = useBoundProp();
+	const { value: variableValue } = useBoundProp( colorVariablePropTypeUtil );
+
+	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 color variable ${ variableValue } not found` );
+	}
+
+	const unlinkVariable = () => {
+		setColor( colorPropTypeUtil.create( selectedVariable.value ) );
+	};
+
+	return (
+		<Box ref={ anchorRef }>
+			<Tag
+				fullWidth
+				showActionsOnHover
+				startIcon={
+					<Stack spacing={ 0.75 } direction="row" alignItems="center">
+						<ColorIndicator size="inherit" value={ selectedVariable.value } component="span" />
+						<ColorFilterIcon fontSize="inherit" sx={ { mr: 1 } } />
+					</Stack>
+				}
+				label={
+					<Box sx={ { display: 'inline-grid', minWidth: 0 } }>
+						<Typography
+							sx={ { textOverflow: 'ellipsis', overflowX: 'hidden', lineHeight: 1 } }
+							variant="caption"
+						>
+							{ selectedVariable.label }
+						</Typography>
+					</Box>
+				}
+				actions={
+					<IconButton size={ SIZE } onClick={ unlinkVariable } aria-label={ __( 'Unlink', 'elementor' ) }>
+						<DetachIcon fontSize={ SIZE } />
+					</IconButton>
+				}
+				{ ...bindTrigger( popupState ) }
+			/>
+			<Popover
+				disableScrollLock
+				anchorEl={ anchorRef.current }
+				anchorOrigin={ { vertical: 'bottom', horizontal: 'right' } }
+				transformOrigin={ { vertical: 'top', horizontal: 'right' } }
+				{ ...bindPopover( popupState ) }
+			>
+				<VariableSelectionPopover
+					selectedVariable={ selectedVariable }
+					closePopover={ popupState.close }
+					propTypeKey={ colorVariablePropTypeUtil.key }
+				/>
+			</Popover>
+		</Box>
+	);
+};

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

@@ -0,0 +1,88 @@
+import * as React from 'react';
+import { useId, useRef } from 'react';
+import { useBoundProp } from '@elementor/editor-controls';
+import { stringPropTypeUtil } from '@elementor/editor-props';
+import { ColorFilterIcon, DetachIcon } from '@elementor/icons';
+import {
+	bindPopover,
+	bindTrigger,
+	Box,
+	IconButton,
+	Popover,
+	Stack,
+	Typography,
+	UnstableTag as Tag,
+	usePopupState,
+} from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
+
+import { VariableSelectionPopover } from '../components/variable-selection-popover';
+import { useVariable } from '../hooks/use-prop-variables';
+import { fontVariablePropTypeUtil } from '../prop-types/font-variable-prop-type';
+
+const SIZE = 'tiny';
+
+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 }>
+			<Tag
+				fullWidth
+				showActionsOnHover
+				startIcon={
+					<Stack spacing={ 0.75 } direction="row" alignItems="center">
+						<ColorFilterIcon fontSize={ 'inherit' } sx={ { mr: 1 } } />
+					</Stack>
+				}
+				label={
+					<Box sx={ { display: 'inline-grid', minWidth: 0 } }>
+						<Typography
+							sx={ { textOverflow: 'ellipsis', overflowX: 'hidden', lineHeight: 1 } }
+							variant="caption"
+						>
+							{ selectedVariable.label }
+						</Typography>
+					</Box>
+				}
+				actions={
+					<IconButton size={ SIZE } onClick={ unlinkVariable } aria-label={ __( 'Unlink', 'elementor' ) }>
+						<DetachIcon fontSize={ SIZE } />
+					</IconButton>
+				}
+				{ ...bindTrigger( popupState ) }
+			/>
+			<Popover
+				disableScrollLock
+				anchorEl={ anchorRef.current }
+				anchorOrigin={ { vertical: 'bottom', horizontal: 'right' } }
+				transformOrigin={ { vertical: 'top', horizontal: 'right' } }
+				{ ...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;
 	};