fix: Reimplement #2537 so that ui:label is respected for array description and title
#3191
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
…rray description and title Fix rjsf-team#2535 by reimplementing rjsf-team#2537. Also fixes rjsf-team#3176 by passing uiSchema and schema to the description and title templates. - In `@rjsf/utils`, updated the props for the description and title templates to add `schema` - Also made the `title` and `description` for the array field description and title props as optional - In all of the themes, ensured that the `schema` is now passed to the all the calls to the description and title templates - With the exception of the `antd` theme, removed the logic for conditionally rendering the `ArrayFieldDescriptionTemplate` since that template already handles the condition - Deleted the tests for `DescriptionField` and `TitleField` in the `bootstrap-4` theme because they broke, and are redundant anyway given the other tests - In `@rjsf/core`, updated the `ArrayFieldDescriptionTemplate` and `ArrayFieldTitleTemplate` to not render the template when `ui:label` is false - Updated the tests to verify this change - Updated the `custom-templates.md` file to document the new `schema` prop and add the `uiSchema` prop docs where missing - Updated the `contributing.md` file to improve developer documentation - Updated the `CHANGELOG.md` file accordingly
heath-freenome
force-pushed
the
reimplement-2537-to-fix-2535
branch
from
a2471c0
to
dff185f
Compare
nickgros
approved these changes
Oct 10, 2022
| @@ -12,13 +12,24 @@ npm start | |||
|
|
|||
| All packages will be live-built, and a live development server showcasing components with hot reload enabled will then run at [localhost:8080](http://localhost:8080). | |||
|
|
|||
| ### First time step | |||
|
|
|||
| If this is the first time you have cloned the repo, run the `npm run prepare` script that will set up `husky` to provide a git precommit hook that will format and lint any code you have added to a PR. | |||
There was a problem hiding this comment.
prepare should automatically run after install but I guess it doesn't hurt to have this
There was a problem hiding this comment.
It doesn't seem to in the lerna world 🤷🏼
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.
Reasons for making this change
Fix #2535 by reimplementing #2537. Also fixes #3176 by passing uiSchema and schema to the description and title templates.
@rjsf/utils, updated the props for the description and title templates to addschematitleanddescriptionfor the array field description and title props as optionalschemais now passed to the all the calls to the description and title templatesantdtheme, removed the logic for conditionally rendering theArrayFieldDescriptionTemplatesince that template already handles the conditionDescriptionFieldandTitleFieldin thebootstrap-4theme because they broke, and are redundant anyway given the other tests@rjsf/core, updated theArrayFieldDescriptionTemplateandArrayFieldTitleTemplateto not render the template whenui:labelis falsecustom-templates.mdfile to document the newschemaprop and add theuiSchemaprop docs where missingcontributing.mdfile to improve developer documentationCHANGELOG.mdfile accordinglyChecklist
npm run test:updateto update snapshots, if needed.