rjsf-team/react-jsonschema-form

Feature Request: Ability to conditionally show non-required fields

Open

#2164 opened on Dec 10, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (13,175 stars) (2,136 forks)batch import
corefeaturehelp wanted

Description

Prerequisites

Description

In a schema with many required and optional fields, it would be handy to be able to conditionally only show required fields, especially if few users ever need them.

<Form
    requiredOnly={true}

Even better would be the ability to filter fields using an arbitrary function, for example:

<Form
    filter={field => field.isRequired && field.description.includes("test")}

But that might be going overboard. Thanks for considering!

Contributor guide

Tech stack
reacttypescript
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic ReactJSON Schema understandingFamiliarity with react jsonschema form API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by examining the Form component's rendering of fields in the source code, likely in src/index.js or similar. The current implementation likely iterates over schema properties. A `filter` prop could be added to conditionally include/exclude fields. Look at existing props like `uiSchema` and `formContext` for patterns. The issue suggests a simple boolean `requiredOnly` or a function filter. Implementation would involve filtering the list of fields before rendering. Check if any linked PRs or comments exist for guidance.