@elementor/editor-controls 0.12.0 → 0.13.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.12.0",
+  "version": "0.13.0",
   "private": false,
   "author": "Elementor Team",
   "homepage": "https://elementor.com/",

package/src/components/repeater.tsx

@@ -16,7 +16,9 @@ import {
 } from '@elementor/ui';
 import { __ } from '@wordpress/i18n';
 
+import { useSyncExternalState } from '../hooks/use-sync-external-state';
 import { SectionContent } from './section-content';
+import { SortableItem, SortableProvider } from './sortable';
 
 const SIZE = 'tiny';
 
@@ -50,32 +52,61 @@ export const Repeater = < T, >( {
 	values: repeaterValues = [],
 	setValues: setRepeaterValues,
 }: RepeaterProps< Item< T > > ) => {
+	const [ items, setItems ] = useSyncExternalState( {
+		external: repeaterValues,
+		// @ts-expect-error - as long as persistWhen => true, value will never be null
+		setExternal: setRepeaterValues,
+		persistWhen: () => true,
+	} );
+
+	const [ uniqueKeys, setUniqueKeys ] = useState( items.map( ( _, index ) => index ) );
+
+	const generateNextKey = ( source: number[] ) => {
+		return 1 + Math.max( 0, ...source );
+	};
+
 	const addRepeaterItem = () => {
 		const newItem = structuredClone( itemSettings.initialValues );
+		const newKey = generateNextKey( uniqueKeys );
 
 		if ( addToBottom ) {
-			return setRepeaterValues( [ ...repeaterValues, newItem ] );
+			setItems( [ ...items, newItem ] );
+			setUniqueKeys( [ ...uniqueKeys, newKey ] );
+		} else {
+			setItems( [ newItem, ...items ] );
+			setUniqueKeys( [ newKey, ...uniqueKeys ] );
 		}
-
-		setRepeaterValues( [ newItem, ...repeaterValues ] );
 	};
 
 	const duplicateRepeaterItem = ( index: number ) => {
-		setRepeaterValues( [
-			...repeaterValues.slice( 0, index ),
-			structuredClone( repeaterValues[ index ] ),
-			...repeaterValues.slice( index ),
-		] );
+		const newItem = structuredClone( items[ index ] );
+		const newKey = generateNextKey( uniqueKeys );
+
+		// Insert the new (cloned item) at the next spot (after the current index)
+		const atPosition = 1 + index;
+
+		setItems( [ ...items.slice( 0, atPosition ), newItem, ...items.slice( atPosition ) ] );
+		setUniqueKeys( [ ...uniqueKeys.slice( 0, atPosition ), newKey, ...uniqueKeys.slice( atPosition ) ] );
 	};
 
 	const removeRepeaterItem = ( index: number ) => {
-		setRepeaterValues( repeaterValues.filter( ( _, i ) => i !== index ) );
+		setUniqueKeys(
+			uniqueKeys.filter( ( _, pos ) => {
+				return pos !== index;
+			} )
+		);
+
+		setItems(
+			items.filter( ( _, pos ) => {
+				return pos !== index;
+			} )
+		);
 	};
 
 	const toggleDisableRepeaterItem = ( index: number ) => {
-		setRepeaterValues(
-			repeaterValues.map( ( value, i ) => {
-				if ( i === index ) {
+		setItems(
+			items.map( ( value, pos ) => {
+				if ( pos === index ) {
 					const { disabled, ...rest } = value;
 
 					// If the items should not be disabled, remove the disabled property.
@@ -87,6 +118,16 @@ export const Repeater = < T, >( {
 		);
 	};
 
+	const onChangeOrder = ( reorderedKeys: number[] ) => {
+		setUniqueKeys( reorderedKeys );
+		setItems( ( prevItems ) => {
+			return reorderedKeys.map( ( keyValue ) => {
+				const index = uniqueKeys.indexOf( keyValue );
+				return prevItems[ index ];
+			} );
+		} );
+	};
+
 	return (
 		<SectionContent>
 			<Stack direction="row" justifyContent="space-between" alignItems="center">
@@ -97,22 +138,35 @@ export const Repeater = < T, >( {
 					<PlusIcon fontSize={ SIZE } />
 				</IconButton>
 			</Stack>
-			<Stack gap={ 1 } sx={ { '&:empty': { display: 'none' } } }>
-				{ repeaterValues.map( ( value, index ) => (
-					<RepeaterItem
-						key={ index }
-						bind={ String( index ) }
-						disabled={ value.disabled }
-						label={ <itemSettings.Label value={ value } /> }
-						startIcon={ <itemSettings.Icon value={ value } /> }
-						removeItem={ () => removeRepeaterItem( index ) }
-						duplicateItem={ () => duplicateRepeaterItem( index ) }
-						toggleDisableItem={ () => toggleDisableRepeaterItem( index ) }
-					>
-						{ ( props ) => <itemSettings.Content { ...props } value={ value } bind={ String( index ) } /> }
-					</RepeaterItem>
-				) ) }
-			</Stack>
+			{ 0 < uniqueKeys.length && (
+				<SortableProvider value={ uniqueKeys } onChange={ onChangeOrder }>
+					{ uniqueKeys.map( ( key, index ) => {
+						const value = items[ index ];
+
+						if ( ! value ) {
+							return null;
+						}
+
+						return (
+							<SortableItem id={ key } key={ `sortable-${ key }` }>
+								<RepeaterItem
+									bind={ String( index ) }
+									disabled={ value?.disabled }
+									label={ <itemSettings.Label value={ value } /> }
+									startIcon={ <itemSettings.Icon value={ value } /> }
+									removeItem={ () => removeRepeaterItem( index ) }
+									duplicateItem={ () => duplicateRepeaterItem( index ) }
+									toggleDisableItem={ () => toggleDisableRepeaterItem( index ) }
+								>
+									{ ( props ) => (
+										<itemSettings.Content { ...props } value={ value } bind={ String( index ) } />
+									) }
+								</RepeaterItem>
+							</SortableItem>
+						);
+					} ) }
+				</SortableProvider>
+			) }
 		</SectionContent>
 	);
 };
@@ -151,6 +205,7 @@ const RepeaterItem = ( {
 			<UnstableTag
 				label={ label }
 				showActionsOnHover
+				fullWidth
 				ref={ controlRef }
 				variant="outlined"
 				aria-label={ __( 'Open item', 'elementor' ) }

package/src/components/sortable.tsx

@@ -0,0 +1,108 @@
+import * as React from 'react';
+import { GripVerticalIcon } from '@elementor/icons';
+import {
+	Divider,
+	List,
+	ListItem,
+	styled,
+	UnstableSortableItem,
+	type UnstableSortableItemProps,
+	type UnstableSortableItemRenderProps,
+	UnstableSortableProvider,
+	type UnstableSortableProviderProps,
+} from '@elementor/ui';
+
+export const SortableProvider = < T extends number >( props: UnstableSortableProviderProps< T > ) => {
+	return (
+		<List sx={ { p: 0, m: 0 } }>
+			<UnstableSortableProvider
+				restrictAxis={ true }
+				disableDragOverlay={ false }
+				variant={ 'static' }
+				{ ...props }
+			/>
+		</List>
+	);
+};
+
+type SortableItemProps = {
+	id: UnstableSortableItemProps[ 'id' ];
+	children: React.ReactNode;
+};
+
+export const SortableItem = ( { id, children }: SortableItemProps ): React.ReactNode => {
+	return (
+		<UnstableSortableItem
+			id={ id }
+			render={ ( {
+				itemProps,
+				triggerProps,
+				itemStyle,
+				triggerStyle,
+				isDragOverlay,
+				showDropIndication,
+				dropIndicationStyle,
+			}: UnstableSortableItemRenderProps ) => {
+				return (
+					<StyledListItem
+						{ ...itemProps }
+						style={ itemStyle }
+						sx={ { backgroundColor: isDragOverlay ? 'background.paper' : undefined } }
+					>
+						<SortableTrigger { ...triggerProps } style={ triggerStyle } />
+						{ children }
+						{ showDropIndication && <StyledDivider style={ dropIndicationStyle } /> }
+					</StyledListItem>
+				);
+			} }
+		/>
+	);
+};
+
+const StyledListItem = styled( ListItem )`
+	position: relative;
+	margin-inline: 0px;
+	padding-inline: 0px;
+	padding-block: ${ ( { theme } ) => theme.spacing( 0.5 ) };
+
+	& .class-item-sortable-trigger {
+		color: ${ ( { theme } ) => theme.palette.action.active };
+		height: 100%;
+		display: flex;
+		align-items: center;
+		visibility: hidden;
+		position: absolute;
+		top: 50%;
+		padding-inline-end: ${ ( { theme } ) => theme.spacing( 0.5 ) };
+		transform: translate( -75%, -50% );
+	}
+
+	&:hover {
+		& .class-item-sortable-trigger {
+			visibility: visible;
+		}
+	}
+`;
+
+const SortableTrigger = ( props: React.HTMLAttributes< HTMLDivElement > ) => (
+	<div { ...props } role="button" className="class-item-sortable-trigger">
+		<GripVerticalIcon fontSize="tiny" />
+	</div>
+);
+
+const StyledDivider = styled( Divider )`
+	height: 0px;
+	border: none;
+	overflow: visible;
+
+	&:after {
+		--height: 2px;
+		content: '';
+		display: block;
+		width: 100%;
+		height: var( --height );
+		margin-block: calc( -1 * var( --height ) / 2 );
+		border-radius: ${ ( { theme } ) => theme.spacing( 0.5 ) };
+		background-color: ${ ( { theme } ) => theme.palette.text.primary };
+	}
+`;

package/src/controls/text-area-control.tsx

@@ -23,7 +23,7 @@ export const TextAreaControl = createControl( ( { placeholder }: Props ) => {
 				size="tiny"
 				multiline
 				fullWidth
-				rows={ 5 }
+				minRows={ 5 }
 				value={ value ?? '' }
 				onChange={ handleChange }
 				placeholder={ placeholder }