Texts

The different text properties that can be used for options

Label

The most common text property for options is the label. The label is the text that is displayed to the user in the UI (in contrast to the value, which is the value stored in the data model). Both label and value are required properties for an option.

[
  { "value": "norway", "label": "Norge" },
  { "value": "denmark", "label": "text.key.for.denmark" }
]

Labels, as with all texts, can either be plain text or a key pointing to a text resource. If the label is a key pointing to a text resource, the text can change according to the selected language.

The final text displayed to the user can also be stored in the data model if needed.

Description and help text

If you need to provide additional information about an option, you can use the description and helpText properties. description and helpText can be displayed by the components RadioButtons and Checkboxes.

Descriptions and help texts can be provided to options in the same way that a label is provided, via static, dynamic and options from the data model.

Click on the headers below to expand the examples.

[
  {
    "value": "norway",
    "label": "Norge",
    "description": "This is a description",
    "helpText": "This is a help text"
  },
  {
    "value": "denmark",
    "label": "Danmark"
  }
]

var options = new AppOptions
{
  Options = new List<AppOption>
  {
    new AppOption
    {
      Label = "Ole",
      Value = "1",
      Description = "This is a description",
      HelpText  = "This is a help text"
    },
    new AppOption
    {
      Label = "Dole",
      Value = "2"
    }
  }
};

{
  "id": "checkboxes-component-id",
  "type": "Checkboxes",
  ...
  "source": {
    "group": "some.group",
    "label": "checkboxes.label",
    "description": "checkboxes.description",
    "helpText": [
      "if", ["equals", ["dataModel.someField"], "someValue"],
        "checkboxes.helpText1",
      "else",
        "checkboxes.helpText2"
    ],
    "value": "some.group[{0}].someField"
  }
}