Docs - Dataviews: Better explanation of the "elements" property and its connection to the "filterBy" property #64633
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
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
oandregal
reviewed
Aug 20, 2024
oandregal
reviewed
Aug 20, 2024
oandregal
approved these changes
Aug 20, 2024
Co-authored-by: André <[email protected]>
Co-authored-by: André <[email protected]>
artemiomorales
added
[Type] Developer Documentation
bph
pushed a commit
to bph/gutenberg
that referenced
this pull request
Aug 31, 2024
…ts connection to the "filterBy" property (WordPress#64633) * better explanation of the elements property * Update packages/dataviews/README.md Co-authored-by: André <[email protected]> * Update packages/dataviews/README.md Co-authored-by: André <[email protected]> --------- Co-authored-by: André <[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.
What?
The connection between the
elementsandfilterByproperties for each item passed to thefieldsprop is not clear in the docs. This PR aims to clarify this in the docs.Why?
To use the Dataviews component outside of WordPress, the purpose of each property needs to be crystal clear in order to make the most of this component and alleviate pain points.
How?
This PR add to the docs the following clarifications:
elementspropertyelementsproperty - this is a bit confusing as one would expect to enable filters by a fields somehow through thefilterBypropertycc: @oandregal