Json-schema-form boolean description not rendering

  1. My goal: Render the description for a boolean field when using json-schema-form
  2. Issue: The description of a boolean property is not rendering property. The same json pasted into react-jsonschema-form playground will render the description. This problem seems to only exist for boolean types.
  3. Steps I've taken to troubleshoot:
    1. Check the react-jsonschema-form library.
    2. Attempt other keys like “ui:help” instead of “description”
  4. Additional info:

JSON snippet

  "properties": {
    "show_property_details": {
      "type": "boolean",
      "name": "show_property_details",
      "description": "Whether or not to log property details for debugging purposes."
    }
  }

On Retool

On react-jsonschema-form playground

1 Like

Hey @Alicia_Tsai

I understand your issue you can use this json for your description issue

JSON Schema :
{
"type": "object",
"properties": {
"show_property_details": {
"type": "boolean",
"title": "Show Property Details"
}
}
}

UI Schema:
{
"show_property_details": {
"ui:options": {
"help": "Whether or not to log property details for debugging purposes."
}
}
}

It will show the description perfectly.

that worked thanks!

2 Likes