Add tiny piece of documentation around the relation component structure #15223
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
gu-stav
added
source: core:content-manager
joshuaellis
requested changes
Dec 20, 2022
gu-stav
force-pushed
the
chore/cm-relations-docs-components
branch
from
31fd4c6
to
6e6d6cc
Compare
gu-stav
commented
Jan 18, 2023
| endpoint: string; // URL from where existing relations should be fetched | ||
| enabled: boolean; // defines whether relations should be fetched once the hook is called | ||
| pageParams: object; // additional query params which will be appended to `endpoint` | ||
| onLoad: ({ target: { name: string, value: RelationResults }}):void => {}; |
There was a problem hiding this comment.
@joshuaellis Can you help me here to properly express the type? 😨
Co-authored-by: Josh Ellis <josh.ellis@strapi.io>
joshuaellis
approved these changes
Jan 18, 2023
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 does it do?
Adds a few words of documentation about how and why the components for relations are structured the way they are.
Why is it needed?
Completes documentation.
Related issue(s)/PR(s)
https://strapi-inc.atlassian.net/browse/CONTENT-661