@wordpress/dataviews 1.0.0 → 1.2.0

package/src/bulk-actions-toolbar.js

@@ -0,0 +1,244 @@
+/**
+ * WordPress dependencies
+ */
+import {
+	ToolbarButton,
+	Toolbar,
+	ToolbarGroup,
+	__unstableMotion as motion,
+	__unstableAnimatePresence as AnimatePresence,
+} from '@wordpress/components';
+import { useMemo, useState, useRef } from '@wordpress/element';
+import { _n, sprintf, __ } from '@wordpress/i18n';
+import { closeSmall } from '@wordpress/icons';
+import { useReducedMotion } from '@wordpress/compose';
+
+/**
+ * Internal dependencies
+ */
+import { ActionWithModal } from './item-actions';
+
+const SNACKBAR_VARIANTS = {
+	init: {
+		bottom: -48,
+	},
+	open: {
+		bottom: 24,
+		transition: {
+			bottom: { type: 'tween', duration: 0.2, ease: [ 0, 0, 0.2, 1 ] },
+		},
+	},
+	exit: {
+		opacity: 0,
+		bottom: 24,
+		transition: {
+			opacity: { type: 'tween', duration: 0.2, ease: [ 0, 0, 0.2, 1 ] },
+		},
+	},
+};
+
+function ActionTrigger( { action, onClick, isBusy } ) {
+	return (
+		<ToolbarButton
+			disabled={ isBusy }
+			label={ action.label }
+			icon={ action.icon }
+			isDestructive={ action.isDestructive }
+			size="compact"
+			onClick={ onClick }
+			isBusy={ isBusy }
+			__experimentalIsFocusable
+			tooltipPosition="top"
+		/>
+	);
+}
+
+const EMPTY_ARRAY = [];
+
+function ActionButton( {
+	action,
+	selectedItems,
+	actionInProgress,
+	setActionInProgress,
+} ) {
+	const selectedEligibleItems = useMemo( () => {
+		return selectedItems.filter( ( item ) => {
+			return action.isEligible( item );
+		} );
+	}, [ action, selectedItems ] );
+	if ( !! action.RenderModal ) {
+		return (
+			<ActionWithModal
+				key={ action.id }
+				action={ action }
+				items={ selectedEligibleItems }
+				ActionTrigger={ ActionTrigger }
+				onActionStart={ () => {
+					setActionInProgress( action.id );
+				} }
+				onActionPerformed={ () => {
+					setActionInProgress( null );
+				} }
+			/>
+		);
+	}
+	return (
+		<ActionTrigger
+			key={ action.id }
+			action={ action }
+			items={ selectedItems }
+			onClick={ () => {
+				setActionInProgress( action.id );
+				action.callback( selectedItems, () => {
+					setActionInProgress( action.id );
+				} );
+			} }
+			isBusy={ actionInProgress === action.id }
+		/>
+	);
+}
+
+function renderToolbarContent(
+	selection,
+	actionsToShow,
+	selectedItems,
+	actionInProgress,
+	setActionInProgress,
+	setSelection
+) {
+	return (
+		<>
+			<ToolbarGroup>
+				<div className="dataviews-bulk-actions__selection-count">
+					{ selection.length === 1
+						? __( '1 item selected' )
+						: sprintf(
+								// translators: %s: Total number of selected items.
+								_n(
+									'%s item selected',
+									'%s items selected',
+									selection.length
+								),
+								selection.length
+						  ) }
+				</div>
+			</ToolbarGroup>
+			<ToolbarGroup>
+				{ actionsToShow.map( ( action ) => {
+					return (
+						<ActionButton
+							key={ action.id }
+							action={ action }
+							selectedItems={ selectedItems }
+							actionInProgress={ actionInProgress }
+							setActionInProgress={ setActionInProgress }
+						/>
+					);
+				} ) }
+			</ToolbarGroup>
+			<ToolbarGroup>
+				<ToolbarButton
+					icon={ closeSmall }
+					showTooltip
+					tooltipPosition="top"
+					label={ __( 'Cancel' ) }
+					disabled={ !! actionInProgress }
+					onClick={ () => {
+						setSelection( EMPTY_ARRAY );
+					} }
+				/>
+			</ToolbarGroup>
+		</>
+	);
+}
+
+function ToolbarContent( {
+	selection,
+	actionsToShow,
+	selectedItems,
+	setSelection,
+} ) {
+	const [ actionInProgress, setActionInProgress ] = useState( null );
+	const buttons = useRef( null );
+	if ( ! actionInProgress ) {
+		if ( buttons.current ) {
+			buttons.current = null;
+		}
+		return renderToolbarContent(
+			selection,
+			actionsToShow,
+			selectedItems,
+			actionInProgress,
+			setActionInProgress,
+			setSelection
+		);
+	} else if ( ! buttons.current ) {
+		buttons.current = renderToolbarContent(
+			selection,
+			actionsToShow,
+			selectedItems,
+			actionInProgress,
+			setActionInProgress,
+			setSelection
+		);
+	}
+	return buttons.current;
+}
+
+export default function BulkActionsToolbar( {
+	data,
+	selection,
+	actions = EMPTY_ARRAY,
+	setSelection,
+	getItemId,
+} ) {
+	const isReducedMotion = useReducedMotion();
+	const selectedItems = useMemo( () => {
+		return data.filter( ( item ) =>
+			selection.includes( getItemId( item ) )
+		);
+	}, [ selection, data, getItemId ] );
+
+	const actionsToShow = useMemo(
+		() =>
+			actions.filter( ( action ) => {
+				return (
+					action.supportsBulk &&
+					action.icon &&
+					selectedItems.some( ( item ) => action.isEligible( item ) )
+				);
+			} ),
+		[ actions, selectedItems ]
+	);
+
+	if (
+		( selection && selection.length === 0 ) ||
+		actionsToShow.length === 0
+	) {
+		return null;
+	}
+
+	return (
+		<AnimatePresence>
+			<motion.div
+				layout={ ! isReducedMotion } // See https://www.framer.com/docs/animation/#layout-animations
+				initial={ 'init' }
+				animate={ 'open' }
+				exit={ 'exit' }
+				variants={ isReducedMotion ? undefined : SNACKBAR_VARIANTS }
+				className="dataviews-bulk-actions"
+			>
+				<Toolbar label={ __( 'Bulk actions' ) }>
+					<div className="dataviews-bulk-actions-toolbar-wrapper">
+						<ToolbarContent
+							selection={ selection }
+							actionsToShow={ actionsToShow }
+							selectedItems={ selectedItems }
+							setSelection={ setSelection }
+						/>
+					</div>
+				</Toolbar>
+			</motion.div>
+		</AnimatePresence>
+	);
+}

package/src/{bulk-actions.js → bulk-actions.tsx}

@@ -13,6 +13,7 @@ import { useMemo, useState, useCallback, useEffect } from '@wordpress/element';
  * Internal dependencies
  */
 import { unlock } from './lock-unlock';
+import type { Action, ActionModal, AnyItem } from './types';
 
 const {
 	DropdownMenuV2: DropdownMenu,
@@ -21,32 +22,73 @@ const {
 	DropdownMenuSeparatorV2: DropdownMenuSeparator,
 } = unlock( componentsPrivateApis );
 
-export function useHasAPossibleBulkAction( actions, item ) {
+interface ActionWithModalProps< Item extends AnyItem > {
+	action: ActionModal< Item >;
+	selectedItems: Item[];
+	setActionWithModal: ( action?: ActionModal< Item > ) => void;
+	onMenuOpenChange: ( isOpen: boolean ) => void;
+}
+
+interface BulkActionsItemProps< Item extends AnyItem > {
+	action: Action< Item >;
+	selectedItems: Item[];
+	setActionWithModal: ( action?: ActionModal< Item > ) => void;
+}
+
+interface ActionsMenuGroupProps< Item extends AnyItem > {
+	actions: Action< Item >[];
+	selectedItems: Item[];
+	setActionWithModal: ( action?: ActionModal< Item > ) => void;
+}
+
+interface BulkActionsProps< Item extends AnyItem > {
+	data: Item[];
+	actions: Action< Item >[];
+	selection: string[];
+	onSelectionChange: ( selection: Item[] ) => void;
+	getItemId: ( item: Item ) => string;
+}
+
+export function useHasAPossibleBulkAction< Item extends AnyItem >(
+	actions: Action< Item >[],
+	item: Item
+) {
 	return useMemo( () => {
 		return actions.some( ( action ) => {
-			return action.supportsBulk && action.isEligible( item );
+			return (
+				action.supportsBulk &&
+				( ! action.isEligible || action.isEligible( item ) )
+			);
 		} );
 	}, [ actions, item ] );
 }
 
-export function useSomeItemHasAPossibleBulkAction( actions, data ) {
+export function useSomeItemHasAPossibleBulkAction< Item extends AnyItem >(
+	actions: Action< Item >[],
+	data: Item[]
+) {
 	return useMemo( () => {
 		return data.some( ( item ) => {
 			return actions.some( ( action ) => {
-				return action.supportsBulk && action.isEligible( item );
+				return (
+					action.supportsBulk &&
+					( ! action.isEligible || action.isEligible( item ) )
+				);
 			} );
 		} );
 	}, [ actions, data ] );
 }
 
-function ActionWithModal( {
+function ActionWithModal< Item extends AnyItem >( {
 	action,
 	selectedItems,
 	setActionWithModal,
 	onMenuOpenChange,
-} ) {
+}: ActionWithModalProps< Item > ) {
 	const eligibleItems = useMemo( () => {
-		return selectedItems.filter( ( item ) => action.isEligible( item ) );
+		return selectedItems.filter(
+			( item ) => ! action.isEligible || action.isEligible( item )
+		);
 	}, [ action, selectedItems ] );
 	const { RenderModal, hideModalHeader } = action;
 	const onCloseModal = useCallback( () => {
@@ -54,7 +96,7 @@ function ActionWithModal( {
 	}, [ setActionWithModal ] );
 	return (
 		<Modal
-			title={ ! hideModalHeader && action.label }
+			title={ ! hideModalHeader ? action.label : undefined }
 			__experimentalHideHeader={ !! hideModalHeader }
 			onRequestClose={ onCloseModal }
 			overlayClassName="dataviews-action-modal"
@@ -62,18 +104,24 @@ function ActionWithModal( {
 			<RenderModal
 				items={ eligibleItems }
 				closeModal={ onCloseModal }
-				onPerform={ () => onMenuOpenChange( false ) }
+				onActionPerformed={ () => onMenuOpenChange( false ) }
 			/>
 		</Modal>
 	);
 }
 
-function BulkActionItem( { action, selectedItems, setActionWithModal } ) {
+function BulkActionItem< Item extends AnyItem >( {
+	action,
+	selectedItems,
+	setActionWithModal,
+}: BulkActionsItemProps< Item > ) {
 	const eligibleItems = useMemo( () => {
-		return selectedItems.filter( ( item ) => action.isEligible( item ) );
+		return selectedItems.filter(
+			( item ) => ! action.isEligible || action.isEligible( item )
+		);
 	}, [ action, selectedItems ] );
 
-	const shouldShowModal = !! action.RenderModal;
+	const shouldShowModal = 'RenderModal' in action;
 
 	return (
 		<DropdownMenuItem
@@ -96,7 +144,11 @@ function BulkActionItem( { action, selectedItems, setActionWithModal } ) {
 	);
 }
 
-function ActionsMenuGroup( { actions, selectedItems, setActionWithModal } ) {
+function ActionsMenuGroup< Item extends AnyItem >( {
+	actions,
+	selectedItems,
+	setActionWithModal,
+}: ActionsMenuGroupProps< Item > ) {
 	return (
 		<>
 			<DropdownMenuGroup>
@@ -114,22 +166,26 @@ function ActionsMenuGroup( { actions, selectedItems, setActionWithModal } ) {
 	);
 }
 
-export default function BulkActions( {
+export default function BulkActions< Item extends AnyItem >( {
 	data,
 	actions,
 	selection,
 	onSelectionChange,
 	getItemId,
-} ) {
+}: BulkActionsProps< Item > ) {
 	const bulkActions = useMemo(
 		() => actions.filter( ( action ) => action.supportsBulk ),
 		[ actions ]
 	);
 	const [ isMenuOpen, onMenuOpenChange ] = useState( false );
-	const [ actionWithModal, setActionWithModal ] = useState();
+	const [ actionWithModal, setActionWithModal ] = useState<
+		ActionModal< Item > | undefined
+	>();
 	const selectableItems = useMemo( () => {
 		return data.filter( ( item ) => {
-			return bulkActions.some( ( action ) => action.isEligible( item ) );
+			return bulkActions.some(
+				( action ) => ! action.isEligible || action.isEligible( item )
+			);
 		} );
 	}, [ data, bulkActions ] );
 

package/src/{constants.js → constants.ts}

@@ -1,20 +1,7 @@
 /**
  * WordPress dependencies
  */
-import { __, isRTL } from '@wordpress/i18n';
-import {
-	blockTable,
-	category,
-	formatListBullets,
-	formatListBulletsRTL,
-} from '@wordpress/icons';
-
-/**
- * Internal dependencies
- */
-import ViewTable from './view-table';
-import ViewGrid from './view-grid';
-import ViewList from './view-list';
+import { __ } from '@wordpress/i18n';
 
 // Filter operators.
 export const OPERATOR_IS = 'is';
@@ -69,24 +56,3 @@ export const SORTING_DIRECTIONS = {
 export const LAYOUT_TABLE = 'table';
 export const LAYOUT_GRID = 'grid';
 export const LAYOUT_LIST = 'list';
-
-export const VIEW_LAYOUTS = [
-	{
-		type: LAYOUT_TABLE,
-		label: __( 'Table' ),
-		component: ViewTable,
-		icon: blockTable,
-	},
-	{
-		type: LAYOUT_GRID,
-		label: __( 'Grid' ),
-		component: ViewGrid,
-		icon: category,
-	},
-	{
-		type: LAYOUT_LIST,
-		label: __( 'List' ),
-		component: ViewList,
-		icon: isRTL() ? formatListBulletsRTL : formatListBullets,
-	},
-];

package/src/dataviews.js

@@ -11,9 +11,11 @@ import Pagination from './pagination';
 import ViewActions from './view-actions';
 import Filters from './filters';
 import Search from './search';
-import { VIEW_LAYOUTS, LAYOUT_TABLE, LAYOUT_GRID } from './constants';
+import { LAYOUT_TABLE, LAYOUT_GRID } from './constants';
+import { VIEW_LAYOUTS } from './layouts';
 import BulkActions from './bulk-actions';
 import { normalizeFields } from './normalize-fields';
+import BulkActionsToolbar from './bulk-actions-toolbar';
 
 const defaultGetItemId = ( item ) => item.id;
 const defaultOnSelectionChange = () => {};
@@ -126,22 +128,32 @@ export default function DataViews( {
 				/>
 			</HStack>
 			<ViewComponent
-				fields={ _fields }
-				view={ view }
-				onChangeView={ onChangeView }
 				actions={ actions }
 				data={ data }
+				fields={ _fields }
 				getItemId={ getItemId }
 				isLoading={ isLoading }
+				onChangeView={ onChangeView }
 				onSelectionChange={ onSetSelection }
 				selection={ selection }
 				setOpenedFilter={ setOpenedFilter }
+				view={ view }
 			/>
 			<Pagination
 				view={ view }
 				onChangeView={ onChangeView }
 				paginationInfo={ paginationInfo }
 			/>
+			{ [ LAYOUT_TABLE, LAYOUT_GRID ].includes( view.type ) &&
+				hasPossibleBulkAction && (
+					<BulkActionsToolbar
+						data={ data }
+						actions={ actions }
+						selection={ selection }
+						setSelection={ setSelection }
+						getItemId={ getItemId }
+					/>
+				) }
 		</div>
 	);
 }

package/src/filter-and-sort-data-view.ts

@@ -0,0 +1,169 @@
+/**
+ * External dependencies
+ */
+import removeAccents from 'remove-accents';
+
+/**
+ * Internal dependencies
+ */
+import {
+	OPERATOR_IS,
+	OPERATOR_IS_NOT,
+	OPERATOR_IS_NONE,
+	OPERATOR_IS_ANY,
+	OPERATOR_IS_ALL,
+	OPERATOR_IS_NOT_ALL,
+} from './constants';
+import { normalizeFields } from './normalize-fields';
+import type { Field, AnyItem, View } from './types';
+
+function normalizeSearchInput( input = '' ) {
+	return removeAccents( input.trim().toLowerCase() );
+}
+
+const EMPTY_ARRAY: [] = [];
+
+/**
+ * Applies the filtering, sorting and pagination to the raw data based on the view configuration.
+ *
+ * @param data   Raw data.
+ * @param view   View config.
+ * @param fields Fields config.
+ *
+ * @return Filtered, sorted and paginated data.
+ */
+export function filterSortAndPaginate< Item extends AnyItem >(
+	data: Item[],
+	view: View,
+	fields: Field< Item >[]
+): {
+	data: Item[];
+	paginationInfo: { totalItems: number; totalPages: number };
+} {
+	if ( ! data ) {
+		return {
+			data: EMPTY_ARRAY,
+			paginationInfo: { totalItems: 0, totalPages: 0 },
+		};
+	}
+	const _fields = normalizeFields( fields );
+	let filteredData = [ ...data ];
+	// Handle global search.
+	if ( view.search ) {
+		const normalizedSearch = normalizeSearchInput( view.search );
+		filteredData = filteredData.filter( ( item ) => {
+			return _fields
+				.filter( ( field ) => field.enableGlobalSearch )
+				.map( ( field ) => {
+					return normalizeSearchInput( field.getValue( { item } ) );
+				} )
+				.some( ( field ) => field.includes( normalizedSearch ) );
+		} );
+	}
+
+	if ( view.filters.length > 0 ) {
+		view.filters.forEach( ( filter ) => {
+			const field = _fields.find(
+				( _field ) => _field.id === filter.field
+			);
+			if ( field ) {
+				if (
+					filter.operator === OPERATOR_IS_ANY &&
+					filter?.value?.length > 0
+				) {
+					filteredData = filteredData.filter( ( item ) => {
+						const fieldValue = field.getValue( { item } );
+						if ( Array.isArray( fieldValue ) ) {
+							return filter.value.some( ( filterValue: any ) =>
+								fieldValue.includes( filterValue )
+							);
+						} else if ( typeof fieldValue === 'string' ) {
+							return filter.value.includes( fieldValue );
+						}
+						return false;
+					} );
+				} else if (
+					filter.operator === OPERATOR_IS_NONE &&
+					filter?.value?.length > 0
+				) {
+					filteredData = filteredData.filter( ( item ) => {
+						const fieldValue = field.getValue( { item } );
+						if ( Array.isArray( fieldValue ) ) {
+							return ! filter.value.some( ( filterValue: any ) =>
+								fieldValue.includes( filterValue )
+							);
+						} else if ( typeof fieldValue === 'string' ) {
+							return ! filter.value.includes( fieldValue );
+						}
+						return false;
+					} );
+				} else if (
+					filter.operator === OPERATOR_IS_ALL &&
+					filter?.value?.length > 0
+				) {
+					filteredData = filteredData.filter( ( item ) => {
+						return filter.value.every( ( value: any ) => {
+							return field
+								.getValue( { item } )
+								?.includes( value );
+						} );
+					} );
+				} else if (
+					filter.operator === OPERATOR_IS_NOT_ALL &&
+					filter?.value?.length > 0
+				) {
+					filteredData = filteredData.filter( ( item ) => {
+						return filter.value.every( ( value: any ) => {
+							return ! field
+								.getValue( { item } )
+								?.includes( value );
+						} );
+					} );
+				} else if ( filter.operator === OPERATOR_IS ) {
+					filteredData = filteredData.filter( ( item ) => {
+						return filter.value === field.getValue( { item } );
+					} );
+				} else if ( filter.operator === OPERATOR_IS_NOT ) {
+					filteredData = filteredData.filter( ( item ) => {
+						return filter.value !== field.getValue( { item } );
+					} );
+				}
+			}
+		} );
+	}
+
+	// Handle sorting.
+	if ( view.sort ) {
+		const fieldId = view.sort.field;
+		const fieldToSort = _fields.find( ( field ) => {
+			return field.id === fieldId;
+		} );
+		if ( fieldToSort ) {
+			filteredData.sort( ( a, b ) => {
+				const valueA = fieldToSort.getValue( { item: a } ) ?? '';
+				const valueB = fieldToSort.getValue( { item: b } ) ?? '';
+				return view.sort?.direction === 'asc'
+					? valueA.localeCompare( valueB )
+					: valueB.localeCompare( valueA );
+			} );
+		}
+	}
+
+	// Handle pagination.
+	let totalItems = filteredData.length;
+	let totalPages = 1;
+	if ( view.page !== undefined && view.perPage !== undefined ) {
+		const start = ( view.page - 1 ) * view.perPage;
+		totalItems = filteredData?.length || 0;
+		totalPages = Math.ceil( totalItems / view.perPage );
+		filteredData = filteredData?.slice( start, start + view.perPage );
+	}
+
+	return {
+		data: filteredData,
+		paginationInfo: {
+			totalItems,
+			totalPages,
+		},
+	};
+}

package/src/filter-summary.js

@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-import classnames from 'classnames';
+import clsx from 'clsx';
 
 /**
  * WordPress dependencies
@@ -220,7 +220,7 @@ export default function FilterSummary( {
 						placement="top"
 					>
 						<div
-							className={ classnames(
+							className={ clsx(
 								'dataviews-filter-summary__chip',
 								{
 									'has-reset': canResetOrRemove,
@@ -253,7 +253,7 @@ export default function FilterSummary( {
 							placement="top"
 						>
 							<button
-								className={ classnames(
+								className={ clsx(
 									'dataviews-filter-summary__chip-remove',
 									{ 'has-values': hasValues }
 								) }

package/src/index.js

@@ -1,3 +1,3 @@
 export { default as DataViews } from './dataviews';
-export { VIEW_LAYOUTS } from './constants';
+export { VIEW_LAYOUTS } from './layouts';
 export { filterSortAndPaginate } from './filter-and-sort-data-view';