rjsf-team/react-jsonschema-form

$ref Support for Database or Callback Integration

Open

#4406 opened on Dec 2, 2024

View on GitHub
 (2 comments) (2 reactions) (0 assignees)TypeScript (13,175 stars) (2,136 forks)batch import
featurehelp wanted

Description

Prerequisites

What theme are you using?

mui

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

My application is built with Supabase, and some of the enum fields need to be fetched dynamically from database tables. As far as I know, there isn't a straightforward or out-of-the-box solution for this. Based on my understanding of the documentation, the $ref expects to be linked to a property within the definition object.

If support for either callbacks or external sources (e.g., databases) could be added, it would significantly enhance the versatility, developer experience (DX), and overall ease of use of this library.

Describe the solution you'd like

A solution could include a new valueGetter property that supports an asynchronous function to fetch relevant data. The returned array/value from this function would automatically set the fetched data as the value/enum to be consumed and dynamically manage the loading state.

Describe alternatives you've considered

An inefficient workaround that requires writing a lot of code to iterate through fields, handle specific ones, and implement custom widgets. In other words, adding unnecessary complexity and excessive code just to achieve this very important feature that is needed for most modern applications.

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.
mostly clear
Prerequisites
ReactTypeScriptJSON Schema basicsreact jsonschema form basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the current $ref resolution logic in the react jsonschema form source code (e.g., src/utils.js or schema handling files). Investigate how the library processes enum/oneOf and how async data fetching could be integrated. Examine existing open issues or discussions about dynamic enums. Consider implementing a prototype for a 'valueGetter' prop that returns a Promise resolving to an array, and test with a simple database call. Engage with maintainers on the preferred approach and potential breaking changes.