Description Property Not Shown in OneOf Dropdown Menu 🐛

Guilamb commented 5 months ago

Prerequisites

[X] I have searched the existing issues
[X] I understand that providing a SSCCE example is tremendously useful to the maintainers.
[X] I have read the documentation
[X] Ideally, I'm providing a sample JSFiddle, Codesandbox.io or preferably a shared playground link demonstrating the issue.

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."
        }
      ]
    }
  }
}

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"
    }
  ]
}

Steps To Reproduce

No response

Environment

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

Anything else?

No response

heath-freenome commented 5 months ago

@Guilamb Interesting use case. After digging into the code, it seems like we need to update ALL of the SelectWidget implementations to detect whether the select enumOption has its optional schema prop provided with the optional description prop provided, then we'll need to render a DescriptionTemplate with the description in it. Not an easy bit of work, but doable. Is this something you feel interested in implementing?

Guilamb commented 4 months ago

@heath-freenome Thank you for considering my issue. Unfortunately, I don't have the necessary skills and time to contribute to the development of this feature 😞 . However, I hope that my issue can be helpful to someone else who may be interested in implementing it.

Also maybe there is a workaround, can you think of a way to display description associated to constrained one-of-like value in a string type ?

heath-freenome commented 4 months ago

@Guilamb You could create a custom field for dealing with one-ofs. If you need more information about how to do that see the following documentation:

rjsf-team / react-jsonschema-form