Page List Block: Simplify Page List convert to links function API #46365
Conversation
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
getdave
added
[Type] Code Quality
getdave
requested review from
scruffian,
MaggieCabrera,
ajlende and
draganescu
getdave
commented
Dec 7, 2022
|
|
||
| const PAGE_FIELDS = [ 'id', 'title', 'link', 'type', 'parent' ]; | ||
| const MAX_PAGE_COUNT = 100; | ||
|
|
||
| export const convertSelectedBlockToNavigationLinks = |
There was a problem hiding this comment.
Extracted to its own file.
getdave
commented
Dec 7, 2022
| convertToNavigationLinks( pages ); | ||
|
|
||
| // Replace the Page List block with the Navigation Links. | ||
| replaceBlock( clientId, navigationLinks ); |
There was a problem hiding this comment.
This new call is needed but that has the advantage of making the function simpler and more flexible.
getdave
commented
Dec 7, 2022
| @@ -196,7 +195,7 @@ export default function PageListEdit( { | |||
| return ( | |||
| <> | |||
| <InspectorControls> | |||
| { isNavigationChild && ( | |||
| { isNavigationChild && pages?.length > 0 && ( | |||
There was a problem hiding this comment.
We shouldn't show this if there are no pages...right?
getdave
commented
Dec 7, 2022
| convertToNavigationLinks( pages ); | ||
|
|
||
| // Replace the Page List block with the Navigation Links. | ||
| replaceBlock( clientId, navigationLinks ); |
There was a problem hiding this comment.
This new call is needed but that has the advantage of making the function simpler and more flexible.
getdave
commented
Dec 7, 2022
|
|
||
| // Mock createBlock to avoid creating the blocks in test environment | ||
| // as convertToNavigationLinks calls this method internally. | ||
| jest.mock( '@wordpress/blocks', () => { |
There was a problem hiding this comment.
Mocking here avoids the need to curry the function.
|
Size Change: -37 B (0%) Total Size: 1.32 MB
ℹ️ View Unchanged
|
scruffian
reviewed
Dec 8, 2022
scruffian
force-pushed
the
update/simplify-convert-to-links-function-api
branch
from
79c9911
to
e3045d8
Compare
ryanwelcher
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
Simplifies the API of the function which converts Pages to Nav links and improves its adherence to SRP.
Why?
In #46352 we used the
convertfunction from the Convert Modal in a second place in the Page List code. This drew attention to the overly complex API of that function and the fact that it was unnecessarily curried (presumably to aid in the writing of tests).The changes in this PR make the function easier to work with, reason about and test.
How?
This PR
Testing Instructions
Check that the "convert to links" functionality of the Page List inside Nav block works both when:
Editin the Block Toolbar and then clicking in the Moda;Customizein the Inspector ControlsTesting Instructions for Keyboard
Screenshots or screencast