rjsf-team/react-jsonschema-form

Enable checkbox widget for string field with const

Open

#3882 opened on Sep 27, 2023

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

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

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.
1-2 days
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
JSON Schema const keywordRJSF widget system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue requires modifying the checkbox widget to support string fields with a 'const' keyword. Check the existing CheckboxWidget in the core theme (likely in packages/core/src/widgets/CheckboxWidget.tsx) to see how it currently only handles boolean schema types. The fix should allow the widget to be used when the schema has type: 'string' and a const value, using the const as the checked value and removing the property when unchecked. Additionally, review the handling of 'const' in the form state management to ensure proper property removal.