RadioButtons

Input element that allows the user to choose one of several options.

Usage

Radio buttons are often used in forms to collect input from the user where they need to choose only one of several options from a list.

Anatomy

Style

• Radio buttons should always have an associated label on the right side.

Best Practices

• List options in a logical order:
  • most likely to least likely to be selected
  • simplest to most complex operation
  • least to most risk
• Preselect one option. Choose the safest, most secure, and private option first. If safety and security are not important, choose the most likely or convenient option.
• If users should have the option to avoid making a selection, add a “None” (or equivalent) option.
• If you cannot have a list of all possible options, add an “Other” option.
• Avoid alphabetical sorting as it is language-dependent and not localizable.
• Avoid overlapping options. For example, Select age: 0-20, 20-40 — What do you choose if your age is 20?
• Include all relevant options. For example, Select age: Below 20, Above 20 — What do you choose if you are 20?

Content guidelines

• Keep labels short and descriptive.
• Start all labels with a capital letter.
• Do not include punctuation after labels.

Related

• For a more compact way to display multiple options with single selection, use Dropdown.
• If users can choose multiple options from a list, use Checkboxes.
• For a more compact way to display multiple options with multiple selection, use MultipleSelect.

Properties

The following is an autogenerated list of the properties available for RadioButtons based on the component’s JSON schema file (linked below).

JSON schema

Required properties: id,type

Configuration

Add component

{
  "$schema": "https://altinncdn.no/toolkits/altinn-app-frontend/4/schemas/json/layout/layout.schema.v1.json",
  {
    "data": {
      "layout": [
        {
          "id": "radio-buttons",
          "type": "RadioButtons"
        }
      ]
    }
  }
}

Text (textResourceBindings)

• Altinn Studio Designer
• Code

You can create a new text by clicking on the plus sign or select an existing one by clicking on the magnifying glass. See Adding and Editing Texts in an App for more information.

Text can be added directly as a text string or by providing the key to a [text resource].(/altinn-studio/reference/ux/texts/#add-and-change-texts-in-an-application).

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  "type": "Checkboxes",
  "textResourceBindings": {
          "title": "",
          "description": "",
          "help": "",
          "shortName": "",
          "tableTitle": ""
        }
}

Data Model

To store and manipulate the data collected by the component, the component must be linked to a field in a data model. The option values are stored as strings.

• Altinn Studio Designer
• Code

Select the field you want to link the component to from the dropdown menu. If there are no fields available, you must first upload a data model.

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "dataModelBindings": {
    "simpleBinding": "MyDataModel.SomeField"
    }
}

Adding Options

Options can be added manually or by using code lists.

Manually (options)

• Altinn Studio Designer
• Code

Select “Manuelt” and click “Legg til flere” to add a new option. Choose or create a new text to add a label (label).

The option comes with a pre-filled value (value), which is the data that is stored when the user makes a selection. The value is stored as a string and can be changed as you wish.

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "options": [
          {
            "label": "Alternativ 1",
            "value": "1"
          }
        ]
}

Code List (optionsId)

A code list is a predefined list of options.

• Altinn Studio Designer
• Code

To add options from a code list, select “Kodeliste” and enter a code list ID. To use a custom (dynamic) code list, click “Bytt til egendefinert kodeliste” (switch to custom code list).

If you wish to secure dynamic code lists, you can check this option:

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "optionsId": "land",
  "secure": true
}

Source (source)

One way to add options is by linking the component to a code list based on form data stored within the app itself. You can do this by adding a source (source); please refer to the documentation for instructions on how to configure this.

• Altinn Studio Designer
• Code

Settings in Altinn Studio.

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "source": {
    "group": "some.group",
    "label": "dropdown.label",
    "value": "some.group[{0}].someField",
    "description": "",
    "helpText": ""
  }
}
...

Documentation for code lists

• Link a Component to a Code List
• Static Code Lists
• Dynamic Code Lists
• Code lists based on repeating groups from the data model

Field is read-only (readOnly)

Disables the component when checked (true).

• Altinn Studio Designer
• Code

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "readOnly": true
}

Example read-only component

Required (required)

Field is required when enabled (true) and a star is shown after the heading.

• Altinn Studio Designer
• Code

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "required": false
}

Layout (layout)

Displays the alternatives in a column (column) (default for more than two options) or row (row) (default for up to two options).

• Altinn Studio Designer
• Code

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "layout": "row"
}

Show as card (showAsCards)

Displays each radio button on a light gray background when checked (true).

{
  "id": "komponent-id",
  ...
  "showAsCard": true
}

Preselected option (preselectedOptionsIndex)

Sets a preselected value. Options are zero-indexed, so the first option is 0, the second is 1, and so on.

• Altinn Studio Designer
• Code

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "preselectedOptionsIndex": 0
}

Summary (renderAsSummary)

Indicates whether the field should be included in a summary or not (default: false).

• Altinn Studio Designer
• Code

{
  "id": "komponent-id",
  ...
  "renderAsSummary": false
}

Hidden (hidden)

Indicates whether the field should be hidden or not (default: false).

• Altinn Studio Designer
• Code

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "hidden": false
}

Page Break (pageBreak)

Indicates whether a page break should be added before or after the component. Can be either: auto (default), always, or avoid.

• Altinn Studio Designer
• Code

App/ui/layouts/{page}.json

{
  "id": "komponent-id",
  ...
  "pageBreak": {
    "breakBefore": "auto",
    "breakAfter": "auto"
  }
}

Horizontal alignment with grid

The grid property controls horizontal alignment based on a 12-column layout. Items are allocated fractions of 12 which sets their width relative to the screen width. In the example below, we set the component’s width to 2/12 of the screen width for all screen sizes (from xs and up).

{
  "id": "komponent-id",
  ...
  "grid": {
      "xs": 2,
    }
}

You can also use grid to place items side by side.

See Components placed side by side (grid) for details and examples.