Skip to content
Snippets Groups Projects
Commit cfa2b4a5 authored by Dorine Lambinet's avatar Dorine Lambinet
Browse files

Ajoute doc concernant l'ajout de paramètre

parent 45bd24fa
No related branches found
No related tags found
1 merge request!213Ajoute doc rapide pour expliquer comment ajouter une variable dans l'appli
Pipeline #13606 passed
......@@ -142,3 +142,68 @@ getCalculatedVariableNumberValue(
```
Utiliser le composant `ValueChange` pour afficher le montant.
### Ajouter la valeur d'un paramètre dans l'UI
Exemple ici avec l'ajout du paramètre smic mensuel `marche_travail.salaire_minimum.smic.smic_b_mensuel` dans le `TestCaseSummary.svelte`. L'objectif était d'afficher l'équivalent du revenu du cas type en nombre de smic. Il était donc nécessaire d'importer la dernière valeur du paramètre dans l'UI.
1. Dans le fichier visé, ici `TestCaseSummary.svelte`, ajouter :
```shell
$: parameterSmicMensuel = getParameter(
rootParameter,
"marche_travail.salaire_minimum.smic.smic_b_mensuel",
) as ValueParameter
## On utilise la fonction getParameter pour aller chercher le paramètre dans openfisca. À la fin on précise as ValueParameter si c'est un paramètre value, ou as ScaleParameter si c'est un barème. Attention il faut importer ValueParameter (import type { ValueParameter} from from "@openfisca/json-model")
$: smicInstantValueCouplesArray = Object.entries(
parameterSmicMensuel?.values ?? [],
).sort(([instant1], [instant2]) => instant2.localeCompare(instant1))
## Ici, comme le paramètre a plusieurs valeurs dans le temps, on lui dit de trier les valeurs par date décroissante.
$: smicLatestInstantValueCouple = smicInstantValueCouplesArray[0]
## Ici, on lui demande donc de prendre le premier couple (date,valeur) de ce tableau.
$: smicValue = smicLatestInstantValueCouple?.[1] as NumberValue
## Enfin ici, on lui dit de prendre la valeur, c'est à dire le deuxième élément du tableau. Attention il faut importer NumberValue (import type { NumberValue} from from "@openfisca/json-model")
```
2- Il ne faut pas oublier de faire les imports et les déclarations pour que ces fonctions puissent s'effectuer :
```shell
import type {
...
NumberValue,
ValueAtInstant,
ValueParameter,
} from "@openfisca/json-model"
import {
...
getParameter,
rootParameter,
} from "$lib/parameters"
let smicInstantValueCouplesArray: [string, ValueAtInstant][]
```
3- Appeler le paramètre dans le fichier :
```shell
<div>
{smicValue.value}
## Ne pas oublier d'ajouter .value pour bien dire qu'on veut la valeur et non la date.
</div>
```
Pour s'aider, on peut afficher la valeur dans la console :
```shell
$: console.log(parameterSmicMensuel, smicValue)
```
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment