Polish editor PostFormat and PostFormatPanel components.

WordPress · Feb 23, 2021 · 1024849 · 1024849
1 parent ec1b9da
commit 1024849
Show file tree

Hide file tree

Showing 2 changed files with 83 additions and 78 deletions.
diff --git a/packages/editor/src/components/post-format/index.js b/packages/editor/src/components/post-format/index.js
@@ -1,19 +1,20 @@
 /**
  * External dependencies
  */
-import { find, get, includes, union } from 'lodash';
+import { union } from 'lodash';
 
 /**
  * WordPress dependencies
  */
-import { __ } from '@wordpress/i18n';
 import { Button, SelectControl } from '@wordpress/components';
-import { useDispatch, useSelect } from '@wordpress/data';
 import { useInstanceId } from '@wordpress/compose';
+import { store as coreStore, useDispatch, useSelect } from '@wordpress/data';
+import { __ } from '@wordpress/i18n';
 
 /**
  * Internal dependencies
  */
+import { store as editorStore } from '../../';
 import PostFormatCheck from './check';
 
 // All WP post formats, sorted alphabetically by translated name.
@@ -45,38 +46,51 @@ export default function PostFormat() {
 	const instanceId = useInstanceId( PostFormat );
 	const postFormatSelectorId = `post-format-selector-${ instanceId }`;
 
-	const { postFormat, suggestedFormat, supportedFormats } = useSelect(
+	const { currentFormatId, listedFormats, suggestedFormat } = useSelect(
 		( select ) => {
+			const supportedFormatIds =
+				select( coreStore ).getThemeSupports().formats ?? [];
 			const { getEditedPostAttribute, getSuggestedPostFormat } = select(
-				'core/editor'
+				editorStore
+			);
+			const _currentFormatId =
+				getEditedPostAttribute( 'format' ) ?? 'standard';
+
+			const potentialSuggestedFormatId = getSuggestedPostFormat();
+
+			// If the suggested format isn't null, isn't already applied, and is
+			// supported by the theme, return it. Otherwise, return null.
+			const suggestionIsValid =
+				potentialSuggestedFormatId &&
+				potentialSuggestedFormatId !== _currentFormatId &&
+				supportedFormatIds.includes( potentialSuggestedFormatId );
+
+			// The current format may not be supported by the theme.
+			// Ensure it is always shown in the select control.
+			const currentOrSupportedFormatIds = union(
+				[ _currentFormatId ],
+				supportedFormatIds
 			);
-			const _postFormat = getEditedPostAttribute( 'format' );
-			const themeSupports = select( 'core' ).getThemeSupports();
+
 			return {
-				postFormat: _postFormat ?? 'standard',
-				suggestedFormat: getSuggestedPostFormat(),
-				// Ensure current format is always in the set.
-				// The current format may not be a format supported by the theme.
-				supportedFormats: union(
-					[ _postFormat ],
-					get( themeSupports, [ 'formats' ], [] )
+				currentFormatId: _currentFormatId,
+				// Filter out invalid formats not included in POST_FORMATS.
+				listedFormats: POST_FORMATS.filter( ( { id } ) =>
+					currentOrSupportedFormatIds.includes( id )
 				),
+				suggestedFormat: suggestionIsValid
+					? POST_FORMATS.find(
+							( { id } ) => id === potentialSuggestedFormatId
+					  )
+					: null,
 			};
 		},
 		[]
 	);
 
-	const formats = POST_FORMATS.filter( ( format ) =>
-		includes( supportedFormats, format.id )
-	);
-	const suggestion = find(
-		formats,
-		( format ) => format.id === suggestedFormat
-	);
-
-	const { editPost } = useDispatch( 'core/editor' );
+	const { editPost } = useDispatch( editorStore );
 
-	const onUpdatePostFormat = ( format ) => editPost( { format } );
+	const updatePostFormat = ( formatId ) => editPost( { format: formatId } );
 
 	return (
 		<PostFormatCheck>
@@ -86,26 +100,26 @@ export default function PostFormat() {
 						{ __( 'Post Format' ) }
 					</label>
 					<SelectControl
-						value={ postFormat }
-						onChange={ ( format ) => onUpdatePostFormat( format ) }
+						value={ currentFormatId }
+						onChange={ updatePostFormat }
 						id={ postFormatSelectorId }
-						options={ formats.map( ( format ) => ( {
+						options={ listedFormats.map( ( format ) => ( {
 							label: format.caption,
 							value: format.id,
 						} ) ) }
 					/>
 				</div>
 
-				{ suggestion && suggestion.id !== postFormat && (
+				{ suggestedFormat && (
 					<div className="editor-post-format__suggestion">
 						{ __( 'Suggestion:' ) }{ ' ' }
 						<Button
 							isLink
 							onClick={ () =>
-								onUpdatePostFormat( suggestion.id )
+								updatePostFormat( suggestedFormat.id )
 							}
 						>
-							{ suggestion.caption }
+							{ suggestedFormat.caption }
 						</Button>
 					</div>
 				) }

diff --git a/packages/editor/src/components/post-publish-panel/maybe-post-format-panel.js b/packages/editor/src/components/post-publish-panel/maybe-post-format-panel.js
@@ -1,86 +1,77 @@
-/**
- * External dependencies
- */
-import { find, get, includes } from 'lodash';
-
 /**
  * WordPress dependencies
  */
 import { Button, PanelBody } from '@wordpress/components';
-import { useDispatch, useSelect } from '@wordpress/data';
+import { store as coreStore, useDispatch, useSelect } from '@wordpress/data';
 import { __, sprintf } from '@wordpress/i18n';
 
 /**
  * Internal dependencies
  */
+import { store as editorStore } from '../../';
 import { POST_FORMATS } from '../post-format';
 
-const getSuggestion = ( supportedFormats, suggestedPostFormat ) => {
-	const formats = POST_FORMATS.filter( ( format ) =>
-		includes( supportedFormats, format.id )
-	);
-	return find( formats, ( format ) => format.id === suggestedPostFormat );
-};
-
-const PostFormatSuggestion = ( {
-	suggestedPostFormat,
-	suggestionText,
-	onUpdatePostFormat,
-} ) => (
-	<Button isLink onClick={ () => onUpdatePostFormat( suggestedPostFormat ) }>
+const PostFormatSuggestion = ( { onApplySuggestion, suggestionText } ) => (
+	<Button isLink onClick={ onApplySuggestion }>
 		{ suggestionText }
 	</Button>
 );
 
 export default function PostFormatPanel() {
-	const { currentPostFormat, suggestion } = useSelect( ( select ) => {
+	const suggestedFormat = useSelect( ( select ) => {
 		const { getEditedPostAttribute, getSuggestedPostFormat } = select(
-			'core/editor'
+			editorStore
 		);
-		const supportedFormats = get(
-			select( 'core' ).getThemeSupports(),
-			[ 'formats' ],
-			[]
-		);
-		return {
-			currentPostFormat: getEditedPostAttribute( 'format' ),
-			suggestion: getSuggestion(
-				supportedFormats,
-				getSuggestedPostFormat()
-			),
-		};
-	}, [] );
-
-	const { editPost } = useDispatch( 'core/editor' );
+		const potentialSuggestedFormatId = getSuggestedPostFormat();
 
-	const onUpdatePostFormat = ( format ) => editPost( { format } );
+		// If the suggested format isn't null, isn't already applied, and is
+		// supported by the theme, return it. Otherwise, return null.
+		if (
+			potentialSuggestedFormatId &&
+			potentialSuggestedFormatId !== getEditedPostAttribute( 'format' ) &&
+			( select( coreStore ).getThemeSupports().formats ?? [] ).includes(
+				potentialSuggestedFormatId
+			)
+		) {
+			return POST_FORMATS.find(
+				( { id } ) => id === potentialSuggestedFormatId
+			);
+		}
+		return null;
+	}, [] );
 
-	const panelBodyTitle = [
-		__( 'Suggestion:' ),
-		<span className="editor-post-publish-panel__link" key="label">
-			{ __( 'Use a post format' ) }
-		</span>,
-	];
+	const { editPost } = useDispatch( editorStore );
 
-	if ( ! suggestion || suggestion.id === currentPostFormat ) {
+	if ( ! suggestedFormat ) {
 		return null;
 	}
 
 	return (
-		<PanelBody initialOpen={ false } title={ panelBodyTitle }>
+		<PanelBody
+			initialOpen={ false }
+			title={
+				<>
+					{ __( 'Suggestion:' ) }
+					<span className="editor-post-publish-panel__link">
+						{ __( 'Use a post format' ) }
+					</span>
+				</>
+			}
+		>
 			<p>
 				{ __(
 					'Your theme uses post formats to highlight different kinds of content, like images or videos. Apply a post format to see this special styling.'
 				) }
 			</p>
 			<p>
 				<PostFormatSuggestion
-					onUpdatePostFormat={ onUpdatePostFormat }
-					suggestedPostFormat={ suggestion.id }
+					onApplySuggestion={ () => {
+						editPost( { format: suggestedFormat.id } );
+					} }
 					suggestionText={ sprintf(
 						/* translators: %s: post format */
 						__( 'Apply the "%1$s" format.' ),
-						suggestion.caption
+						suggestedFormat.caption
 					) }
 				/>
 			</p>