Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

withNotices: Ensure that the callback props are stable. #29491

Merged
merged 1 commit into from
Mar 4, 2021
Merged

withNotices: Ensure that the callback props are stable. #29491

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 42 additions & 36 deletions packages/components/src/higher-order/with-notices/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { v4 as uuid } from 'uuid';
/**
* WordPress dependencies
*/
import { forwardRef, useState } from '@wordpress/element';
import { forwardRef, useState, useCallback } from '@wordpress/element';
import { createHigherOrderComponent } from '@wordpress/compose';

/**
Expand All @@ -25,48 +25,54 @@ export default createHigherOrderComponent( ( OriginalComponent ) => {
function Component( props, ref ) {
const [ noticeList, setNoticeList ] = useState( [] );

const noticeOperations = {
/**
* Function passed down as a prop that adds a new notice.
*
* @param {Object} notice Notice to add.
*/
createNotice: ( notice ) => {
const noticeToAdd = notice.id
? notice
: { ...notice, id: uuid() };
setNoticeList( ( current ) => [ ...current, noticeToAdd ] );
},
/**
* Function passed down as a prop that adds a new notice.
*
* @param {Object} notice Notice to add.
*/
const createNotice = useCallback( ( notice ) => {
const noticeToAdd = notice.id ? notice : { ...notice, id: uuid() };
setNoticeList( ( current ) => [ ...current, noticeToAdd ] );
}, [] );

/**
* Function passed as a prop that adds a new error notice.
*
* @param {string} msg Error message of the notice.
*/
createErrorNotice: ( msg ) => {
noticeOperations.createNotice( {
/**
* Function passed as a prop that adds a new error notice.
*
* @param {string} msg Error message of the notice.
*/
const createErrorNotice = useCallback(
( msg ) => {
createNotice( {
status: 'error',
content: msg,
} );
},
[ createNotice ]
stokesman marked this conversation as resolved.
Show resolved Hide resolved
);

/**
* Removes a notice by id.
*
* @param {string} id Id of the notice to remove.
*/
removeNotice: ( id ) => {
setNoticeList( ( current ) =>
current.filter( ( notice ) => notice.id !== id )
);
},
/**
* Removes a notice by id.
*
* @param {string} id Id of the notice to remove.
*/
const removeNotice = useCallback( ( id ) => {
setNoticeList( ( current ) =>
current.filter( ( notice ) => notice.id !== id )
);
}, [] );

/**
* Removes all notices
*/
removeAllNotices: () => {
setNoticeList( [] );
},
/**
* Removes all notices
*/
const removeAllNotices = useCallback( () => {
setNoticeList( [] );
}, [] );

const noticeOperations = {
createNotice,
createErrorNotice,
removeNotice,
removeAllNotices,
};

const propsOut = {
Expand Down