Blocks API: Add default implementation for save setting #14510
Merged
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
gziolo
added
[Type] Enhancement
gziolo
requested review from
aduth,
ajitbohra,
chrisvanpatten,
jorgefilipecosta,
mkaz,
noisysocks,
oandregal,
notnownikki,
Soean,
talldan and
youknowriad
as code owners
gziolo
added
the
[Feature] Block Directory
aduth
approved these changes
Mar 19, 2019
docs/designers-developers/developers/block-api/block-edit-save.md
Outdated
Show resolved
Hide resolved
| @@ -106,12 +106,6 @@ describe( 'blocks', () => { | |||
| expect( block ).toBeUndefined(); | |||
| } ); | |||
|
|
|||
| it( 'should reject blocks without a save function', () => { | |||
There was a problem hiding this comment.
Alternatively (or even in place of the "filtered" case below), it could test that save was passed as a non-function.
There was a problem hiding this comment.
Right, I will add it as well.
There was a problem hiding this comment.
The reason why I used the approach with a filter was the fact that the existing check verifies if this is still an object after filtering. Maybe I should add another validation and error messaging to check that in test instead and update the removed test as you suggested.
There was a problem hiding this comment.
I figured out it's going to be easier to open a follow-up which improves error handling together with updates to unit tests: #14529.
Co-Authored-By: gziolo <[email protected]>
This was referenced Apr 1, 2019
5 tasks
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.
Description
There is a proposal to make
savesetting optional when registering a block. This is an outcome of Block Registration RFC:https://github.com/WordPress/gutenberg/blob/2df7f19b360d9d223212167fe5dc5531a3a8accd/docs/rfc/block-registration.md#save
This PR adds the default implementation of
savesetting optional by optimizing for the quite common use case where this method renders nothing on the client and leaves the handling to the server. This is expressed in something similar to the following code:Such a trivial change makes it easier to express all blocks which are referred in docs as dynamic.
Testing
npm test- make sure all unit tests still pass.npm run test-e2e- make sure all e2e tests still pass.Ensure all dynamic blocks still work as before.
All corresponding docs were updated, both usage and example simplified.