fix: prevent duplicate checkbox description rendering across themes #4825

Suyog241005 · 2025-10-31T07:50:41Z

Reasons for making this change

This PR fixes issue #4742, where checkbox widgets rendered duplicate labels or descriptions across multiple themes (such as AntD, Chakra UI, MUI, and others).
The duplication occurred because both the FieldTemplate and the CheckboxWidget components were responsible for rendering labels and descriptions.

This change ensures that checkbox widgets render their description only once and that FieldTemplate skips redundant rendering for checkbox types.
It improves consistency across themes and avoids confusing duplicate text for users.

Fixes #4742

Checklist

I'm updating documentation
- I've checked the rendering of the Markdown text I've added
I'm adding or updating code
- I've added and/or updated tests. I've run npx nx run-many --target=build --exclude=@rjsf/docs && npm run test:update to update snapshots, if needed.
- I've updated docs if needed
- I've updated the changelog with a description of the PR
I'm adding a new feature
- I've updated the playground with an example use of the feature

Suyog241005 · 2025-10-31T07:54:57Z

Hi @heath-freenome ,
I’ve opened this PR to fix the duplicated description and label rendering in checkbox widgets across all themes.
I’ve verified the fix in the playground and updated the changelog accordingly.
Please review when you have a chance.
Thanks!

packages/core/src/components/widgets/CheckboxWidget.tsx

heath-freenome · 2025-10-31T16:18:45Z

packages/mantine/src/widgets/CheckboxWidget.tsx

        onFocus={handleFocus}
        error={rawErrors && rawErrors.length > 0 ? rawErrors.join('\n') : undefined}
        aria-describedby={ariaDescribedByIds(id)}
-        {...themeProps}


How does this fix the issue with mantine?

packages/mui/src/FieldTemplate/FieldTemplate.tsx

packages/primereact/src/FieldTemplate/FieldTemplate.tsx

heath-freenome · 2025-10-31T16:29:50Z

@Suyog241005 Your tests are failing... Make sure to run the following commands on your branch:

npm install
npm run build
npm run test:update

Suyog241005 · 2025-10-31T16:44:51Z

Hi @heath-freenome ,
I’ve run the following on my local branch:

npm install
npm run build
npm run test:update

All tests are passing on my end.

It’s possible that the CI cache or environment mismatch is causing the failure.
Could you please re-run the CI jobs to confirm?

heath-freenome · 2025-10-31T23:37:36Z

CHANGELOG.md

 should change the heading of the (upcoming) version to include a major version bump.

 -->
 # 6.0.0


Suggested change

# 6.0.0

# 6.0.2

I need you to move all of these changes in the CHANGELOG.md under the 6.0.2 section ABOVE the 6.0.1 section... With only your additions to the sections you have right now. and order the themes alphabetically

heath-freenome · 2025-10-31T23:41:27Z

@Suyog241005 you'll need to rebase anyway, which will cause your tests to run again... After the rebase do again what I suggested, since the package.json changed recently. You may generate new snapshots.

Suyog241005 · 2025-11-01T05:34:36Z

@heath-freenome I’ve rebased, resolved conflicts, and all required checks have passed. Please review it when you get the chance.

heath-freenome · 2025-11-01T05:45:07Z

@heath-freenome I’ve rebased, resolved conflicts, and all required checks have passed. Please review it when you get the chance.

Can you address the feedback I've left as well. Especially the CHANGELOG.md

…jsf-team#4742)

Suyog241005 · 2025-11-01T05:56:10Z

@heath-freenome , I have updated CHANGELOG.md — moved all entries under the 6.0.2 section above 6.0.1 as requested.

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

heath-freenome · 2025-11-01T15:55:25Z

@Suyog241005 one last thing, can you update the formTests.tsx in the snapshot-tests package to add tests with a checkbox having description. You can use the same schema/uiSchema you highlighted in your screen capture. Also, add tests with the same schema, with the uiSchema having radio and then select widgets. That way we can verify the fix continues to work in the future

…criptions

Suyog241005 · 2025-11-01T17:58:44Z

Hi @heath-freenome , I have added the requested snapshot tests for checkbox with description, radio, and select widgets in formTests.tsx.
Please review when you get a chance and let me know if anything else needs adjustment.

packages/snapshot-tests/src/formTests.tsx

heath-freenome · 2025-11-01T23:32:46Z

@Suyog241005 One small set of changes to the tests, a rebase and then I will approve/merge

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

Suyog241005 · 2025-11-02T04:27:19Z

@heath-freenome I've made the requested test changes, updated all snapshots, and I've also done a git rebase to ensure everything is in sync. The PR is ready for your review.

Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 5 to 6. - [Release notes](https://github.com/actions/download-artifact/releases) - [Commits](actions/download-artifact@v5...v6) --- updated-dependencies: - dependency-name: actions/download-artifact dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3 to 4. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@v3...v4) --- updated-dependencies: - dependency-name: github/codeql-action dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4 to 5. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@v4...v5) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [actions/setup-node](https://github.com/actions/setup-node) from 5 to 6. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@v5...v6) --- updated-dependencies: - dependency-name: actions/setup-node dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [mocha](https://github.com/mochajs/mocha) from 10.8.2 to 11.7.4. - [Release notes](https://github.com/mochajs/mocha/releases) - [Changelog](https://github.com/mochajs/mocha/blob/main/CHANGELOG.md) - [Commits](mochajs/mocha@v10.8.2...v11.7.4) --- updated-dependencies: - dependency-name: mocha dependency-version: 11.7.4 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

heath-freenome reviewed Oct 31, 2025

View reviewed changes

Suyog241005 force-pushed the fix/4742-checkbox-label-duplication branch from a5eedb7 to 0581174 Compare November 1, 2025 02:57

fix: prevent duplicate checkbox description rendering across themes (r…

3bb4c67

…jsf-team#4742)

Suyog241005 force-pushed the fix/4742-checkbox-label-duplication branch from 0581174 to 3bb4c67 Compare November 1, 2025 05:54

Suyog241005 and others added 2 commits November 1, 2025 16:07

Update packages/core/src/components/widgets/CheckboxWidget.tsx

44e96b1

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

Update packages/mui/src/FieldTemplate/FieldTemplate.tsx

974781a

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

test: add test cases for checkbox, radio, and select widgets with des…

3d85648

…criptions

heath-freenome reviewed Nov 1, 2025

View reviewed changes

packages/snapshot-tests/src/formTests.tsx Outdated Show resolved Hide resolved

packages/snapshot-tests/src/formTests.tsx Outdated Show resolved Hide resolved

packages/snapshot-tests/src/formTests.tsx Outdated Show resolved Hide resolved

Suyog241005 and others added 4 commits November 2, 2025 09:45

Update packages/snapshot-tests/src/formTests.tsx

d5531a1

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

Update packages/snapshot-tests/src/formTests.tsx

64faa8d

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

Update packages/snapshot-tests/src/formTests.tsx

31b0bd2

Co-authored-by: Heath C <51679588+heath-freenome@users.noreply.github.com>

Update test snapshots

8d45ac4

dependabot bot and others added 5 commits November 2, 2025 10:44

Suyog241005 force-pushed the fix/4742-checkbox-label-duplication branch from 0a422ea to 6f243ee Compare November 2, 2025 05:16

Merge branch 'main' into fix/4742-checkbox-label-duplication

afa5ec2

heath-freenome approved these changes Nov 2, 2025

View reviewed changes

heath-freenome merged commit 61860ad into rjsf-team:main Nov 2, 2025
4 checks passed

Suyog241005 deleted the fix/4742-checkbox-label-duplication branch November 2, 2025 09:04

fix: prevent duplicate checkbox description rendering across themes #4825

fix: prevent duplicate checkbox description rendering across themes #4825

Uh oh!

Conversation

Suyog241005 commented Oct 31, 2025

Reasons for making this change

Checklist

Uh oh!

Suyog241005 commented Oct 31, 2025

Uh oh!

Uh oh!

heath-freenome Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

heath-freenome commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Suyog241005 commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

heath-freenome Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

heath-freenome Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

heath-freenome commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Suyog241005 commented Nov 1, 2025

Uh oh!

heath-freenome commented Nov 1, 2025

Uh oh!

Suyog241005 commented Nov 1, 2025

Uh oh!

heath-freenome commented Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Suyog241005 commented Nov 1, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

heath-freenome commented Nov 1, 2025

Uh oh!

Suyog241005 commented Nov 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

heath-freenome commented Oct 31, 2025 •

edited

Loading

Suyog241005 commented Oct 31, 2025 •

edited

Loading

heath-freenome Nov 1, 2025 •

edited

Loading

heath-freenome commented Oct 31, 2025 •

edited

Loading

heath-freenome commented Nov 1, 2025 •

edited

Loading