Reformat and correct blocks/README.md
#1794
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
nylen
added
[Feature] Block API
youknowriad
reviewed
Jul 7, 2017
blocks/README.md
Outdated
| - `save( { attributes: Object } ): WPElement | String` - Returns an element | ||
| describing the markup of a block to be saved in the published content. This | ||
| function is called before save and when switching to an editor's HTML view. | ||
| - `encodeAttributes( attributes: Object ): Object` - Called when save markup is |
There was a problem hiding this comment.
We should probably drop this as it's not implemented
youknowriad
reviewed
Jul 7, 2017
blocks/README.md
Outdated
| - `placeholder: string` - A text hint to be shown to the user when the field value is empty, similar to the [`input` and `textarea` attribute of the same name](https://developer.mozilla.org/en-US/docs/Learn/HTML/Forms/HTML5_updates#The_placeholder_attribute) | ||
| - `value: string` - Markup value of the editable field. Only valid markup is allowed, as determined by `inline` value and available controls. | ||
| - `onChange: Function` - Callback handler when the value of the field changes, passing the new value as its only argument. | ||
| - `inline: boolean` - If true, only inline elements are allowed to be used in |
There was a problem hiding this comment.
I think it's multiple prop (which takes a tagName) now as it's inline by default.
youknowriad
approved these changes
Jul 7, 2017
This is where it'll be really important to provide a working template/example that people can use to get started. In the meantime I've updated the wording here. |
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.
Mostly fixing the hook names updated/added in #1717; also reformatting a few things for clarity and for readability of the source file.
Temporary fix pending a more complete documentation solution like #1786 - we should get this in first.
People will be reading this document more and more as it's linked from make/core posts, and perhaps more importantly, it's now actually possible to create plugins that register blocks.
It will be easiest to review this PR using GitHub's markdown diff mode.