rjsf-team/react-jsonschema-form

Allow to override schema order validation error behavior

Open

#4316 opened on Sep 26, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (13,175 stars) (2,136 forks)batch import
featurehelp wantedtemplates

Description

Prerequisites

What theme are you using?

material-ui

Is your feature request related to a problem? Please describe.

I am using react-jsonschema-form (RJSF) in a web application where schemas are dynamically received from the server. These schemas are user-defined and, in some cases, may be incomplete or invalid.

Specifically, when the order field in the schema is incomplete or missing a property, the application renders a hardcoded HTML error that cannot be customized or controlled.

Upon reviewing the code, it appears that a static element is rendered in such cases, preventing any control over the error handling, customization of the error message, or modifying the template. This issue seems to originate from the following code:

https://github.com/rjsf-team/react-jsonschema-form/blob/main/packages/core/src/components/fields/ObjectField.tsx#L263

Here is an example of the UI that is generated in such scenarios: image

Would it be possible to provide a way to handle or customize this error, such as an option to override the default behavior or allow for custom error templates?

Describe the solution you'd like

There are several potential solutions that would provide more control over schema validation errors:

  • Allow for a customizable template for schema validation errors, similar to how other TemplateTypes are handled.
  • Introduce a schema validation error handler (similar to the onError handler) that enables developers to handle these errors gracefully.
  • Provide a way to catch and manage the error programmatically, allowing for custom error handling logic.

The key requirement is gaining the ability to control or customize the behavior when these validation errors occur.

Describe alternatives you've considered

Currently, I am manually validating the order field before passing the schema to RJSF and handling any errors as needed.

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
feature
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
Familiarity with ReactUnderstanding of JSON SchemaKnowledge of RJSF template system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue is about customizing error behavior when schema order validation fails. The relevant code is in packages/core/src/components/fields/ObjectField.tsx around line 263 where a static <div> is rendered. The suggested solutions include creating a new template type for schema validation errors or adding an error handler similar to onError. To implement, one could start by examining the existing template types and how they are registered, then add a new template or modify the ObjectField to accept a custom error component. The maintainers have not yet provided feedback, so the implementer should propose a design in the issue first.