Rename onSelectionChange to onChangeSelection

WordPress · Jul 3, 2024 · 0dcb62e · 0dcb62e
1 parent e39ae77
commit 0dcb62e
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 48 deletions.
diff --git a/packages/dataviews/CHANGELOG.md b/packages/dataviews/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- `onSelectionChange` has been renamed to `onChangeSelection`.
+
 ## 2.2.0 (2024-06-26)
 
 ## 2.1.0 (2024-06-15)

diff --git a/packages/dataviews/README.md b/packages/dataviews/README.md
@@ -278,7 +278,7 @@ Whether the data is loading. `false` by default.
 
 Array of layouts supported. By default, all are: `table`, `grid`, `list`.
 
-### `onSelectionChange`: `function`
+### `onChangeSelection`: `function`
 
 Callback that signals the user selected one of more items, and takes them as parameter. So far, only the `list` view implements it.
 

diff --git a/packages/dataviews/src/bulk-actions-toolbar.tsx b/packages/dataviews/src/bulk-actions-toolbar.tsx
@@ -33,14 +33,14 @@ interface ToolbarContentProps< Item > {
 	selection: string[];
 	actionsToShow: Action< Item >[];
 	selectedItems: Item[];
-	onSelectionChange: SetSelection;
+	onChangeSelection: SetSelection;
 }
 
 interface BulkActionsToolbarProps< Item > {
 	data: Item[];
 	selection: string[];
 	actions: Action< Item >[];
-	onSelectionChange: SetSelection;
+	onChangeSelection: SetSelection;
 	getItemId: ( item: Item ) => string;
 }
 
@@ -132,7 +132,7 @@ function renderToolbarContent< Item >(
 	selectedItems: Item[],
 	actionInProgress: string | null,
 	setActionInProgress: ( actionId: string | null ) => void,
-	onSelectionChange: SetSelection
+	onChangeSelection: SetSelection
 ) {
 	return (
 		<>
@@ -172,7 +172,7 @@ function renderToolbarContent< Item >(
 					label={ __( 'Cancel' ) }
 					disabled={ !! actionInProgress }
 					onClick={ () => {
-						onSelectionChange( EMPTY_ARRAY );
+						onChangeSelection( EMPTY_ARRAY );
 					} }
 				/>
 			</ToolbarGroup>
@@ -184,7 +184,7 @@ function ToolbarContent< Item >( {
 	selection,
 	actionsToShow,
 	selectedItems,
-	onSelectionChange,
+	onChangeSelection,
 }: ToolbarContentProps< Item > ) {
 	const [ actionInProgress, setActionInProgress ] = useState< string | null >(
 		null
@@ -200,7 +200,7 @@ function ToolbarContent< Item >( {
 			selectedItems,
 			actionInProgress,
 			setActionInProgress,
-			onSelectionChange
+			onChangeSelection
 		);
 	} else if ( ! buttons.current ) {
 		buttons.current = renderToolbarContent(
@@ -209,7 +209,7 @@ function ToolbarContent< Item >( {
 			selectedItems,
 			actionInProgress,
 			setActionInProgress,
-			onSelectionChange
+			onChangeSelection
 		);
 	}
 	return buttons.current;
@@ -219,7 +219,7 @@ export default function BulkActionsToolbar< Item >( {
 	data,
 	selection,
 	actions = EMPTY_ARRAY,
-	onSelectionChange,
+	onChangeSelection,
 	getItemId,
 }: BulkActionsToolbarProps< Item > ) {
 	const isReducedMotion = useReducedMotion();
@@ -267,7 +267,7 @@ export default function BulkActionsToolbar< Item >( {
 							selection={ selection }
 							actionsToShow={ actionsToShow }
 							selectedItems={ selectedItems }
-							onSelectionChange={ onSelectionChange }
+							onChangeSelection={ onChangeSelection }
 						/>
 					</div>
 				</Toolbar>

diff --git a/packages/dataviews/src/bulk-actions.tsx b/packages/dataviews/src/bulk-actions.tsx
@@ -47,7 +47,7 @@ interface BulkActionsProps< Item > {
 	data: Item[];
 	actions: Action< Item >[];
 	selection: string[];
-	onSelectionChange: SetSelection;
+	onChangeSelection: SetSelection;
 	getItemId: ( item: Item ) => string;
 }
 
@@ -177,7 +177,7 @@ export default function BulkActions< Item >( {
 	data,
 	actions,
 	selection,
-	onSelectionChange,
+	onChangeSelection,
 	getItemId,
 }: BulkActionsProps< Item > ) {
 	const bulkActions = useMemo(
@@ -249,7 +249,7 @@ export default function BulkActions< Item >( {
 						disabled={ areAllSelected }
 						hideOnClick={ false }
 						onClick={ () => {
-							onSelectionChange(
+							onChangeSelection(
 								selectableItems.map( ( item ) =>
 									getItemId( item )
 								)
@@ -263,7 +263,7 @@ export default function BulkActions< Item >( {
 						disabled={ selection.length === 0 }
 						hideOnClick={ false }
 						onClick={ () => {
-							onSelectionChange( [] );
+							onChangeSelection( [] );
 						} }
 					>
 						{ __( 'Deselect' ) }

diff --git a/packages/dataviews/src/dataviews.tsx b/packages/dataviews/src/dataviews.tsx
@@ -45,14 +45,14 @@ type DataViewsProps< Item > = {
 	supportedLayouts: string[];
 	selection?: string[];
 	setSelection?: SetSelection;
-	onSelectionChange?: ( items: Item[] ) => void;
+	onChangeSelection?: ( items: Item[] ) => void;
 } & ( Item extends ItemWithId
 	? { getItemId?: ( item: Item ) => string }
 	: { getItemId: ( item: Item ) => string } );
 
 const defaultGetItemId = ( item: ItemWithId ) => item.id;
 
-const defaultOnSelectionChange = () => {};
+const defaultOnChangeSelection = () => {};
 
 export default function DataViews< Item >( {
 	view,
@@ -68,7 +68,7 @@ export default function DataViews< Item >( {
 	supportedLayouts,
 	selection: selectionProperty,
 	setSelection: setSelectionProperty,
-	onSelectionChange = defaultOnSelectionChange,
+	onChangeSelection = defaultOnChangeSelection,
 }: DataViewsProps< Item > ) {
 	const [ selectionState, setSelectionState ] = useState< string[] >( [] );
 	const isUncontrolled =
@@ -82,7 +82,7 @@ export default function DataViews< Item >( {
 	function setSelectionWithChange( value: SelectionOrUpdater ) {
 		const newValue =
 			typeof value === 'function' ? value( selection ) : value;
-		onSelectionChange(
+		onChangeSelection(
 			data.filter( ( item ) => newValue.includes( getItemId( item ) ) )
 		);
 		return setSelection( value );
@@ -133,7 +133,7 @@ export default function DataViews< Item >( {
 						<BulkActions
 							actions={ actions }
 							data={ data }
-							onSelectionChange={ setSelectionWithChange }
+							onChangeSelection={ setSelectionWithChange }
 							selection={ _selection }
 							getItemId={ getItemId }
 						/>
@@ -152,7 +152,7 @@ export default function DataViews< Item >( {
 				getItemId={ getItemId }
 				isLoading={ isLoading }
 				onChangeView={ onChangeView }
-				onSelectionChange={ setSelectionWithChange }
+				onChangeSelection={ setSelectionWithChange }
 				selection={ _selection }
 				setOpenedFilter={ setOpenedFilter }
 				view={ view }
@@ -168,7 +168,7 @@ export default function DataViews< Item >( {
 						data={ data }
 						actions={ actions }
 						selection={ _selection }
-						onSelectionChange={ setSelectionWithChange }
+						onChangeSelection={ setSelectionWithChange }
 						getItemId={ getItemId }
 					/>
 				) }

diff --git a/packages/dataviews/src/single-selection-checkbox.tsx b/packages/dataviews/src/single-selection-checkbox.tsx
@@ -12,7 +12,7 @@ import type { SetSelection } from './private-types';
 
 interface SingleSelectionCheckboxProps< Item > {
 	selection: string[];
-	onSelectionChange: SetSelection;
+	onChangeSelection: SetSelection;
 	item: Item;
 	getItemId: ( item: Item ) => string;
 	primaryField?: Field< Item >;
@@ -21,7 +21,7 @@ interface SingleSelectionCheckboxProps< Item > {
 
 export default function SingleSelectionCheckbox< Item >( {
 	selection,
-	onSelectionChange,
+	onChangeSelection,
 	item,
 	getItemId,
 	primaryField,
@@ -54,7 +54,7 @@ export default function SingleSelectionCheckbox< Item >( {
 					return;
 				}
 
-				onSelectionChange(
+				onChangeSelection(
 					selection.includes( id )
 						? selection.filter( ( itemId ) => id !== itemId )
 						: [ ...selection, id ]

diff --git a/packages/dataviews/src/types.ts b/packages/dataviews/src/types.ts
@@ -388,7 +388,7 @@ export interface ViewBaseProps< Item > {
 	getItemId: ( item: Item ) => string;
 	isLoading?: boolean;
 	onChangeView( view: View ): void;
-	onSelectionChange: SetSelection;
+	onChangeSelection: SetSelection;
 	selection: string[];
 	setOpenedFilter: ( fieldId: string ) => void;
 	view: View;

diff --git a/packages/dataviews/src/view-grid.tsx b/packages/dataviews/src/view-grid.tsx
@@ -27,7 +27,7 @@ import type { SetSelection } from './private-types';
 
 interface GridItemProps< Item > {
 	selection: string[];
-	onSelectionChange: SetSelection;
+	onChangeSelection: SetSelection;
 	getItemId: ( item: Item ) => string;
 	item: Item;
 	actions: Action< Item >[];
@@ -40,7 +40,7 @@ interface GridItemProps< Item > {
 
 function GridItem< Item >( {
 	selection,
-	onSelectionChange,
+	onChangeSelection,
 	getItemId,
 	item,
 	actions,
@@ -67,7 +67,7 @@ function GridItem< Item >( {
 					if ( ! hasBulkAction ) {
 						return;
 					}
-					onSelectionChange(
+					onChangeSelection(
 						selection.includes( id )
 							? selection.filter( ( itemId ) => id !== itemId )
 							: [ ...selection, id ]
@@ -85,7 +85,7 @@ function GridItem< Item >( {
 				<SingleSelectionCheckbox
 					item={ item }
 					selection={ selection }
-					onSelectionChange={ onSelectionChange }
+					onChangeSelection={ onChangeSelection }
 					getItemId={ getItemId }
 					primaryField={ primaryField }
 					disabled={ ! hasBulkAction }
@@ -175,7 +175,7 @@ export default function ViewGrid< Item >( {
 	fields,
 	getItemId,
 	isLoading,
-	onSelectionChange,
+	onChangeSelection,
 	selection,
 	view,
 }: ViewGridProps< Item > ) {
@@ -221,7 +221,7 @@ export default function ViewGrid< Item >( {
 							<GridItem
 								key={ getItemId( item ) }
 								selection={ selection }
-								onSelectionChange={ onSelectionChange }
+								onChangeSelection={ onChangeSelection }
 								getItemId={ getItemId }
 								item={ item }
 								actions={ actions }

diff --git a/packages/dataviews/src/view-list.tsx b/packages/dataviews/src/view-list.tsx
@@ -310,7 +310,7 @@ export default function ViewList< Item >( props: ViewListProps< Item > ) {
 		fields,
 		getItemId,
 		isLoading,
-		onSelectionChange,
+		onChangeSelection,
 		selection,
 		view,
 	} = props;
@@ -334,7 +334,7 @@ export default function ViewList< Item >( props: ViewListProps< Item > ) {
 	);
 
 	const onSelect = ( item: Item ) =>
-		onSelectionChange( [ getItemId( item ) ] );
+		onChangeSelection( [ getItemId( item ) ] );
 
 	const getItemDomId = useCallback(
 		( item?: Item ) =>

diff --git a/packages/dataviews/src/view-table.tsx b/packages/dataviews/src/view-table.tsx
@@ -72,7 +72,7 @@ interface HeaderMenuProps< Item > {
 
 interface BulkSelectionCheckboxProps< Item > {
 	selection: string[];
-	onSelectionChange: SetSelection;
+	onChangeSelection: SetSelection;
 	data: Item[];
 	actions: Action< Item >[];
 	getItemId: ( item: Item ) => string;
@@ -87,7 +87,7 @@ interface TableRowProps< Item > {
 	primaryField?: NormalizedField< Item >;
 	selection: string[];
 	getItemId: ( item: Item ) => string;
-	onSelectionChange: SetSelection;
+	onChangeSelection: SetSelection;
 }
 
 function WithDropDownMenuSeparators( { children }: { children: ReactNode } ) {
@@ -246,7 +246,7 @@ const HeaderMenu: < Item >(
 
 function BulkSelectionCheckbox< Item >( {
 	selection,
-	onSelectionChange,
+	onChangeSelection,
 	data,
 	actions,
 	getItemId,
@@ -274,9 +274,9 @@ function BulkSelectionCheckbox< Item >( {
 			indeterminate={ ! areAllSelected && !! selectedItems.length }
 			onChange={ () => {
 				if ( areAllSelected ) {
-					onSelectionChange( [] );
+					onChangeSelection( [] );
 				} else {
-					onSelectionChange(
+					onChangeSelection(
 						selectableItems.map( ( item ) => getItemId( item ) )
 					);
 				}
@@ -297,7 +297,7 @@ function TableRow< Item >( {
 	primaryField,
 	selection,
 	getItemId,
-	onSelectionChange,
+	onChangeSelection,
 }: TableRowProps< Item > ) {
 	const hasPossibleBulkAction = useHasAPossibleBulkAction( actions, item );
 	const isSelected = hasPossibleBulkAction && selection.includes( id );
@@ -337,7 +337,7 @@ function TableRow< Item >( {
 					! isTouchDevice.current &&
 					document.getSelection()?.type !== 'Range'
 				) {
-					onSelectionChange(
+					onChangeSelection(
 						selection.includes( id )
 							? selection.filter( ( itemId ) => id !== itemId )
 							: [ ...selection, id ]
@@ -356,7 +356,7 @@ function TableRow< Item >( {
 						<SingleSelectionCheckbox
 							item={ item }
 							selection={ selection }
-							onSelectionChange={ onSelectionChange }
+							onChangeSelection={ onChangeSelection }
 							getItemId={ getItemId }
 							primaryField={ primaryField }
 							disabled={ ! hasPossibleBulkAction }
@@ -415,7 +415,7 @@ function ViewTable< Item >( {
 	getItemId,
 	isLoading = false,
 	onChangeView,
-	onSelectionChange,
+	onChangeSelection,
 	selection,
 	setOpenedFilter,
 	view,
@@ -485,7 +485,7 @@ function ViewTable< Item >( {
 							>
 								<BulkSelectionCheckbox
 									selection={ selection }
-									onSelectionChange={ onSelectionChange }
+									onChangeSelection={ onChangeSelection }
 									data={ data }
 									actions={ actions }
 									getItemId={ getItemId }
@@ -562,7 +562,7 @@ function ViewTable< Item >( {
 								primaryField={ primaryField }
 								selection={ selection }
 								getItemId={ getItemId }
-								onSelectionChange={ onSelectionChange }
+								onChangeSelection={ onChangeSelection }
 							/>
 						) ) }
 				</tbody>