rjsf-team/react-jsonschema-form

Enable checkbox widget for string field with const

Open

#3,882 opened on Sep 27, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (2,136 forks)batch import
corefeaturehelp wanted

Repository metrics

Stars
 (13,175 stars)
PR merge metrics
 (Avg merge 3d 17h) (32 merged PRs in 30d)

Description

Prerequisites

What theme are you using?

core

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

Consider the schema bellow :

{ "title": "Confirmation", "description": "Please to confirm this value is foo", "type": "string", "const": "foo" }

My expectation is to render this schema as a checkbox (two states : value is "foo" = checked or value is empty = not checked), but that behavior is not allowed in UI schema in accordance with the doc.

Describe the solution you'd like

String field with const constraint should be able to be render as checkbox :

  • Value attribute should be set as const constraint
  • If checked, model should be updated based on value attribute
  • If not, property is removed from the model

Describe alternatives you've considered

No response

Contributor guide

Research direction
Investigate how RJSF maps JSON Schema types to widgets, specifically focusing on the handling of 'const' keyword for string fields. Look at existing widget selection logic in src/utils.js/schemaUtils.js to add support for checkbox when a string schema has a const. Modify the widget mapping to allow 'CheckboxWidget' for strings with const and ensure the model updates properly (checked > const value, unchecked > remove property). Test with the given schema example.
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReactTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65