Replace Twenty Twenty-One custom JS frontend code with Interactivity API #5795
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { store, getContext, getElement } from '@wordpress/interactivity'; | ||
|
|
||
| function checkClass( element, className ) { | ||
| if ( element.classList.contains( className ) ) { | ||
| return element; | ||
| } | ||
| if ( element.parentElement && element.parentElement.classList.contains( className ) ) { | ||
| return element.parentElement; | ||
| } | ||
| if ( element.parentElement.parentElement && element.parentElement.parentElement.classList.contains( className ) ) { | ||
| return element.parentElement.parentElement; | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| const { state, actions } = store( 'twentytwentyone', { | ||
| state: { | ||
| isPrimaryMenuOpen: false, | ||
| prevScroll: 0, | ||
| isDarkMode: false, | ||
| isDarkModeManuallyOverwritten: false, | ||
| isDarkModeTogglerHidden: false, | ||
| }, | ||
| actions: { | ||
| togglePrimaryMenu: () => { | ||
| state.isPrimaryMenuOpen = ! state.isPrimaryMenuOpen; | ||
| }, | ||
|
|
||
| openPrimaryMenu: () => { | ||
| state.isPrimaryMenuOpen = true; | ||
| }, | ||
|
|
||
| closePrimaryMenu: () => { | ||
| state.isPrimaryMenuOpen = false; | ||
| }, | ||
|
|
||
| toggleDarkMode: () => { | ||
| state.isDarkMode = ! state.isDarkMode; | ||
| state.isDarkModeManuallyOverwritten = true; | ||
| }, | ||
|
|
||
| trapFocusInModal: ( event ) => { | ||
| if ( ! state.isPrimaryMenuOpen ) { | ||
| return; | ||
| } | ||
|
|
||
| const ctx = getContext(); | ||
|
|
||
| const escKey = event.keyCode === 27; | ||
| if ( escKey ) { | ||
| event.preventDefault(); | ||
| actions.closePrimaryMenu(); | ||
| if ( ctx.firstFocusable ) { | ||
| ctx.firstFocusable.focus(); | ||
| } | ||
| return; | ||
| } | ||
|
|
||
| const tabKey = event.keyCode === 9; | ||
| const shiftKey = event.shiftKey; | ||
| const activeEl = document.activeElement; // eslint-disable-line @wordpress/no-global-active-element | ||
|
|
||
| if ( ! shiftKey && tabKey && ctx.lastFocusable === activeEl ) { | ||
| event.preventDefault(); | ||
| if ( ctx.firstFocusable ) { | ||
| ctx.firstFocusable.focus(); | ||
| } | ||
| return; | ||
| } | ||
|
|
||
| if ( shiftKey && tabKey && ctx.firstFocusable === activeEl ) { | ||
| event.preventDefault(); | ||
| if ( ctx.lastFocusable ) { | ||
| ctx.lastFocusable.focus(); | ||
| } | ||
| return; | ||
| } | ||
|
|
||
| // If there are no elements in the menu, don't move the focus | ||
| if ( tabKey && ctx.firstFocusable === ctx.lastFocusable ) { | ||
| event.preventDefault(); | ||
| } | ||
| }, | ||
|
|
||
| listenToSpecialClicks: ( event ) => { | ||
| const ctx = getContext(); | ||
|
|
||
| // Check if this was a `.sub-menu-toggle` click. | ||
| const subMenuToggle = checkClass( event.target, 'sub-menu-toggle' ); | ||
| if ( subMenuToggle ) { | ||
| if ( ctx.activeSubmenu === subMenuToggle ) { | ||
| ctx.activeSubmenu = null; | ||
| } else { | ||
| ctx.activeSubmenu = subMenuToggle; | ||
| } | ||
| return; | ||
| } | ||
|
|
||
| // Otherwise, check if this was an anchor link click. | ||
| if ( ! event.target.hash ) { | ||
| return; | ||
| } | ||
|
|
||
| actions.closePrimaryMenu(); | ||
|
|
||
| // Wait 550 and scroll to the anchor. | ||
| setTimeout( () => { | ||
| var anchor = document.getElementById( event.target.hash.slice( 1 ) ); | ||
| if ( anchor ) { | ||
| anchor.scrollIntoView(); | ||
| } | ||
| }, 550 ); | ||
| }, | ||
| }, | ||
| callbacks: { | ||
| determineFocusableElements: () => { | ||
| if ( ! state.isPrimaryMenuOpen ) { | ||
| return; | ||
| } | ||
|
|
||
| const ctx = getContext(); | ||
| const { ref } = getElement(); | ||
| const elements = ref.querySelectorAll( 'input, a, button' ); | ||
|
|
||
| ctx.firstFocusable = elements[ 0 ]; | ||
| ctx.lastFocusable = elements[ elements.length - 1 ]; | ||
| }, | ||
|
|
||
| refreshSubmenus: () => { | ||
| const ctx = getContext(); | ||
| const { ref } = getElement(); | ||
| const elements = ref.querySelectorAll( '.sub-menu-toggle' ); | ||
| elements.forEach( ( subMenuToggle ) => { | ||
| if ( ctx.activeSubmenu === subMenuToggle ) { | ||
| subMenuToggle.setAttribute( 'aria-expanded', 'true' ); | ||
| } else { | ||
| subMenuToggle.setAttribute( 'aria-expanded', 'false' ); | ||
| } | ||
| } ); | ||
| }, | ||
|
|
||
| makeIframesResponsive: () => { | ||
| const { ref } = getElement(); | ||
|
|
||
| ref.querySelectorAll( 'iframe' ).forEach( function( iframe ) { | ||
| // Only continue if the iframe has a width & height defined. | ||
| if ( iframe.width && iframe.height ) { | ||
| // Calculate the proportion/ratio based on the width & height. | ||
| proportion = parseFloat( iframe.width ) / parseFloat( iframe.height ); | ||
| // Get the parent element's width. | ||
| parentWidth = parseFloat( window.getComputedStyle( iframe.parentElement, null ).width.replace( 'px', '' ) ); | ||
| // Set the max-width & height. | ||
| iframe.style.maxWidth = '100%'; | ||
| iframe.style.maxHeight = Math.round( parentWidth / proportion ).toString() + 'px'; | ||
| } | ||
| } ); | ||
| }, | ||
|
|
||
| initDarkMode: () => { | ||
| let isDarkMode = window.matchMedia( '(prefers-color-scheme: dark)' ).matches; | ||
| let isDarkModeManuallyOverwritten = false; | ||
|
|
||
| const cachedValue = window.localStorage.getItem( 'twentytwentyoneDarkMode' ); | ||
| if ( 'yes' === cachedValue ) { | ||
| isDarkMode = true; | ||
| isDarkModeManuallyOverwritten = true; | ||
| } else if ( 'no' === cachedValue ) { | ||
| isDarkMode = false; | ||
| isDarkModeManuallyOverwritten = true; | ||
| } | ||
|
|
||
| state.isDarkMode = isDarkMode; | ||
| state.isDarkModeManuallyOverwritten = isDarkModeManuallyOverwritten; | ||
| }, | ||
|
|
||
| storeDarkMode: () => { | ||
| // Store dark mode preference in local storage only if it was explicitly set via the website toggle. | ||
| if ( state.isDarkModeManuallyOverwritten ) { | ||
| window.localStorage.setItem( 'twentytwentyoneDarkMode', state.isDarkMode ? 'yes' : 'no' ); | ||
| } | ||
| }, | ||
|
|
||
| refreshHtmlElementDarkMode: () => { | ||
| // This hack may be needed since the HTML element cannot be controlled with the API attributes? | ||
| if ( state.isDarkMode ) { | ||
| document.documentElement.classList.add( 'is-dark-theme' ); | ||
| } else { | ||
| document.documentElement.classList.remove( 'is-dark-theme' ); | ||
| } | ||
| }, | ||
|
|
||
| refreshDarkModeToggler: () => { | ||
| const currentScroll = window.scrollY || document.documentElement.scrollTop; | ||
| if ( | ||
| currentScroll + ( window.innerHeight * 1.5 ) > document.body.clientHeight || | ||
| currentScroll < state.prevScroll | ||
| ) { | ||
| state.isDarkModeTogglerHidden = false; | ||
| } else if ( currentScroll > state.prevScroll && 250 < currentScroll ) { | ||
| state.isDarkModeTogglerHidden = true; | ||
| } | ||
| state.prevScroll = currentScroll; | ||
| }, | ||
| }, | ||
| } ); | ||
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
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.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<html>is not supported as an interactivity target, so this is the exception where mutating the DOM manually is correct.Oh, and doing so reactively with a
data-wp-watchlike you're doing here is the best possible way to do so because it will always be in sync, no matter wherestate.isDarkModeis changed 🙂