-
Notifications
You must be signed in to change notification settings - Fork 471
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1033 from woocommerce/tweak/editor
Dynamically update block editor layout and styling
- Loading branch information
Showing
7 changed files
with
1,337 additions
and
22 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /** | ||
| * Block editor enhancements. | ||
| * | ||
| * Contains functionality to dynamically update the block editor | ||
| * configuration and styling. | ||
| */ | ||
|
|
||
| ( function() { | ||
|
|
||
| /** | ||
| * Check if the main sidebar is active (has widgets). | ||
| * | ||
| * This uses a custom property `mainSidebarActive` added via the | ||
| * `block_editor_settings` filter. | ||
| * | ||
| * @return {boolean} Whether sidebar is active. | ||
| */ | ||
| const sidebarIsActive = () => { | ||
| let settings = wp.data.select( 'core/editor' ).getEditorSettings(); | ||
|
|
||
| if ( settings.hasOwnProperty( 'mainSidebarActive' ) && !! settings.mainSidebarActive ) { | ||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| }; | ||
|
|
||
| /** | ||
| * Get current page template name. | ||
| * | ||
| * @return {string} The page template name. | ||
| */ | ||
| const getCurrentPageTemplate = () => { | ||
| return wp.data.select( 'core/editor' ).getEditedPostAttribute( 'template' ); | ||
| }; | ||
|
|
||
| /** | ||
| * Check if the active theme supports a wide layout. | ||
| * | ||
| * @return {boolean} Whether the theme supports wide layout. | ||
| */ | ||
| const themeSupportsWide = () => { | ||
| let settings = wp.data.select( 'core/editor' ).getEditorSettings(); | ||
|
|
||
| if ( settings.hasOwnProperty( 'alignWide' ) && !! settings.alignWide ) { | ||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| }; | ||
|
|
||
| /** | ||
| * Update editor wide support. | ||
| * | ||
| * @param {boolean} alignWide Whether the editor supports | ||
| * alignWide support. | ||
| * | ||
| * @return {void} | ||
| */ | ||
| const updateWideSupport = ( alignWide ) => { | ||
| wp.data.dispatch( 'core/editor' ).updateEditorSettings( { 'alignWide': !! alignWide } ); | ||
| }; | ||
|
|
||
| /** | ||
| * Update `data-align` attribute on each block. | ||
| * | ||
| * @param {boolean} alignWide Whether alignWide is supported. | ||
| * | ||
| * @return {void} | ||
| */ | ||
| const updateAlignAttribute = ( alignWide ) => { | ||
| let blocks = wp.data.select( 'core/editor' ).getBlocks(); | ||
|
|
||
| blocks.forEach( ( block ) => { | ||
| if ( block.attributes.hasOwnProperty( 'align' ) ) { | ||
| let align = block.attributes.align; | ||
|
|
||
| if ( ! [ 'full', 'wide' ].includes( align ) ) { | ||
| return; | ||
| } | ||
|
|
||
| let blockWrapper = document.getElementById( 'block-' + block.clientId ); | ||
|
|
||
| if ( blockWrapper ) { | ||
| blockWrapper.setAttribute( 'data-align', alignWide ? align : '' ); | ||
| } | ||
| } | ||
| } ); | ||
| }; | ||
|
|
||
| /** | ||
| * Add custom class to editor wrapper if main sidebar is active. | ||
| * | ||
| * @param {boolean} showSidebar Whether to add custom class. | ||
| * | ||
| * @return {void} | ||
| */ | ||
| const toggleCustomSidebarClass = ( showSidebar ) => { | ||
| let editorWrapper = document.getElementsByClassName( 'editor-writing-flow' ); | ||
|
|
||
| if ( ! editorWrapper.length ) { | ||
| return; | ||
| } | ||
|
|
||
| if ( !! showSidebar ) { | ||
| editorWrapper[0].classList.add( 'storefront-has-sidebar' ); | ||
| } else { | ||
| editorWrapper[0].classList.remove( 'storefront-has-sidebar' ); | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Update editor and blocks when layout changes. | ||
| * | ||
| * @return {void} | ||
| */ | ||
| const maybeUpdateEditor = () => { | ||
| if ( 'template-fullwidth.php' === getCurrentPageTemplate() ) { | ||
| updateWideSupport( true ); | ||
| toggleCustomSidebarClass( false ); | ||
| updateAlignAttribute( true ); | ||
| } else if ( sidebarIsActive() ) { | ||
| updateWideSupport( false ); | ||
| toggleCustomSidebarClass( true ); | ||
| updateAlignAttribute( false ); | ||
| } else { | ||
| updateWideSupport( true ); | ||
| toggleCustomSidebarClass( false ); | ||
| updateAlignAttribute( true ); | ||
| } | ||
| }; | ||
|
|
||
| wp.domReady( () => { | ||
|
|
||
| // Don't do anything if the theme doesn't declare support for `align-wide`. | ||
| if ( ! themeSupportsWide() ) { | ||
| return; | ||
| } | ||
|
|
||
| maybeUpdateEditor(); | ||
|
|
||
| let pageTemplate = getCurrentPageTemplate(); | ||
|
|
||
| wp.data.subscribe( () => { | ||
| if ( getCurrentPageTemplate() !== pageTemplate ) { | ||
| pageTemplate = getCurrentPageTemplate(); | ||
|
|
||
| maybeUpdateEditor(); | ||
| } | ||
| } ); | ||
| } ); | ||
| } )(); |
This file contains 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
Oops, something went wrong.