Configure help texts
Help developer configure help texts for components
Help texts are small text snippets that provide a brief explaination of what the users are supposed to fill in to the fields that they describe.
The language-keys that point to the help text is defined in the form layout json file.
In your repo under the folder App/ui
there is a FormLayout.json
-file. The contents might be:
{
"data": {
"layout": [
{
"id": "616071dc-90b1-4ce5-8d18-492844828a41",
"type": "Header",
"componentType": 0,
"textResourceBindings": {
"title": "appName"
},
"dataModelBindings": {}
},
{
"id": "fac3c047-efe1-49da-8189-da7c536a4edd",
"type": "Input",
"componentType": 2,
"textResourceBindings": {
"title": "21771.RapporteringsenhetNavndatadef21771.Label",
"description": "21771.RapporteringsenhetNavndatadef21771.Label"
},
"dataModelBindings": {
"simpleBinding": "generellInformasjongrp2581.avgiftspliktiggrp50.rapporteringsenhetNavndatadef21771.value"
},
"required": true,
"readOnly": false
},
{
"id": "08d707a9-2475-4d23-bf76-f209fb434ec2",
"type": "TextArea",
"componentType": 7,
"textResourceBindings": {
"title": "19684.OmsetningsoppgaverTilleggsopplysningerdatadef19684.Label",
"description": "19684.OmsetningsoppgaverTilleggsopplysningerdatadef19684.Label",
},
"dataModelBindings": {
"simpleBinding": "avgiftspostergrp2577.posteneIOppgavengrp5639.tilleggsopplysningergrp197.omsetningsoppgaverTilleggsopplysningerdatadef19684.value"
},
"required": false,
"readOnly": false
},
{
"id": "bd6589b6-e2ab-49ba-b39a-dd3f8b63e5de",
"type": "Button",
"componentType": 9,
"textResourceBindings": {
"title": "Send inn"
},
"dataModelBindings": {},
"textResourceId": "Standard.Button.Button",
"customType": "Standard"
}
]
}
}
If you would like one of these components to have a help text you will need to
- Insert a key into text resources, under the tab “Language”
- Remember to fill out all the fields, it will not let you save if you have fields that are empty.
- Open the
FormLayout.json
-file - Insert a new text resource binding with the key “help” and the value to be the name of the Language resource.
Example of how it looks after adding help text:
{
"data": {
"layout": [
{
"id": "616071dc-90b1-4ce5-8d18-492844828a41",
"type": "Header",
"componentType": 0,
"textResourceBindings": {
"title": "appName"
},
"dataModelBindings": {}
},
{
"id": "fac3c047-efe1-49da-8189-da7c536a4edd",
"type": "Input",
"componentType": 2,
"textResourceBindings": {
"title": "21771.RapporteringsenhetNavndatadef21771.Label",
"description": "21771.RapporteringsenhetNavndatadef21771.Label"
},
"dataModelBindings": {
"simpleBinding": "generellInformasjongrp2581.avgiftspliktiggrp50.rapporteringsenhetNavndatadef21771.value"
},
"required": true,
"readOnly": false
},
{
"id": "08d707a9-2475-4d23-bf76-f209fb434ec2",
"type": "TextArea",
"componentType": 7,
"textResourceBindings": {
"title": "19684.OmsetningsoppgaverTilleggsopplysningerdatadef19684.Label",
"description": "19684.OmsetningsoppgaverTilleggsopplysningerdatadef19684.Label",
"help": "Skjema.TilleggsOpplysninger.Hjelpetext"
},
"dataModelBindings": {
"simpleBinding": "avgiftspostergrp2577.posteneIOppgavengrp5639.tilleggsopplysningergrp197.omsetningsoppgaverTilleggsopplysningerdatadef19684.value"
},
"required": false,
"readOnly": false
},
{
"id": "bd6589b6-e2ab-49ba-b39a-dd3f8b63e5de",
"type": "Button",
"componentType": 9,
"textResourceBindings": {
"title": "Send inn"
},
"dataModelBindings": {},
"textResourceId": "Standard.Button.Button",
"customType": "Standard"
}
]
}
}