rjsf-team/react-jsonschema-form

Description Property Not Shown in OneOf Dropdown Menu 🐛

Closed

#4,214 opened on Jun 10, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (2,136 forks)batch import
bughelp 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

Version

5.18.4

Current Behavior

When using the description property in a oneOf subSchema, it isn't rendered under the dropdown menu.

{
  "type": "object",
  "properties": {
    "plan": {
      "type": "string",
      "oneOf": [
        {
          "const": "vcluster",
          "title": "Virtual cluster plan",
          "description": "This is a virtual cluster plan."
        },
        {
          "const": "coab",
          "title": "Cloud-on-a-bench plan",
          "description": "This is a cloud-on-a-bench plan."
        },
        {
          "const": "kamaji",
          "title": "Kamaji plan",
          "description": "This is a Kamaji plan."
        }
      ]
    }
  }
}

image

Expected Behavior

We should see a text field under the dropdown selection menu that dynamically changes the description of the selected field, similar to how it works for objects :

{
  "type": "object",
  "oneOf": [
    {
      "title": "Small",
      "description": "Small plan",
      "type": "object"
    },
    {
      "title": "Big",
      "description": "Big plan",
      "type": "object"
    }
  ]
}

image

Steps To Reproduce

No response

Environment

- OS: Ubuntu 22
- Node: 20.11.1
- npm: 10.2.4

Anything else?

No response

Contributor guide