catala-web-assets

catala-web-assets

Table of contents

• To use
  • In local dev
• Websites using this assets
• Note on the redaction of schemas
  • Title
  • Dsfr dedicated UI options
    • ui:tabLabel and ui:hideTitle

---

Web assets generated from Catala programs about the French law:

• The housing benefits
• The family benefits

To use

Add the package to your project:

yarn add catala-web-assets

Import the wanted file from the assets folder:

require("catala-web-assets/assets/<file_name>")

In local dev

In order to test and update the assets without having to publish a new package version you can:

# In this repo
yarn link

# In the website repo
yarn link catala-web-assets

Websites using this assets

• https://catala-lang.org (source)
• catala-explorer (source)

Note on the redaction of 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"
}

Dsfr dedicated UI options

To be used with the Dsfr, there dedicated options for the UI schemas:

ui:tabLabel and ui:hideTitle

ui:hideTitle is needed to be specified for item of type object inside a item of type array to hide the unique title of the array's items.

ui:hideTitle allows to defines tab's label. It needs to be specified at the root of the item of type array.

Example:

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