Tracking: Style Revision UX Improvements

[apeatling]

I'm documenting some discussion around improvements to style revisions in the block editor. Specifically refinements to improve the UX and discoverability of the feature. These will be broken out as separate issues over time, but this can act as a tracking issue.

• Global styles revisions: add pagination #53621
  • Global styles revisions: add pagination  #56799
  • Use load more for pagination instead of number pagination??
• Styles: when viewing revisions, allow for the option to view with Style Book #55577
  • Global styles revisions: integrate style book #56800
• Update the saving flow for style revisions to provide detail instead of just a "custom styles" checkbox.
  • Global style revisions: move change summary code and tests to block editor package #57411
  • Site editor: add global styles changes to save flow #57470
• Global styles controllers: extend with WP_REST_Posts_Controller and WP_REST_Revisions_Controller  wordpress-develop#5699
• Revisions: add new selectors to fetch entity revisions #54046
• Global styles revisions: add route for single styles revisions #55827
• Style Revisions: Remove the dropdown menu #55779
• Style Revisions: Provide more details on what changed in each style revision #55647
  • Global style revisions: show change summary on selected item #56577
• Styles: Revisions Description Text #55648
• Global Style Revisions: ensure consistent back button behavior #55881
• Global styles revisions: update isResolving flag #56491
• Explore a link to the code revisions view Global style revisions: show change summary on selected item #56577 (comment)

Future once these are done: #53484

Related

• Tracking: Core data revisions follow ups #56413

[annezazu]

Not sure if this is intentional but wanted to note these additional related items for consideration:

#53484
#55577

[alexstine]

Sorry, wrong issue.

[apeatling]

@annezazu Thanks for those. I've added #55577, and #53484 will be looked at once these smaller improvements are done.

[ramonjd]

Update the saving flow for style revisions to provide detail instead of just a "custom styles" checkbox

Note to self - looking into this, I think the following needs to occur:

1. We can add a description for the globalStyles entity somewhere around in packages/editor/src/components/entities-saved-states/entity-type-list.js
2. But because this is in the editor package, we'd probably need to move packages/edit-site/src/components/global-styles/screen-revisions/get-revision-changes.js, possibly to where GlobalStylesContext lives in blockEditorPrivateApis (@wordpress/block-editor) so we can consume it. getRevisionChanges() could be renamed to something else 🤷🏻
3. Then we can create a specific hook/whatever to fetch the changes and use as the change description in the EntityTypeList

Some untested pseudo code:

import { privateApis as blockEditorPrivateApis } from '@wordpress/block-editor';
import { useMemo, useContext } from '@wordpress/element';
import { getBlockTypes } from '@wordpress/blocks';

import { unlock } from '../../lock-unlock';

const { GlobalStylesContext, getRevisionChanges } = unlock( blockEditorPrivateApis );

function foo() {
	const { user: currentEditorGlobalStyles } =
		useContext( GlobalStylesContext );

	const blockNames = useMemo( () => {
		const blockTypes = getBlockTypes();
		return blockTypes.reduce( ( accumulator, { name, title } ) => {
			accumulator[ name ] = title;
			return accumulator;
		}, {} );
	}, [] );

	const changeDescription = getRevisionChanges(
		currentEditorGlobalStyles,
	        {},
		blockNames
	);
       ....
}

[getdave]

👋 Hello team. Whats the update on this feature for WP 6.5? Is it likely to land and if so which features (as originally outlined in the roadmap) will make it. Thanks in advance 🙏

[ramonjd]

Thanks @getdave

This issue can be closed off.

The following, outstanding task is ongoing, but comprises a refactor only and I'd say not required for 6.5

• Global styles controllers: extend with WP_REST_Posts_Controller and WP_REST_Revisions_Controller  wordpress-develop#5699

All other relevant PRs attached to this issue have Core backport PRs already (well, one):

• Global styles revisions: add route for single styles revisions wordpress-develop#5622