@rjsf/material-ui

@rjsf/material-ui

Material UI 4 theme, fields and widgets for react-jsonschema-form.
Explore the docs »

View Playground · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• Contact

About The Project

Exports material-ui version 4 theme, fields and widgets for react-jsonschema-form.

Built With

• react-jsonschema-form
• Material UI
• TypeScript

Getting Started

Prerequisites

• @material-ui/core >= 4.12.0 (in 4.12.0, the library developers made it forward compatible with Material-UI V5)
• @material-ui/icons >= 4.11.0 (in 4.11.0, the library developers made it forward compatible with Material-UI V5)
• @rjsf/core >= 5.0.0
• @rjsf/utils >= 5.0.0
• @rjsf/validator-ajv6 >= 5.0.0

yarn add @material-ui/core @material-ui/icons @rjsf/core @rjsf/utils @rjsf/validator-ajv6

Installation

yarn add @rjsf/material-ui

Usage

import Form from '@rjsf/material-ui';

or

import { withTheme } from '@rjsf/core';
import { Theme } from '@rjsf/material-ui';

// Make modifications to the theme with your own fields and widgets

const Form = withTheme(Theme);

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Read our contributors' guide to get started.

Contact

rjsf team: https://github.com/orgs/rjsf-team/people

GitHub repository: https://github.com/rjsf-team/react-jsonschema-form

Changelog

5.22.0

@rjsf/core

• Updated MultiSchemaField to call the onChange handler after setting the new option, fixing #3997 and #4314

@rjsf/utils

• Added experimental_customMergeAllOf option to retrieveSchema() and getDefaultFormState() to allow custom merging of allOf schemas
• Made fields with const property pre-filled and readonly, fixing #2600
• Added mergeDefaultsIntoFormData option to Experimental_DefaultFormStateBehavior type to control how to handle merging of defaults
• Updated mergeDefaultsWithFormData() to add new optional defaultSupercedesUndefined that when true uses the defaults rather than undefined formData, fixing #4322
• Updated getDefaultFormState() to pass true to mergeDefaultsWithFormData for defaultSupercedesUndefined when mergeDefaultsIntoFormData has the value useDefaultIfFormDataUndefined, fixing #4322
• Updated getClosestMatchingOption() to improve the scoring of sub-property objects that are provided over ones that aren't, fixing #3997 and #4314

Dev / docs / playground

• Updated the form-props.md to add documentation for the new experimental_customMergeAllOf props and the experimental_defaultFormStateBehavior.mergeDefaultsIntoFormData option
• Updated the utility-functions.md to add documentation for the new optional defaultSupercedesUndefined parameter and the two missing optional fields on getDefaultFormState()
• Updated the custom-templates.md to add a section header for wrapping BaseInputTemplate
• Updated the playground to add controls for the new mergeDefaultsIntoFormData option
  • In the process, moved the Show Error List component over one column, making it inline radio buttons rather than a select