Add a responsiveEditingEnabled editor setting to hide the Responsive styles option - #80814
Conversation
Adds an editor setting, defaulting to `true`, that controls whether the "Responsive styles" option is offered in the View menu. When a site sets it to `false` through the `block_editor_settings_all` filter, the option is not rendered and users cannot target style edits at a single viewport. The setting follows the existing `richEditingEnabled` / `codeEditingEnabled` pattern: the default lives in `EDITOR_SETTINGS_DEFAULTS` and the only consumer, `PreviewDropdown`, reads it from `getEditorSettings()`. Co-Authored-By: Claude <noreply@anthropic.com>
|
Size Change: +37 B (0%) Total Size: 7.76 MB 📦 View Changed
|
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
andrewserong
left a comment
There was a problem hiding this comment.
This looks like a good and simple way to do it to me! I like the responsiveEditingEnabled name as it's consistent with some of the other settings, and this feels like an easy way for plugins or site owners to disable the responsive editing if they want to.
A couple of other things that I think is good about the approach:
- It just hides the toggle, so responsive styles that exist in post content still work as before. This seems important if themes or templates wind up using responsive styles — it's just that an editor is prevented from making changes.
- It also means that a plugin could disable based on user capability or other means so that perhaps an admin could make responsive styling changes, but regular authors etc maybe not, and so on
It does mean we'll need to keep this setting in mind for future changes to the UI, but I think that's also a good thing.
LGTM! 🚀
| * @property {boolean|Array} allowedBlockTypes Allowed block types | ||
| * @property {boolean} richEditingEnabled Whether rich editing is enabled or not | ||
| * @property {boolean} codeEditingEnabled Whether code editing is enabled or not | ||
| * @property {boolean} responsiveEditingEnabled Whether editing styles per viewport is enabled or not |
There was a problem hiding this comment.
Totally optional nit, to lead with the responsive name:
| * @property {boolean} responsiveEditingEnabled Whether editing styles per viewport is enabled or not | |
| * @property {boolean} responsiveEditingEnabled Whether responsive (per-viewport) style editing is enabled or not |
ramonjd
left a comment
There was a problem hiding this comment.
Adds a responsiveEditingEnabled editor setting so that sites can hide the "Responsive styles" option from the device preview dropdown.
This PR does what it says! I had a few questions around naming, and the JS dispatch to toggle off the preview dropdown.
Per review feedback, the description now starts with the setting's own name so it reads consistently with the property it documents. Co-Authored-By: Claude <noreply@anthropic.com>
The $context parameter was declared but never used in these snippets, which also forced the accepted-args argument on add_filter(). Removing both keeps the examples minimal and consistent with editor-filters.md. Co-Authored-By: Claude <noreply@anthropic.com>
The default settings object listed responsiveEditingEnabled after fontLibraryEnabled while the @Property docblock lists it before, making the two orders diverge. Co-Authored-By: Claude <noreply@anthropic.com>
The setting only hid the View menu option, so the site editor's Styles page still exposed a viewport state selector, letting users add and edit per-viewport global styles that the setting was meant to prevent. Gating happens in GlobalStylesUIWrapper so both the editor sidebar and the site editor Styles page are covered. Only viewport states are withheld; pseudo states such as hover stay available. Co-Authored-By: Claude <noreply@anthropic.com>
…styles option (#80814) * Add a responsiveEditingEnabled editor setting Adds an editor setting, defaulting to `true`, that controls whether the "Responsive styles" option is offered in the View menu. When a site sets it to `false` through the `block_editor_settings_all` filter, the option is not rendered and users cannot target style edits at a single viewport. The setting follows the existing `richEditingEnabled` / `codeEditingEnabled` pattern: the default lives in `EDITOR_SETTINGS_DEFAULTS` and the only consumer, `PreviewDropdown`, reads it from `getEditorSettings()`. Co-Authored-By: Claude <noreply@anthropic.com> * Add backport changelog * Reword responsiveEditingEnabled JSDoc to lead with "responsive" Per review feedback, the description now starts with the setting's own name so it reads consistently with the property it documents. Co-Authored-By: Claude <noreply@anthropic.com> * Docs: Drop unused $context from block_editor_settings_all examples The $context parameter was declared but never used in these snippets, which also forced the accepted-args argument on add_filter(). Removing both keeps the examples minimal and consistent with editor-filters.md. Co-Authored-By: Claude <noreply@anthropic.com> * Match responsiveEditingEnabled key order to the docblock The default settings object listed responsiveEditingEnabled after fontLibraryEnabled while the @Property docblock lists it before, making the two orders diverge. Co-Authored-By: Claude <noreply@anthropic.com> * Hide the Global Styles viewport control when responsive editing is off The setting only hid the View menu option, so the site editor's Styles page still exposed a viewport state selector, letting users add and edit per-viewport global styles that the setting was meant to prevent. Gating happens in GlobalStylesUIWrapper so both the editor sidebar and the site editor Styles page are covered. Only viewport states are withheld; pseudo states such as hover stay available. Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: t-hamano <wildworks@git.wordpress.org> Co-authored-by: andrewserong <andrewserong@git.wordpress.org> Co-authored-by: ramonjd <ramonopoly@git.wordpress.org>
|
I just cherry-picked this PR to the wp/7.1 branch to get it included in the next release: 2095371 |
|
I plan to add the following content to the dev note. https://make.wordpress.org/core/?p=124535&preview=1&_ppp=bb56023b02 Opting out of responsive editingSites that need style changes to always apply to every viewport can turn off responsive editing with the add_filter( 'block_editor_settings_all', 'example_disable_responsive_editing' );
function example_disable_responsive_editing( $settings ) {
$settings['responsiveEditingEnabled'] = false;
return $settings;
}When it is The setting governs the editing interface only. Responsive styles already saved in |
Nice one! Sorry to be nitpicky, there's a tiny bit of wording I'd tweak if you're up for it:
I'd possibly say instead "Sites that need to prevent users from making viewport-based styling changes can turn off responsive style editing with the..." So that it's clear it's about gating the the editing behaviour, not the styles output. Up to you, though, otherwise that reads nicely to me! |
|
@andrewserong Thanks for the feedback! I have updated the content according to the feedback. |
This updates the pinned commit hash of the Gutenberg repository from `4997026b75c922d8a6f77a03d72ed7cad04c7073` to `fd715a6833679d098d9fee84b642f8f1bc27341b`. A full list of changes included in this commit can be found on GitHub: WordPress/gutenberg@4997026...fd715a6 - Update view config API versioning (WordPress/gutenberg#80319) - Perf Tests: Fix 'Selecting blocks' metric reporting 0 ms (WordPress/gutenberg#80524) - Notes: Register the inline note format at import time (WordPress/gutenberg#80576) - Media: Stop forcing crossorigin on IMG tags in media templates (WordPress/gutenberg#80532) - GradientPicker: select by slug so two presets sharing a gradient keep their identity (WordPress/gutenberg#80554) - Media Editor: Show a loading state while the cropped file loads (WordPress/gutenberg#80460) - Remove default paragraph from tab-panel template (WordPress/gutenberg#80565) - Global Styles: Resolve link element styles in block inspector controls for blocks that are links (WordPress/gutenberg#80607) - Media REST API: Backport sideload from url path upload size check (WordPress/gutenberg#80659) - Rich text: remove tabIndex from editable elements again to fix shift+click selection (WordPress/gutenberg#80651) - Gallery: make dynamic mode conversion a single undo level (WordPress/gutenberg#80665) - Background image control: Remove duplicated focus ring (WordPress/gutenberg#80671) - Detach core's note mention kses filter in the baseline strip test (WordPress/gutenberg#80656) - wp-build: sync the page template preload field list with core-data (WordPress/gutenberg#80648) - Read the contentEditable attribute in ownsSelection, not isContentEditable (WordPress/gutenberg#80549) - Writing flow: extend block selections with shift+arrow when there is no native selection (WordPress/gutenberg#80687) - Notes: Capture the target block before saving a block-level note (WordPress/gutenberg#80690) - Theme JSON: Level block-level preset class specificity with :where() (WordPress/gutenberg#80657) - Notes: Sync the sidebar selection to the inline marker under the caret (WordPress/gutenberg#80610) - Writing flow: use isMultiSelecting for shift+click (WordPress/gutenberg#80286) (WordPress/gutenberg#80726) - Block supports: Return from layout support before resolving global settings (WordPress/gutenberg#80771) - Notes: Report save success consistently from note actions (WordPress/gutenberg#80748) - Dynamic Gallery: Rename toolbar button to Detach and add a modal explaining what will happen (WordPress/gutenberg#80727) (WordPress/gutenberg#80774) - ToolsPanel: Migrate styles to an SCSS Module (WordPress/gutenberg#80445) (WordPress/gutenberg#80800) - Add a responsiveEditingEnabled editor setting to hide the Responsive styles option (WordPress/gutenberg#80814) - iOS: remove jumping hack, add typewriter (WordPress/gutenberg#74596) - Writing flow: stop the page scrolling on caret moves within blocks taller than the viewport (WordPress/gutenberg#80708) - Global Styles: Put the inheritance UI behind a Gutenberg experiment (… (WordPress/gutenberg#80818) - Notes: Cancel in-flight hover highlight when focus leaves a note thread (WordPress/gutenberg#80752) - Block Editor: Try to fix typing performance regression (WordPress/gutenberg#80507) - List Block: Preserve ordered type on indent (WordPress/gutenberg#75353) - Make editableRoot a private block setting Symbol, not a public support (WordPress/gutenberg#80820) - Fix cursor position during forward delete of empty blocks (WordPress/gutenberg#80827) - Navigation: Fixes `aria-expanded` not updating on hover submenu inside overlay (WordPress/gutenberg#80828) - Remove redundant @jest-environment jsdom pragma and lint against it (WordPress/gutenberg#80676) - View config: reject shape-mismatched merges, define empty-array semantics, strip nulls from appended members (WordPress/gutenberg#80829) - Editor: leave undo to the browser in fields that handle their own undo (WordPress/gutenberg#80768) - Fix: New route-based admin pages are empty when no JS (WordPress/gutenberg#80839) Props wildworks. See #65529. git-svn-id: https://develop.svn.wordpress.org/trunk@62896 602fd350-edb4-49c9-b593-d223f7449a82
This updates the pinned commit hash of the Gutenberg repository from `4997026b75c922d8a6f77a03d72ed7cad04c7073` to `fd715a6833679d098d9fee84b642f8f1bc27341b`. A full list of changes included in this commit can be found on GitHub: WordPress/gutenberg@4997026...fd715a6 - Update view config API versioning (WordPress/gutenberg#80319) - Perf Tests: Fix 'Selecting blocks' metric reporting 0 ms (WordPress/gutenberg#80524) - Notes: Register the inline note format at import time (WordPress/gutenberg#80576) - Media: Stop forcing crossorigin on IMG tags in media templates (WordPress/gutenberg#80532) - GradientPicker: select by slug so two presets sharing a gradient keep their identity (WordPress/gutenberg#80554) - Media Editor: Show a loading state while the cropped file loads (WordPress/gutenberg#80460) - Remove default paragraph from tab-panel template (WordPress/gutenberg#80565) - Global Styles: Resolve link element styles in block inspector controls for blocks that are links (WordPress/gutenberg#80607) - Media REST API: Backport sideload from url path upload size check (WordPress/gutenberg#80659) - Rich text: remove tabIndex from editable elements again to fix shift+click selection (WordPress/gutenberg#80651) - Gallery: make dynamic mode conversion a single undo level (WordPress/gutenberg#80665) - Background image control: Remove duplicated focus ring (WordPress/gutenberg#80671) - Detach core's note mention kses filter in the baseline strip test (WordPress/gutenberg#80656) - wp-build: sync the page template preload field list with core-data (WordPress/gutenberg#80648) - Read the contentEditable attribute in ownsSelection, not isContentEditable (WordPress/gutenberg#80549) - Writing flow: extend block selections with shift+arrow when there is no native selection (WordPress/gutenberg#80687) - Notes: Capture the target block before saving a block-level note (WordPress/gutenberg#80690) - Theme JSON: Level block-level preset class specificity with :where() (WordPress/gutenberg#80657) - Notes: Sync the sidebar selection to the inline marker under the caret (WordPress/gutenberg#80610) - Writing flow: use isMultiSelecting for shift+click (WordPress/gutenberg#80286) (WordPress/gutenberg#80726) - Block supports: Return from layout support before resolving global settings (WordPress/gutenberg#80771) - Notes: Report save success consistently from note actions (WordPress/gutenberg#80748) - Dynamic Gallery: Rename toolbar button to Detach and add a modal explaining what will happen (WordPress/gutenberg#80727) (WordPress/gutenberg#80774) - ToolsPanel: Migrate styles to an SCSS Module (WordPress/gutenberg#80445) (WordPress/gutenberg#80800) - Add a responsiveEditingEnabled editor setting to hide the Responsive styles option (WordPress/gutenberg#80814) - iOS: remove jumping hack, add typewriter (WordPress/gutenberg#74596) - Writing flow: stop the page scrolling on caret moves within blocks taller than the viewport (WordPress/gutenberg#80708) - Global Styles: Put the inheritance UI behind a Gutenberg experiment (… (WordPress/gutenberg#80818) - Notes: Cancel in-flight hover highlight when focus leaves a note thread (WordPress/gutenberg#80752) - Block Editor: Try to fix typing performance regression (WordPress/gutenberg#80507) - List Block: Preserve ordered type on indent (WordPress/gutenberg#75353) - Make editableRoot a private block setting Symbol, not a public support (WordPress/gutenberg#80820) - Fix cursor position during forward delete of empty blocks (WordPress/gutenberg#80827) - Navigation: Fixes `aria-expanded` not updating on hover submenu inside overlay (WordPress/gutenberg#80828) - Remove redundant @jest-environment jsdom pragma and lint against it (WordPress/gutenberg#80676) - View config: reject shape-mismatched merges, define empty-array semantics, strip nulls from appended members (WordPress/gutenberg#80829) - Editor: leave undo to the browser in fields that handle their own undo (WordPress/gutenberg#80768) - Fix: New route-based admin pages are empty when no JS (WordPress/gutenberg#80839) Props wildworks. See #65529. Built from https://develop.svn.wordpress.org/trunk@62896 git-svn-id: http://core.svn.wordpress.org/trunk@62163 1a063a9b-81f0-0310-95a4-ce76da25c4cd
|
Thanks for sorting this out! |
What?
Adds a
responsiveEditingEnablededitor setting so that sites can hide the "Responsive styles" option from the device preview dropdown.Why?
Feedback on the Call for Testing for responsive styling asked for a way to opt out of the feature.
How?
Adds a
responsiveEditingEnablededitor setting, which can be set through theblock_editor_settings_allfilter. It follows the existingrichEditingEnabled/codeEditingEnabledpattern.The setting only hides the toggle. Responsive styles already stored in content, and the styles they output on the front end, are unaffected.
Testing Instructions
On
trunk, add a block and apply a style to the Mobile viewport only and save the post.Add the filter from the documentation to a plugin or your theme's
functions.php:Reload the editor and open the device preview dropdown. Confirm that "Responsive styles" is no longer listed and that the viewport options still work.
Confirm the style applied in step 1 is still rendered in the editor and on the front end.
Repeat steps 3 and 4 in the Site Editor.
Use of AI Tools
Claude Code was used to write the implementation and documentation following my direction. I have reviewed and tested all of the changes.
Note
If this PR is merged, I plan to add code examples to the dev note to disable responsive editing.
https://make.wordpress.org/core/?p=124535&preview=1&_ppp=bb56023b02