@elementor/editor-variables 0.13.0 → 0.14.0

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

@@ -1,71 +1,117 @@
 import * as React from 'react';
-import { Fragment } from 'react';
+import { useState } from 'react';
 import { useBoundProp } from '@elementor/editor-controls';
-import { EditIcon } 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 } 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 { colorVariablePropTypeUtil } from '../prop-types/color-variable-prop-type';
-import { type VariableKey } from '../types';
-import { ColorIndicator } from './color-indicator';
-import { StyledMenuItem } from './styled-menu-item';
+import { type ExtendedVirtualizedItem } from '../types';
+import { ColorIndicator } from './ui/color-indicator';
+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 ColorVariablesSelection = ( { onSelect }: Props ) => {
+export const ColorVariablesSelection = ( { closePopover, onAdd, onEdit, onSettings }: Props ) => {
 	const { value: variable, setValue: setVariable } = useBoundProp( colorVariablePropTypeUtil );
+	const [ searchValue, setSearchValue ] = useState( '' );
 
-	const variables = usePropVariables( colorVariablePropTypeUtil.key );
+	const {
+		list: variables,
+		hasMatches: hasSearchResults,
+		isSourceNotEmpty: hasVariables,
+	} = useFilteredVariables( searchValue, colorVariablePropTypeUtil.key );
 
-	const handleSetColorVariable = ( key: VariableKey ) => {
+	const handleSetColorVariable = ( 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: <ColorIndicator size="inherit" component="span" value={ value } />,
+		secondaryText: value,
+		onEdit: () => onEdit?.( key ),
+	} ) );
+
+	const handleSearch = ( search: string ) => {
+		setSearchValue( search );
+	};
+
+	const handleClearSearch = () => {
+		setSearchValue( '' );
 	};
 
 	return (
-		<Fragment>
+		<>
+			<PopoverHeader
+				title={ __( 'Variables', 'elementor' ) }
+				icon={ <ColorFilterIcon fontSize={ SIZE } /> }
+				onClose={ closePopover }
+				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={ () => handleSetColorVariable( key ) }
-							selected={ key === variable }
-						>
-							<ListItemIcon>
-								<ColorIndicator size="inherit" component="span" value={ value } />
-							</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< 'item', string >
+					items={ items }
+					onSelect={ handleSetColorVariable }
+					onClose={ () => {} }
+					selectedValue={ variable }
+					data-testid="color-variables-list"
+					menuListTemplate={ VariablesStyledMenuList }
+					menuItemContentTemplate={ ( item: VirtualizedItem< 'item', string > ) => (
+						<MenuItemContent item={ item } />
+					) }
+				/>
+			) }
+
+			{ ! hasSearchResults && hasVariables && (
+				<NoSearchResults searchValue={ searchValue } onClear={ handleClearSearch } />
+			) }
+
+			{ ! hasVariables && <NoVariables icon={ <ColorFilterIcon fontSize="large" /> } onAdd={ onAdd } /> }
+		</>
 	);
 };

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

@@ -3,7 +3,7 @@ import { useRef, useState } from 'react';
 import { FontFamilySelector, useBoundProp } from '@elementor/editor-controls';
 import { useFontFamilies } from '@elementor/editor-editing-panel';
 import { PopoverHeader } from '@elementor/editor-ui';
-import { ChevronDownIcon, TextIcon } from '@elementor/icons';
+import { ArrowLeftIcon, ChevronDownIcon, TextIcon } from '@elementor/icons';
 import {
 	bindPopover,
 	bindTrigger,
@@ -12,6 +12,7 @@ import {
 	Divider,
 	FormLabel,
 	Grid,
+	IconButton,
 	Popover,
 	Stack,
 	TextField,
@@ -25,7 +26,12 @@ import { fontVariablePropTypeUtil } from '../prop-types/font-variable-prop-type'
 
 const SIZE = 'tiny';
 
-export const FontVariableCreation = ( { onClose }: { onClose: () => void } ) => {
+type Props = {
+	onGoBack?: () => void;
+	onClose: () => void;
+};
+
+export const FontVariableCreation = ( { onClose, onGoBack }: Props ) => {
 	const fontFamilies = useFontFamilies();
 	const { setValue: setVariable } = useBoundProp( fontVariablePropTypeUtil );
 
@@ -63,9 +69,18 @@ export const FontVariableCreation = ( { onClose }: { onClose: () => void } ) =>
 	return (
 		<>
 			<PopoverHeader
+				icon={
+					<>
+						{ onGoBack && (
+							<IconButton size={ SIZE } aria-label={ __( 'Go Back', 'elementor' ) } onClick={ onGoBack }>
+								<ArrowLeftIcon fontSize={ SIZE } />
+							</IconButton>
+						) }
+						<TextIcon fontSize={ SIZE } />
+					</>
+				}
 				title={ __( 'Create variable', 'elementor' ) }
 				onClose={ closePopover }
-				icon={ <TextIcon fontSize={ SIZE } /> }
 			/>
 
 			<Divider />
@@ -119,9 +134,6 @@ export const FontVariableCreation = ( { onClose }: { onClose: () => void } ) =>
 			</Stack>
 
 			<CardActions>
-				<Button size="small" onClick={ closePopover } color="secondary" variant="text">
-					{ __( 'Cancel', 'elementor' ) }
-				</Button>
 				<Button size="small" variant="contained" disabled={ isFormInvalid() } onClick={ handleCreate }>
 					{ __( 'Create', 'elementor' ) }
 				</Button>

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

@@ -0,0 +1,146 @@
+import * as React from 'react';
+import { useId, useRef, useState } from 'react';
+import { FontFamilySelector } from '@elementor/editor-controls';
+import { useFontFamilies } 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,
+	Stack,
+	TextField,
+	UnstableTag,
+	usePopupState,
+} from '@elementor/ui';
+import { __ } from '@wordpress/i18n';
+
+import { updateVariable, useVariable } from '../hooks/use-prop-variables';
+
+const SIZE = 'tiny';
+
+type Props = {
+	editId: string;
+	onClose: () => void;
+	onGoBack?: () => void;
+	onSubmit?: () => void;
+};
+
+export const FontVariableEdit = ( { onClose, onGoBack, onSubmit, editId }: Props ) => {
+	const variable = useVariable( editId );
+
+	if ( ! variable ) {
+		throw new Error( `Global font variable "${ editId }" not found` );
+	}
+
+	const [ fontFamily, setFontFamily ] = useState( variable.value );
+	const [ label, setLabel ] = useState( variable.label );
+
+	const variableNameId = useId();
+	const variableValueId = useId();
+
+	const anchorRef = useRef< HTMLDivElement >( null );
+	const fontPopoverState = usePopupState( { variant: 'popover' } );
+
+	const fontFamilies = useFontFamilies();
+
+	const handleUpdate = () => {
+		updateVariable( editId, {
+			value: fontFamily,
+			label,
+		} ).then( () => {
+			onSubmit?.();
+		} );
+	};
+
+	const noValueChanged = () => fontFamily === variable.value && label === variable.label;
+	const hasEmptyValue = () => '' === fontFamily.trim() || '' === label.trim();
+	const isSaveDisabled = () => noValueChanged() || hasEmptyValue();
+
+	return (
+		<>
+			<PopoverHeader
+				icon={
+					<>
+						{ onGoBack && (
+							<IconButton size={ SIZE } aria-label={ __( 'Go Back', 'elementor' ) } onClick={ onGoBack }>
+								<ArrowLeftIcon fontSize={ SIZE } />
+							</IconButton>
+						) }
+						<TextIcon fontSize={ SIZE } />
+					</>
+				}
+				title={ __( 'Edit variable', 'elementor' ) }
+				onClose={ onClose }
+			/>
+
+			<Divider />
+
+			<Stack p={ 1.5 } gap={ 1.5 }>
+				<Grid container gap={ 0.75 } alignItems="center">
+					<Grid item xs={ 12 }>
+						<FormLabel htmlFor={ variableNameId } size="small">
+							{ __( 'Name', 'elementor' ) }
+						</FormLabel>
+					</Grid>
+					<Grid item xs={ 12 }>
+						<TextField
+							id={ variableNameId }
+							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 htmlFor={ variableValueId } size="small">
+							{ __( 'Value', 'elementor' ) }
+						</FormLabel>
+					</Grid>
+					<Grid item xs={ 12 }>
+						<>
+							<UnstableTag
+								id={ variableValueId }
+								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 }
+								/>
+							</Popover>
+						</>
+					</Grid>
+				</Grid>
+			</Stack>
+
+			<CardActions>
+				<Button size="small" variant="contained" disabled={ isSaveDisabled() } onClick={ handleUpdate }>
+					{ __( 'Save', 'elementor' ) }
+				</Button>
+			</CardActions>
+		</>
+	);
+};

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>
+);