Add noticeType to action args and tests

WordPress · May 25, 2023 · a0e3ee1 · a0e3ee1
1 parent c82111a
commit a0e3ee1
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 3 deletions.
diff --git a/docs/reference-guides/data/data-core-notices.md b/docs/reference-guides/data/data-core-notices.md
@@ -288,13 +288,20 @@ export const ExampleComponent = () => {
 			<Button onClick={ () => removeAllNotices() }>
 				{ __( 'Clear all notices', 'woo-gutenberg-products-block' ) }
 			</Button>
+			<Button onClick={ () => removeAllNotices( 'snackbar' ) }>
+				{ __(
+					'Clear all snackbar notices',
+					'woo-gutenberg-products-block'
+				) }
+			</Button>
 		</>
 	);
 };
 ```
 
 _Parameters_
 
+-   _noticeType_ `string`: The context to remove all notices from.
 -   _context_ `string`: The context to remove all notices from.
 
 _Returns_

diff --git a/packages/notices/src/store/actions.js b/packages/notices/src/store/actions.js
@@ -317,7 +317,8 @@ export function removeNotice( id, context = DEFAULT_CONTEXT ) {
 /**
  * Removes all notices from a given context. Defaults to the default context.
  *
- * @param {string} context The context to remove all notices from.
+ * @param {string} noticeType The context to remove all notices from.
+ * @param {string} context    The context to remove all notices from.
  *
  * @example
  * ```js
@@ -345,16 +346,27 @@ export function removeNotice( id, context = DEFAULT_CONTEXT ) {
  * 			>
  * 				{ __( 'Clear all notices', 'woo-gutenberg-products-block' ) }
  * 			</Button>
+ * 			<Button
+ * 				onClick={ () =>
+ * 					removeAllNotices( 'snackbar' )
+ * 				}
+ * 			>
+ * 				{ __( 'Clear all snackbar notices', 'woo-gutenberg-products-block' ) }
+ * 			</Button>
  * 		</>
  * 	);
  * };
  * ```
  *
  * @return {Object} 	   Action object.
  */
-export function removeAllNotices( context = DEFAULT_CONTEXT ) {
+export function removeAllNotices(
+	noticeType = 'default',
+	context = DEFAULT_CONTEXT
+) {
 	return {
 		type: 'REMOVE_ALL_NOTICES',
+		noticeType,
 		context,
 	};
 }
diff --git a/packages/notices/src/store/test/actions.js b/packages/notices/src/store/test/actions.js
@@ -221,17 +221,27 @@ describe( 'actions', () => {
 		it( 'should return action', () => {
 			expect( removeAllNotices() ).toEqual( {
 				type: 'REMOVE_ALL_NOTICES',
+				noticeType: 'default',
 				context: DEFAULT_CONTEXT,
 			} );
 		} );
 
 		it( 'should return action with custom context', () => {
 			const context = 'foo';
 
-			expect( removeAllNotices( context ) ).toEqual( {
+			expect( removeAllNotices( 'default', context ) ).toEqual( {
 				type: 'REMOVE_ALL_NOTICES',
+				noticeType: 'default',
 				context,
 			} );
 		} );
+
+		it( 'should return action with type', () => {
+			expect( removeAllNotices( 'snackbar' ) ).toEqual( {
+				type: 'REMOVE_ALL_NOTICES',
+				noticeType: 'snackbar',
+				context: DEFAULT_CONTEXT,
+			} );
+		} );
 	} );
 } );