Skip to content

Latest commit

 

History

History
125 lines (95 loc) · 3.62 KB

README.md

File metadata and controls

125 lines (95 loc) · 3.62 KB
Raw

React JSON Schema Form with the DSFR

This is a wrapper around the react-jsonschema-form with the components from react-dsfr.

Important

For now, this is simply extracted code from catala-dsfr. Therefore, the API is not yet defined and and is likely to be not flexible enough for your use case.

If you want to use this library, please open an issue to discuss your needs!

👉 See a demo at : https://codegouvfr.github.io/rjsf-dsfr

Installation

yarn add @codegouvfr/rjsf-dsfr

Usage

For now, the API matches the one from react-jsonschema-form and you can overrides some widgets (resp. templates) by specifying them in the props.

import { RJSFSchema } from '@rjsf/utils'
import FormDSFR from '@codegouvfr/rjsf-dsfr'
import { customizeValidator } from '@rjsf/validator-ajv8'
import frenchLocalizer from 'ajv-i18n/localize/fr'

const validator = customizeValidator({}, frenchLocalizer)

const schema: RJSFSchema = {
  type: 'object',
  properties: {
    nom: { title: 'Nom', type: 'string', minLength: 2 },
    prenom: { title: 'Prénom', type: 'string' },
    ddn: { title: 'Date de naissance', type: 'string', format: 'date' },
  },
  required: ['nom'],
}

export default function Form() {
  return <FormDSFR schema={schema} validator={validator} />
}

Notes on writing schemas

Title

The titles must not be defined inside "kind" properties of the object definition but just before the "$ref" of the calling parent:

"categorieEquivalenceLoyerD84216": {
  "title": "Catégorie de personnes résidant en logement-foyer",
  "$ref": "#/definitions/categorie_equivalence_loyer_allocation_logement_foyer"
}

UI Options

As described in the react-jsonschema-form documentation, you can customize the form by providing a uiSchema. In addition to the standard options, you can use the following specific options for rjsf-dsfr.

Tip

You can have a look to a real world example here

Global field options

The following options can be set for any field in the uiSchema:

  • ui:heading: set the heading level for the field's title (available values: h2, h3, h4, h5, h6)
  • ui:hideTitle: hide the field's title.

Specific field options

Array fields

The following options can be set for fields of type array:

  • ui:addIcon: set the DSFR icon id for the Add button
  • ui:removeIcon: set the DSFR icon id for the Remove button
  • ui:tabLabel: set the label for the tab in the array field (it needs to be defined at the root of the array field)

Note

By default, array fields are displayed in a Tabs component. Each tab is labeled with the ui:tabLabel value and the last tab contains the Add button.

Important

The ui:hideTitle option it's needed for items of type object inside a field of type array to hide the unique title of the array's items.

Example:

"personnesACharge": {
   "ui:tabLabel": "Personne",
   "items": {
       "ui:hideTitle": true,
...

Development

Launch the playground to play with the DSFR theme :

cd demo
yarn
yarn start