rjsf-team/react-jsonschema-form

Allow wildcards for path specification in uiSchema

Open

#3941 opened on Nov 8, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (13,175 stars) (2,136 forks)batch import
featurehelp wanteduiSchema

Description

Prerequisites

What theme are you using?

mui

Is your feature request related to a problem? Please describe.

I autogenerate large schemas, which may be nested. For these, I need to customize the uiSchema, let's say for all properties with a specific key. Currently the uiSchema would look for example like this:

{
  "nested-1": {
    "items": {
      "someArray": {
        "ui:widget": "checkboxes"
      }
    }
  },
  "nested-2": {
    "items": {
      "someArray": {
        "ui:widget": "checkboxes"
      }
    }
  },
  "deeply-nested": {
    "items": {
      "deeply-nested-inside": {
        "items": {
          "someArray": {
            "ui:widget": "checkboxes"
          }
        }
      }
    }
  },
  "someArray": {
    "ui:widget": "checkboxes"
  }
}

Describe the solution you'd like

It would help readability a lot if I could simply tell the uiSchema: "Apply this ui option to all elements matching some rule." Maybe something like this:

{
  "#/someArray": {
    "ui:widget": "checkboxes"
  }
}

Or some other wildcard mechanism...

Describe alternatives you've considered

Using an external JSON parser might be able to generate the original uiSchema, but the result would still be very verbose and hard to modify after creation.

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
basic understanding of JSON Schemafamiliarity with react jsonschema form
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue requests wildcard support in uiSchema path specification. Start by examining the current uiSchema processing logic in the codebase, likely in files under `src/` such as `utils.js` or `SchemaField.js`. Look for how paths are resolved and applied to form fields. The proposed syntax uses '#' as a wildcard prefix; consider implementing a path matching function that interprets '#' as a placeholder for any property name. Review existing tests in `test/` to understand expected behavior. There are no linked PRs or comments from maintainers, so the implementation approach is open. Focus on a minimal, backward compatible implementation that allows wildcards only for property names, not array indices, and document it clearly.