-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Block List: Extract scroll preservation as non-visual component #5085
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,80 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { Component } from '@wordpress/element'; | ||
import { withSelect } from '@wordpress/data'; | ||
import { getScrollContainer } from '@wordpress/utils'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import { getBlockDOMNode } from '../../utils/dom'; | ||
|
||
/** | ||
* Non-visual component which preserves offset of selected block within nearest | ||
* scrollable container while reordering. | ||
* | ||
* @example | ||
* | ||
* ```jsx | ||
* <PreserveScrollInReorder /> | ||
* ``` | ||
*/ | ||
class PreserveScrollInReorder extends Component { | ||
componentWillUpdate( nextProps ) { | ||
const { blockOrder, selectionStart } = nextProps; | ||
if ( blockOrder !== this.props.blockOrder && selectionStart ) { | ||
this.setPreviousOffset( selectionStart ); | ||
} | ||
} | ||
|
||
componentDidUpdate() { | ||
if ( this.previousOffset ) { | ||
this.restorePreviousOffset(); | ||
} | ||
} | ||
|
||
/** | ||
* Given the block UID of the start of the selection, saves the block's | ||
* top offset as an instance property before a reorder is to occur. | ||
* | ||
* @param {string} selectionStart UID of selected block. | ||
*/ | ||
setPreviousOffset( selectionStart ) { | ||
const blockNode = getBlockDOMNode( selectionStart ); | ||
if ( ! blockNode ) { | ||
return; | ||
} | ||
|
||
this.previousOffset = blockNode.getBoundingClientRect().top; | ||
} | ||
|
||
/** | ||
* After a block reordering, restores the previous viewport top offset. | ||
*/ | ||
restorePreviousOffset() { | ||
const { selectionStart } = this.props; | ||
const blockNode = getBlockDOMNode( selectionStart ); | ||
if ( blockNode ) { | ||
const scrollContainer = getScrollContainer( blockNode ); | ||
if ( scrollContainer ) { | ||
scrollContainer.scrollTop = scrollContainer.scrollTop + | ||
blockNode.getBoundingClientRect().top - | ||
this.previousOffset; | ||
} | ||
} | ||
|
||
delete this.previousOffset; | ||
} | ||
|
||
render() { | ||
return null; | ||
} | ||
} | ||
|
||
export default withSelect( ( select ) => { | ||
return { | ||
blockOrder: select( 'core/editor' ).getBlockOrder(), | ||
selectionStart: select( 'core/editor' ).getBlockSelectionStart(), | ||
}; | ||
} )( PreserveScrollInReorder ); |
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,12 @@ | ||
/** | ||
* Given a block UID, returns the corresponding DOM node for the block, if | ||
* exists. As much as possible, this helper should be avoided, and used only | ||
* in cases where isolated behaviors need remote access to a block node. | ||
* | ||
* @param {string} uid Block UID. | ||
* | ||
* @return {Element} Block DOM node. | ||
*/ | ||
export function getBlockDOMNode( uid ) { | ||
return document.querySelector( '[data-block="' + uid + '"]' ); | ||
} |
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.
I'm seeing two other places where we use a similar technical to get the block DOM node, should we update those as well? (search for
[data-block="
)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.
I could only find one other, but replaced it in fad28e2.
There's a reference to
data-block
inWritingFlow
as well, but this wouldn't be as easy to replace and is proposed for removal anyways in #5289.