Add section to setAttributes documentation about immutability of attributes #12811
Conversation
This file contains hidden or 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
4 tasks
| } | ||
| ``` | ||
|
|
||
| When calling `setAttributes`, it's important that attributes are not mutated in the process of updating them. This is considered bad practice, the core of Gutenberg has been written with the same philosophies as Redux and state is treated as immutable data. It can also cause bugs. Objects and arrays are passed as references in JavaScript, so mutating them can affect other bindings to those references, for example an attribute's default value. |
Contributor
There was a problem hiding this comment.
This makes a lot of sense to document but I think the lingo might be slightly over the head of many WP developers.
It's obviously good to introduce and use higher level terms so folks can learn and expand their skills, but maybe this can be expanded with some extra context, definitions, etc.?
(This could also link into @mkaz's work on a JS tutorial, so we could point someone to some additional background.)
Contributor
Author
There was a problem hiding this comment.
Thanks for the feedback @chrisvanpatten—I've simplified the text a bit, tried using a simpler vocabulary.
talldan
force-pushed
the
update/setattributes-documentation
branch
from
918afba to
6625cfa
Compare
chrisvanpatten
approved these changes
Dec 18, 2018
Contributor
chrisvanpatten
left a comment
chrisvanpatten
left a comment
There was a problem hiding this comment.
Small tweak request (typo and a new link to more reading), then good to merge 👍
docs/designers-developers/developers/block-api/block-edit-save.md
Outdated
Show resolved
Hide resolved
Co-Authored-By: talldan <[email protected]>
talldan
force-pushed
the
update/setattributes-documentation
branch
from
662f72c to
712a592
Compare
youknowriad
pushed a commit
that referenced
this pull request
Jan 9, 2019
…ibutes (#12811) * Add section to setAttributes documentation about immutability of attributes * Simplify explanation of immutable attributes * Fix typo and add link to redux's immutability docs Co-Authored-By: talldan <[email protected]>
youknowriad
pushed a commit
that referenced
this pull request
Jan 9, 2019
…ibutes (#12811) * Add section to setAttributes documentation about immutability of attributes * Simplify explanation of immutable attributes * Fix typo and add link to redux's immutability docs Co-Authored-By: talldan <[email protected]>
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
#10890 raised an issue about side effects caused by mutating attributes. Looking through the docs there wasn't anything covering best practices around the handling of attributes, so I've added a bit to the documentation for
setAttributes.Types of changes
Documentation update
Checklist: