@elementor/editor-global-classes 0.11.0 → 0.12.0

package/src/components/class-manager/global-classes-list.tsx

@@ -9,8 +9,8 @@ import {
 	Box,
 	IconButton,
 	List,
-	ListItem,
 	ListItemButton,
+	type ListItemButtonProps,
 	ListItemText,
 	Menu,
 	MenuItem,
@@ -29,9 +29,9 @@ import { useClassesOrder } from '../../hooks/use-classes-order';
 import { useOrderedClasses } from '../../hooks/use-ordered-classes';
 import { DeleteConfirmationProvider, useDeleteConfirmation } from './delete-confirmation-dialog';
 import { FlippedColorSwatchIcon } from './flipped-color-swatch-icon';
-import { SortableItem, SortableItemIndicator, SortableProvider } from './sortable';
+import { SortableItem, SortableProvider, SortableTrigger, type SortableTriggerProps } from './sortable';
 
-export const GlobalClassesList = () => {
+export const GlobalClassesList = ( { disabled }: { disabled?: boolean } ) => {
 	const cssClasses = useOrderedClasses();
 
 	const [ classesOrder, reorderClasses ] = useReorder();
@@ -51,18 +51,15 @@ export const GlobalClassesList = () => {
 
 						return (
 							<SortableItem key={ id } id={ id }>
-								{ ( { isDragged, showDropIndication, dropIndicationStyle, isDragPlaceholder } ) => (
+								{ ( { isDragged, isDragPlaceholder, triggerProps, triggerStyle } ) => (
 									<ClassItem
 										id={ id }
 										label={ label }
 										renameClass={ renameClass }
 										selected={ isDragged }
-										disabled={ isDragPlaceholder }
-									>
-										{ showDropIndication && (
-											<SortableItemIndicator style={ dropIndicationStyle } />
-										) }
-									</ClassItem>
+										disabled={ disabled || isDragPlaceholder }
+										sortableTriggerProps={ { ...triggerProps, style: triggerStyle } }
+									/>
 								) }
 							</SortableItem>
 						);
@@ -83,20 +80,16 @@ const useReorder = () => {
 	return [ order, reorder ] as const;
 };
 
-const ClassItem = ( {
-	id,
-	label,
-	renameClass,
-	selected,
-	children,
-	disabled,
-}: React.PropsWithChildren< {
+type ClassItemProps = React.PropsWithChildren< {
 	id: string;
 	label: string;
 	renameClass: ( newLabel: string ) => void;
-	selected: boolean;
-	disabled: boolean;
-} > ) => {
+	selected?: boolean;
+	disabled?: boolean;
+	sortableTriggerProps: SortableTriggerProps;
+} >;
+
+const ClassItem = ( { id, label, renameClass, selected, disabled, sortableTriggerProps }: ClassItemProps ) => {
 	const {
 		ref: editableRef,
 		openEditMode,
@@ -116,99 +109,103 @@ const ClassItem = ( {
 		disableAutoFocus: true,
 	} );
 
+	const isSelected = ( selected || popupState.isOpen ) && ! disabled;
+
 	return (
-		<Stack direction="row" alignItems="center" gap={ 1 } flexGrow={ 1 } flexShrink={ 0 }>
-			<StyledListItem
-				component={ 'div' }
-				disablePadding
+		<>
+			<StyledListItemButton
+				dense
 				disableGutters
-				secondaryAction={
-					<Tooltip
-						placement="top"
-						className="class-item-more-actions"
-						title={ __( 'More actions', 'elementor' ) }
-					>
-						<IconButton size="tiny" { ...bindTrigger( popupState ) } aria-label="More actions">
-							<DotsVerticalIcon fontSize="tiny" />
-						</IconButton>
-					</Tooltip>
-				}
+				showActions={ isSelected || isEditing }
+				shape="rounded"
+				onDoubleClick={ openEditMode }
+				selected={ isSelected }
+				disabled={ disabled }
+				focusVisibleClassName="visible-class-item"
 			>
-				<ListItemButton
-					dense
-					disableGutters
-					shape="rounded"
-					onDoubleClick={ openEditMode }
-					selected={ selected || popupState.isOpen }
-					disabled={ disabled }
-					focusVisibleClassName="visible-class-item"
-					sx={ {
-						minHeight: '36px',
-						display: 'flex',
-						'&.visible-class-item': {
-							boxShadow: 'none !important',
-						},
-					} }
+				<SortableTrigger { ...sortableTriggerProps } />
+				<Indicator isActive={ isEditing } isError={ !! error }>
+					{ isEditing ? (
+						<EditableField
+							ref={ editableRef }
+							error={ error }
+							as={ Typography }
+							variant="caption"
+							{ ...getEditableProps() }
+						/>
+					) : (
+						<EllipsisWithTooltip title={ label } as={ Typography } variant="caption" />
+					) }
+				</Indicator>
+				<Tooltip
+					placement="top"
+					className={ 'class-item-more-actions' }
+					title={ __( 'More actions', 'elementor' ) }
 				>
-					<Indicator isActive={ isEditing } isError={ !! error }>
-						{ isEditing ? (
-							<EditableField
-								ref={ editableRef }
-								error={ error }
-								as={ Typography }
-								variant="caption"
-								{ ...getEditableProps() }
-							/>
-						) : (
-							<EllipsisWithTooltip title={ label } as={ Typography } variant="caption" />
-						) }
-					</Indicator>
-				</ListItemButton>
-				{ children }
-				<Menu
-					{ ...bindMenu( popupState ) }
-					anchorOrigin={ {
-						vertical: 'bottom',
-						horizontal: 'right',
+					<IconButton size="tiny" { ...bindTrigger( popupState ) } aria-label="More actions">
+						<DotsVerticalIcon fontSize="tiny" />
+					</IconButton>
+				</Tooltip>
+			</StyledListItemButton>
+			<Menu
+				{ ...bindMenu( popupState ) }
+				anchorOrigin={ {
+					vertical: 'bottom',
+					horizontal: 'right',
+				} }
+				transformOrigin={ {
+					vertical: 'top',
+					horizontal: 'right',
+				} }
+			>
+				<MenuItem
+					sx={ { minWidth: '160px' } }
+					onClick={ () => {
+						popupState.close();
+						openEditMode();
 					} }
-					transformOrigin={ {
-						vertical: 'top',
-						horizontal: 'right',
+				>
+					<ListItemText primary={ __( 'Rename', 'elementor' ) } />
+				</MenuItem>
+				<MenuItem
+					onClick={ () => {
+						popupState.close();
+						openDialog( { id, label } );
 					} }
 				>
-					<MenuItem
-						sx={ { minWidth: '160px' } }
-						onClick={ () => {
-							popupState.close();
-							openEditMode();
-						} }
-					>
-						<ListItemText primary={ __( 'Rename', 'elementor' ) } />
-					</MenuItem>
-					<MenuItem
-						onClick={ () => {
-							popupState.close();
-							openDialog( { id, label } );
-						} }
-					>
-						<ListItemText primary={ __( 'Delete', 'elementor' ) } sx={ { color: 'error.light' } } />
-					</MenuItem>
-				</Menu>
-			</StyledListItem>
-		</Stack>
+					<ListItemText primary={ __( 'Delete', 'elementor' ) } sx={ { color: 'error.light' } } />
+				</MenuItem>
+			</Menu>
+		</>
 	);
 };
 
-const StyledListItem = styled( ListItem )`
-	.class-item-more-actions {
-		visibility: hidden;
+// Custom styles for sortable list item, until the component is available in the UI package.
+const StyledListItemButton = styled( ListItemButton, {
+	shouldForwardProp: ( prop: string ) => ! [ 'showActions' ].includes( prop ),
+} )< ListItemButtonProps & { showActions: boolean } >(
+	( { showActions } ) => `
+	min-height: 36px;
+
+	&.visible-class-item {
+		box-shadow: none !important;
 	}
-	&:hover {
-		.class-item-more-actions {
+
+	.class-item-more-actions, .class-item-sortable-trigger {
+		visibility: ${ showActions ? 'visible' : 'hidden' };
+	}
+
+	.class-item-sortable-trigger {
+		visibility: ${ showActions ? 'visible' : 'hidden' };
+	}
+
+	&:hover&:not(:disabled) {
+		.class-item-more-actions, .class-item-sortable-trigger  {
 			visibility: visible;
 		}
 	}
-`;
+`
+);
 
 const EmptyState = () => (
 	<Stack alignItems="center" gap={ 1.5 } pt={ 10 } px={ 0.5 } maxWidth="260px" margin="auto">
@@ -242,6 +239,7 @@ const Indicator = styled( Box, {
 	border: getIndicatorBorder( { isActive, isError, theme } ),
 	padding: `0 ${ theme.spacing( 1 ) }`,
 	marginLeft: isActive ? theme.spacing( 1 ) : 0,
+	minWidth: 0,
 } ) );
 
 const getIndicatorBorder = ( { isActive, isError, theme }: { isActive: boolean; isError: boolean; theme: Theme } ) => {

package/src/components/class-manager/sortable.tsx

@@ -2,7 +2,6 @@ import * as React from 'react';
 import { GripVerticalIcon } from '@elementor/icons';
 import {
 	Box,
-	Paper,
 	styled,
 	UnstableSortableItem,
 	type UnstableSortableItemProps,
@@ -15,22 +14,17 @@ export const SortableProvider = < T extends string >( props: UnstableSortablePro
 	<UnstableSortableProvider restrictAxis variant="static" dragPlaceholderStyle={ { opacity: '1' } } { ...props } />
 );
 
-const SortableTrigger = ( props: React.HTMLAttributes< HTMLDivElement > ) => (
-	<div { ...props } role="button" className="class-item-sortable-trigger">
+export type SortableTriggerProps = React.HTMLAttributes< HTMLDivElement >;
+
+export const SortableTrigger = ( props: SortableTriggerProps ) => (
+	<StyledSortableTrigger { ...props } role="button" className="class-item-sortable-trigger">
 		<GripVerticalIcon fontSize="tiny" />
-	</div>
+	</StyledSortableTrigger>
 );
 
-type ItemRenderProps = Record< string, unknown > & {
-	isDragged: boolean;
-	showDropIndication: boolean;
-	dropIndicationStyle: React.CSSProperties;
-	isDragPlaceholder: boolean;
-};
-
 type SortableItemProps = {
 	id: UnstableSortableItemProps[ 'id' ];
-	children: ( props: ItemRenderProps ) => React.ReactNode;
+	children: ( props: Partial< UnstableSortableItemRenderProps > ) => React.ReactNode;
 };
 
 export const SortableItem = ( { children, id, ...props }: SortableItemProps ) => {
@@ -50,51 +44,41 @@ export const SortableItem = ( { children, id, ...props }: SortableItemProps ) =>
 				isDragPlaceholder,
 			}: UnstableSortableItemRenderProps ) => {
 				return (
-					<StyledSortableItem
+					<Box
 						{ ...itemProps }
-						sx={ itemStyle }
+						style={ itemStyle }
+						component={ 'li' }
 						role="listitem"
-						{ ...( isDragOverlay ? { component: Paper, elevation: 0 } : {} ) }
+						sx={ {
+							backgroundColor: isDragOverlay ? 'background.paper' : undefined,
+						} }
 					>
-						<SortableTrigger { ...triggerProps } style={ triggerStyle } />
 						{ children( {
 							itemProps,
 							isDragged,
 							triggerProps,
 							itemStyle,
 							triggerStyle,
-							dropIndicationStyle,
-							showDropIndication,
 							isDragPlaceholder,
 						} ) }
-					</StyledSortableItem>
+						{ showDropIndication && <SortableItemIndicator style={ dropIndicationStyle } /> }
+					</Box>
 				);
 			} }
 		/>
 	);
 };
 
-const StyledSortableItem = styled( Box )`
-	position: relative;
-
-	&:hover {
-		& .class-item-sortable-trigger {
-			visibility: visible;
-		}
-	}
-
-	& .class-item-sortable-trigger {
-		visibility: hidden;
-		position: absolute;
-		left: 0;
-		top: 50%;
-		transform: translate( -75%, -50% );
-	}
-`;
+const StyledSortableTrigger = styled( 'div' )( ( { theme } ) => ( {
+	position: 'absolute',
+	left: 0,
+	top: '50%',
+	transform: `translate( -${ theme.spacing( 1.5 ) }, -50% )`,
+	color: theme.palette.action.active,
+} ) );
 
-export const SortableItemIndicator = styled( Box )`
+const SortableItemIndicator = styled( Box )`
 	width: 100%;
-	height: 3px;
-	border-radius: ${ ( { theme } ) => theme.spacing( 0.5 ) };
+	height: 1px;
 	background-color: ${ ( { theme } ) => theme.palette.text.primary };
 `;

package/src/save-global-classes.ts

@@ -0,0 +1,27 @@
+import { __dispatch as dispatch, __getState as getState } from '@elementor/store';
+
+import { apiClient, type UpdateContext } from './api';
+import { type GlobalClassesState, slice } from './store';
+
+type Options = {
+	context: UpdateContext;
+};
+
+export async function saveGlobalClasses( { context }: Options ) {
+	const state: GlobalClassesState = getState().globalClasses;
+
+	const data = {
+		items: state.items,
+		order: state.order,
+	};
+
+	if ( context === 'preview' ) {
+		await apiClient.saveDraft( data );
+
+		return;
+	}
+
+	await apiClient.publish( data );
+
+	dispatch( slice.actions.setPristine() );
+}

package/src/sync-with-document-save.ts

@@ -1,7 +1,8 @@
-import { __privateRunCommandSync as runCommandSync, registerDataHook } from '@elementor/editor-v1-adapters';
+import { setDocumentModifiedStatus } from '@elementor/editor-documents';
+import { registerDataHook } from '@elementor/editor-v1-adapters';
 import { __getState as getState, __subscribeWithSelector as subscribeWithSelector } from '@elementor/store';
 
-import { publishGlobalClasses } from './publish-global-classes';
+import { saveGlobalClasses } from './save-global-classes';
 import { selectIsDirty } from './store';
 
 export function syncWithDocumentSave() {
@@ -18,12 +19,16 @@ function syncDirtyState() {
 			return;
 		}
 
-		runCommandSync( 'document/save/set-is-modified', { status: true }, { internal: true } );
+		setDocumentModifiedStatus( true );
 	} );
 }
 
 function bindSaveAction() {
-	registerDataHook( 'after', 'document/save/save', publishGlobalClasses );
+	registerDataHook( 'after', 'document/save/save', ( args ) => {
+		return saveGlobalClasses( {
+			context: args.status === 'publish' ? 'frontend' : 'preview',
+		} );
+	} );
 }
 
 function isDirty() {

package/src/publish-global-classes.ts

@@ -1,23 +0,0 @@
-import { __dispatch as dispatch, __getState as getState } from '@elementor/store';
-
-import { apiClient } from './api';
-import { type GlobalClassesState, selectIsDirty, slice } from './store';
-
-export async function publishGlobalClasses() {
-	if ( ! isDirty() ) {
-		return;
-	}
-
-	const state: GlobalClassesState = getState().globalClasses;
-
-	await apiClient.update( {
-		items: state.items,
-		order: state.order,
-	} );
-
-	dispatch( slice.actions.setPristine() );
-}
-
-function isDirty() {
-	return selectIsDirty( getState() );
-}