Default checkbox field ignores ui:title and ui:description

[alexfiedler]

Prerequisites

• [x ] I have read the documentation;
• [ x] In the case of a bug report, I understand that providing a SSCCE example is tremendously useful to the maintainers.

Description

The default checkbox field for boolean forms does not respect the ui:title or ui:description fields making it difficult to overwrite.

Steps to Reproduce

1. Ignored UI values
   Given a schema of:

{
  "title": "Boolean Title",
  "description": "Boolean Description",
  "type": "boolean"
}

And a UI Schema of:

{
  "ui:title": "Overwrite Boolean Title",
  "ui:description": "Overwite Boolean Description"
}

Behavior

The form only displays the title from the description.

Expected behavior

It should display the ui:title and the ui:description as well.

2. Repeated title and description

Given a schema of:

{
  "title": "Boolean Title",
  "description": "Boolean Description",
  "type": "boolean"
}

And a UI Schema of:

{
  "ui:title": "Overwrite Boolean Title",
  "ui:description": "Overwite Boolean Description",
  "ui:widget": "checkbox"
}

Behavior

The form only displays the the title, the description, the ui title, the ui description and the title.

Expected behavior

It should display only the ui:title and the ui:description.

Version

1.0.0

[epicfaace]

Reproducible JSFiddle: https://jsfiddle.net/epicfaace/xh0uyLjn/

[CauchyAbel-zz]

This should not be hard to fix, I did encounter the same issue.

[epicfaace]

@CauchyAbel it's labeled "good first issue" for a reason -- would you like to fix it? 😉

[CauchyAbel-zz]

I would fix it during free time since I know this is a long live issue and not that critical, LOL

I did come across this myself so I knew :) Assign to me if you could :)

[cbuv]

this issue seems to be default behavior for rjsf default boolean field

In SchemaField.js: L273 - L275

  if (schema.type === "boolean" && !uiSchema["ui:widget"]) {
    displayLabel = false;
  }

I believe adding "ui:widget":"checkbox" to uiSchema solves this issue.

[siddharths00]

Building on the answer that @cbuv wrote, I believe that just adding "ui:widget":"checkbox" to uiSchema wouldn't be enough to solve the issue. However, something along the lines of the following might help us.

if (schema.type === "boolean" && uiSchema["ui:widget"]) {
    displayLabel = false;
  }

Notice that instead of !uiSchema["ui:widget"] we have uiSchema["ui:widget, which will not display the label from Schema if we have a uiSchema label to override it. Perhaps this is all we require.

[adefrutoscasado]

Im facing this problem. Is it solved yet? Any workaround?

[heath-freenome]

Wow, still an issue in 5.x, but it differs across the various themes. See this playground