docs: operate: common props for UI widgets #832
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
* As part of inveniosoftware/react-invenio-forms#298, UI widgets are being given a standardised common set of props (on top of which each widget can have additional, more specific props) * This PR changes the reference docs for custom field widgets by splitting into the two distinct sections of "common props" and "widget-specific props"
carlinmack
approved these changes
Jul 18, 2025
fenekku
reviewed
Jul 18, 2025
There was a problem hiding this comment.
Looks good. Since we are preparing to release v13.0, I just want to make sure:
- this is only applicable if inveniosoftware/react-invenio-forms#298 gets merged
- and that's likely to happen only after v13.0 release, so we should hold on merging until that's finalized
- It seems like something nice to have for a v13.1 :)
* Made doc headings clearer for custom field widgets by only showing props that are additional to the common props for each widget
|
With respect to when to get this in: we are continuing the discussion with a couple of maintainers about how to arrange version releases and pins next week. So I guess we are still waiting to determine when that would all go in 😁 . We'll keep an eye on it and try to get things moving in a timely fashion though! |
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.
Closes inveniosoftware/react-invenio-forms#297
Description
As part of overridable: Implement for custom fields react-invenio-forms#298, UI widgets are being given a standardised common set of props (on top of which each widget can have additional, more specific props)
This PR changes the reference docs for custom field widgets by splitting into the two distinct sections of "common props" and "widget-specific props"
Some of the prop names have been updated to stay consistent with the names we use for the built-in deposit form fields (e.g.
description->helpText) so this has been reflected in the docs.