Site Editor - add basic plugin support#34460
Merged
Addison-Stavlo merged 5 commits intotrunkfrom Sep 9, 2021
Merged
Conversation
Addison-Stavlo
changed the title
|
Size Change: +206 B (0%) Total Size: 1.04 MB
ℹ️ View Unchanged
|
Addison-Stavlo
changed the title
Addison-Stavlo
requested review from
Copons,
creativecoder,
jeyip,
mattwiebe and
vindl
| <ComplementaryAreaMoreMenuItem | ||
| // Menu item is marked with unstable prop for backward compatibility. | ||
| // @see https://github.com/WordPress/gutenberg/issues/14457 | ||
| __unstableExplicitMenuItem |
Contributor
There was a problem hiding this comment.
Just a note that I looked into the implications of taking __unstableExplicitMenuItem out, since there won't be a concern with backwards compatibility, as we're just adding this to the Site Editor now.
If this attribute was removed, PluginSidebar components can't register a companion PluginSidebarMoreMenuItem when isPinnable={ true }. The PluginSidebarMoreMenuItem is generated automatically in that case, and is duplicated if it's also declared manually.
I think it's best to leave __unstableExplicitMenuItem in place:
- Keeps the API consistent between the Post and Site editors
- If
PluginSidebarMoreMenuItemis declared, it is used as thePluginSidebar's menu item whetherisPinnableis set totrueorfalse, which seems less confusing, overall
creativecoder
approved these changes
Sep 7, 2021
Contributor
creativecoder
left a comment
creativecoder
left a comment
There was a problem hiding this comment.
This all looks good, seems reasonable, and tests well for me.
✅ PluginMoreMenuItem works as expected, including href and onClick props
✅ PluginSidebar works as expected
- Shows the topbar when
isPinnableistrue(and vise versa) - Auto generates the more menu item when
isPinnableistrueand there's noPluginSidebarMoreMenuItemdeclared
✅ PluginSidebarMoreMenuItem activates the plugin sidebar and inherits the plugin icon, if not set
✅ Sidebar actions open and close the plugin sidebar as expected
Also
- The implementation matches the Post Editor
- The inline documentation looks correct (with just one small error, see comment)
packages/edit-site/src/components/header/plugin-more-menu-item/index.js
Outdated
Show resolved
Hide resolved
Addison-Stavlo
commented
Sep 8, 2021
packages/edit-site/src/components/header/plugin-more-menu-item/index.js
Outdated
Show resolved
Hide resolved
Contributor
TestingRequirementsPluginSidebar
PluginSidebarMoreMenuItem & PluginMoreMenuItem
openGeneralSidebar / closeGeneralSidebar actions
Browsers
Note
|
jeyip
reviewed
Sep 8, 2021
| * | ||
| * @yield {Object} Action object. | ||
| */ | ||
| export function* openGeneralSidebar( name ) { |
Contributor
There was a problem hiding this comment.
NB:
Does this need to be handled as a control effect because it's dispatching to a separate store?
Contributor
Author
There was a problem hiding this comment.
Yeah, we use controls.dispatch to send this over to the interfaceStore as is done with the equivalent actions in the edit-post store. Or were you proposing a different approach here?
jeyip
approved these changes
Sep 8, 2021
fullofcaffeine
added a commit
that referenced
this pull request
Sep 9, 2021
* trunk: [RNMobile][Embed block] Add device's locale to preview content (#33858) Update AlignmentMatrixControl docs post merge. (#34662) Chore: Update caniuse package to the latest version (#34685) Chore: Move `react-native-url-polyfill` to dev dependencies (#34687) Site Editor - add basic plugin support (#34460) ESLint Plugin: Use Jest related rules only when the package is installed (#33120) Update `@wordpress/components` package's contributing guidelines (#33960) chore(release): publish Update changelog files [RNMobile] [Embed block] Fix content disappearing on Android when switching light/dark mode (#34207) Scripts: Convert legacy entry point arguments for compatibility with webpack 5 (#34264) Update justication control in `flex` layout (#34651) Block Editor: Rename experimental prop used in `BlockControls` (#34644) Fix social links deprecation (#34639)
This was referenced Aug 7, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds basic plugin support to the Site Editor with edit-site specific version of:
How has this been tested?
Tested by registering a plugin with these new components and using them in the Site Editor.
PluginSidebar
Register the plugin and add the sidebar:
isPinnable={ false }prop to thePluginSidebarcomponent in the example above. Reload the editor and verify neither of these buttons are present.PluginSidebarMoreMenuItem & PluginMoreMenuItem
Register the plugin, pass the
isPinnalbe={ false }prop to thePluginSidebarcomponent, and register the two more menu items.PluginSidebarMoreMenuItemexists in the more menu (labeled "Sidebar Menu Item" in our example code above) and that clicking on this opens the plugin sidebar.PluginMoreMenuItemexists in the more menu (labeled "Plugin menu item" in the example code above), although clicking should have no effect as we have not set any link or button action for the plugin.openGeneralSidebar / closeGeneralSidebar actions
With the plugin registered and site editor loaded, open the console window and verify that the following actions open and close the plugin's sidebar as expceted:
wp.data.dispatch( 'core/edit-site' ).openGeneralSidebar( 'plugin-sidebar-test/plugin-sidebar-test' )wp.data.dispatch( 'core/edit-site' ).closeGeneralSidebar( 'plugin-sidebar-test/plugin-sidebar-test' )Screenshots
Types of changes
New feature (non-breaking change which adds functionality)
Checklist:
*.native.jsfiles for terms that need renaming or removal).