Documentation: Initial matchers documentation #1499
Closed
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
youknowriad
added
the
[Type] Developer Documentation
mtias
reviewed
Jun 27, 2017
blocks/README.md
Outdated
|
|
||
| Given the block's HTML content as a string, attribute matchers extract the block attributes values into an Object. The matchers are made available throught the `wp.blocks.query` variable. | ||
|
|
||
| In addition to all [HPQ](http://github.com/aduth/hpq)'s matchers, we provide these extra matchers to ease working with HTML content: |
There was a problem hiding this comment.
Can we include the HPQ documentation here directly?
|
An "examples" section would be great, we'll need real-case variations. Let's get the docs merged first and then look at examples. |
mtias
reviewed
Jun 28, 2017
|
|
||
| `attr( selector: ?string, name: string ): Function` | ||
|
|
||
| Generates a matcher function, returning an attribute by name if the attribute exists. If no selector is passed, returns attribute of the root element. |
There was a problem hiding this comment.
This is a bit confusing. Can we explain it simpler? If an attributes exists where? Maybe we can change the phrasing to be more about: "Use attr when you want to extract y from x`.
There was a problem hiding this comment.
I'd appreciate some help phrasing here. I'm not very good at that 😅
mtias
reviewed
Jun 28, 2017
|
|
||
| `html( selector: ?string ): Function` | ||
|
|
||
| Convenience for `prop( selector, 'innerHTML' )` . |
There was a problem hiding this comment.
Maybe:
Use when you want to get the raw html within the block as a single attribute. Convenience for prop( selector, 'innerHTML' )".
|
closing in favor of #1786 |
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.
refs #1419
This adds a "Matchers" section to the blocks module documentation. It exposes the matchers available for now (redirecting to HPQ for HPQ's built-in matchers).
I think we'd need a separate "Examples" sections showing the different kind of blocks we can build using the matchers and the components provided.