Site Editor: Improve loading experience (v2) #47612
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import classNames from 'classnames'; | ||
|
|
||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { | ||
| createContext, | ||
| Suspense, | ||
| useEffect, | ||
| useState, | ||
| } from '@wordpress/element'; | ||
| import { Modal, Spinner } from '@wordpress/components'; | ||
| import { useSuspenseSelect } from '@wordpress/data'; | ||
|
|
||
| const LoadingScreenContext = createContext( false ); | ||
|
|
||
| /** | ||
| * Component that declares a data dependency. | ||
| * Will suspend if data has not resolved. | ||
| * | ||
| * @param {Object} props Component props | ||
| * @param {import('@wordpress/data').StoreDescriptor} props.store Data store descriptor | ||
| * @param {string} props.selector Selector name | ||
| * @param {Array} props.args Optional arguments to pass to the selector | ||
| */ | ||
| const SuspenseDataDependency = ( { store, selector, args = [] } ) => { | ||
| useSuspenseSelect( | ||
| ( select ) => select( store )[ selector ]( ...args ), | ||
| [] | ||
| ); | ||
|
|
||
| return null; | ||
| }; | ||
|
|
||
| /** | ||
| * Component that will render a loading screen if dependencies have not resolved, | ||
| * or its children if all dependencies have resolved. | ||
| * | ||
| * @param {Object} props Component props | ||
| * @param {Array} props.dataDependencies Array of dependencies | ||
| * @param {string} props.children Component children | ||
| * @param {string?} props.overlayClassName Additional overlay classname | ||
| */ | ||
| const SuspenseWithLoadingScreen = ( { | ||
| dataDependencies, | ||
| children, | ||
| overlayClassName, | ||
| } ) => { | ||
| const [ loaded, setLoaded ] = useState( false ); | ||
|
|
||
| const finishedLoading = () => { | ||
| if ( ! loaded ) { | ||
| setLoaded( true ); | ||
| } | ||
| }; | ||
|
|
||
| return ( | ||
| <LoadingScreenContext.Provider value={ loaded }> | ||
| { loaded ? ( | ||
| <> | ||
| <LoadingScreen | ||
| overlayClassName={ overlayClassName } | ||
| autoClose | ||
| /> | ||
| { children } | ||
| </> | ||
| ) : ( | ||
| <Suspense | ||
| fallback={ | ||
| <LoadingScreen | ||
| onUnmount={ finishedLoading } | ||
| overlayClassName={ overlayClassName } | ||
| /> | ||
| } | ||
| > | ||
| { dataDependencies.map( | ||
| ( { store, selector, args }, depindex ) => ( | ||
| <SuspenseDataDependency | ||
| key={ `suspense-dep-${ depindex }-${ store.name }-${ selector }` } | ||
| store={ store } | ||
| selector={ selector } | ||
| args={ args } | ||
| /> | ||
| ) | ||
| ) } | ||
|
Comment on lines
+79
to
+88
There was a problem hiding this comment. Here's where we render one |
||
| { children } | ||
| </Suspense> | ||
| ) } | ||
| </LoadingScreenContext.Provider> | ||
| ); | ||
| }; | ||
|
|
||
| /** | ||
| * Renders a loading screen. | ||
| * Supports automatic closing with the `autoClose` prop. | ||
| * | ||
| * @param {Object} props Component props | ||
| * @param {Function?} props.onUnmount Optional callback to call on unmount. | ||
| * @param {boolean} props.autoClose Whether to automatically close. | ||
| * @param {string?} props.overlayClassName Additional overlay classname | ||
| */ | ||
| const LoadingScreen = ( { onUnmount, autoClose, overlayClassName } ) => { | ||
| const [ visible, setVisible ] = useState( true ); | ||
|
|
||
| useEffect( () => { | ||
| if ( autoClose ) { | ||
| setTimeout( () => { | ||
| setVisible( false ); | ||
| }, 2000 ); | ||
| } | ||
|
|
||
| return () => { | ||
| if ( onUnmount ) { | ||
| onUnmount(); | ||
| } | ||
| }; | ||
| } ); | ||
|
|
||
| if ( ! visible ) { | ||
| return null; | ||
| } | ||
|
|
||
| return ( | ||
| <Modal | ||
| isFullScreen | ||
| isDismissible={ false } | ||
| onRequestClose={ () => {} } | ||
| __experimentalHideHeader | ||
| className="block-editor-loading-screen-modal" | ||
| overlayClassName={ classNames( | ||
| 'block-editor-loading-screen-modal-overlay', | ||
| overlayClassName | ||
| ) } | ||
| > | ||
| <div className="block-editor-loading-screen-wrapper"> | ||
| <Spinner /> | ||
| </div> | ||
| </Modal> | ||
| ); | ||
| }; | ||
|
|
||
| export default SuspenseWithLoadingScreen; | ||
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,24 @@ | ||
| .block-editor-loading-screen-modal-overlay { | ||
| backdrop-filter: none; | ||
| background-color: transparent; | ||
| padding-top: $header-height; | ||
| } | ||
|
|
||
| .block-editor-loading-screen-modal-overlay.is-canvas-view { | ||
| padding-top: 0; | ||
| } | ||
|
|
||
| .block-editor-loading-screen-modal.is-full-screen { | ||
| box-shadow: 0 0 0 transparent; | ||
| width: 100%; | ||
| max-width: 100%; | ||
| max-height: 100%; | ||
| min-height: 100%; | ||
| } | ||
|
|
||
| .block-editor-loading-screen-wrapper { | ||
| display: flex; | ||
| align-items: center; | ||
| justify-content: center; | ||
| height: 100%; | ||
| } |
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
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.
This is the component that we render for each declared data dependency. It will suspend when the data has not been resolved yet.