rjsf-team/react-jsonschema-form

Does not remove empty objects on clearing input field value ending up with unexpected required value error

Open

#4483 opened on Feb 5, 2025

View on GitHub
 (2 comments) (1 reaction) (0 assignees)TypeScript (13,175 stars) (2,136 forks)batch import
bughelp wanted

Description

Prerequisites

What theme are you using?

material-ui

Version

5.21.1

Current Behavior

When a required field is not modified yet, it submits fine. When a required field is modified, it validates correctly prompting me to fill out the required field. If I then delete all values, it prompts me to fill out the required field even if all values has been cleared.

Expected Behavior

It should submit the form without errors when all values has been removed

Steps To Reproduce

  1. In this playground enviornment
  2. Start by submitting the form without entering any values (should submit without errors)
  3. Add a value to second-test > testProp1 (should error about missing required testProp2)
  4. Add testProp2 (should submit without errors)
  5. Remove values for both testProp1 and testProp2 (should submit without errors but does not and show error about missing required testProp2)

This seems to be because of the empty object that never gets cleaned up when all values are deleted.

Environment

Anything else?

Note that Disable HTML 5 validation option must be selected.

Contributor guide

Tech stack
reacttypescriptnodejs
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic React knowledgeunderstanding of JSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the form state management in the library, specifically how `formData` is updated when input fields are cleared. Look at the `onChange` handler and how it handles nested objects. The issue occurs because clearing all fields in a nested object leaves an empty object, causing validation errors for required fields. Investigate the `ui:emptyValue` setting and the `experimental defaultFormStateBehavior` option. The playground link in the issue reproduces the bug. Check the source code for `utils.js` or `index.js` that processes form data updates. The fix likely involves removing empty objects from formData when all their fields are cleared.