choice-field

The choice-field component allows you to select one or more options from a predefined list. This enhances user experience by providing a straightforward way to make selections, such as choosing a setting, selecting a category, or picking an item from a list. Implementing a choice-field component involves defining the available options and efficiently handling the user's selection.

Benefit: Using the choice-field component over the checkbox component eliminates the need to use numerous checkboxes and complex expressions to achieve the same outcome.

The choice-field component can be used independently or within a form component, each offering distinct benefits. As a standalone, it provides flexibility for isolated usage without requiring a form structure. When wrapped in a form, it leverages the form’s instanceId, enabling better coordination and usability when managing multiple fields in a jig.

Configuration options

Some properties are common to all components, see Common component properties for a list and their configuration options.

Core structure for choice-field

instanceId

The unique identifier for the choice-field component.

label

Provide a label/name for the choice-field.

data

Use an expression that evaluates to an array of options.

item

The item property uses the component of choice-field-item that includes: title and value.

Other options

errorText

Add text, string, or expressions to show text under the choice-field indicating an error/invalid value in the field. Text is shown in isNegative (red) styling.

helperText

Add text, string, or expressions to guide users by showing text under the choice-field. Helper text is displayed only when there is no errorText.

initialValue

The initialValue is the value that will be displayed in the choice-field when the form is initially loaded. You can use this property to preset the choice-field with a default value so that you do not have to manually select it, for example, on a yes/no choice the initial value can be set to no.

isHidden

If true the choice-field will be hidden on the form. If set to false the field will be shown.

isIgnored

When true, the field will be ignored when submitting the form and the content will not be stored.

isMultiple

Set to true allows you to select multiple items inside the choice-field. Set to false only allows a single selection in the choice-field.

isOptionalLabelHidden

If the field is optional you can turn off the "(optional)" label by setting this field to true. This property works in combination with isRequired: false.

isRequired

Set to true when the field is required. Useful when you use it in form submission. Set to false the choice-field is optional and will have (optional) in the label.

itemsPerRow

Number of choice boxes to show in each row. Supports multiline text.

nextProperty

Name of the property you want to focus next in the form when you use return/next on a keyboard.

style

isDisabled - disables the choice-field preventing the selection of any of the choice-fields.

value

The value that the choice-field will output as its state.

Other options for choice-field-item

instanceId

The unique identifier for the choice-field-item component.

title

Text displayed on the choice-field item. You can add text, expressions or Text with Format in the field. Text with format includes, currency, decimal, dateTime and more. In most instances an expression similar to [email protected] is used to reference the datasource.

value

The value of the item. It has to be unique for each item and is usually the ID of the record from the datasource.

Actions

onChange

The action is triggered when the content in the choice-field-item is changed. Use IntelliSense (ctrl+space) to see the list of available actions.

State Configuration

Key

Notes

[email protected].

selected value

State is the variable of the component.

[email protected].

activeItemId now

Global state variable that can be used throughout the solution.

Considerations

The choice-field component can only be used in a form component on a default jig.
The choice-field is an input control.
Only text can be displayed in the title property.
Using itemPerRow for long text is not recommended due to the limited space available in each item and the need for visual consistency among the choices. The property supports up to two lines of text per item.

Examples and code snippets

Choice-field with single selection

In this example, a choice-field component is configured with basic Yes/No options. If you a new customer and select Yes, then a when property is used with an expression to display additional form fields for the customer to complete. If you an existing customer, select No and click the Register & place *order *button to goTo the product-item jig to place an order.

Examples: See the full example in GitHub.

choice-field-single.jigx

title: Basic Choice 
description: New customer
type: jig.default

header:
  type: component.jig-header
  options:
    height: small
    children:
      type: component.image
      options:
        source:
          uri: https://images.unsplash.com/photo-1472851294608-062f824d29cc?w=500&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8NHx8c2hvcG9ubGluZSUyMHN0b3JlfGVufDB8fDB8fHww
datasources:
 select-option:
    type: datasource.static
    options:
      data:
        - id: 1
          option: Yes
        - id: 2
          option: No         
          
children:
  - type: component.form
    instanceId: inputValues
    options:
    isDiscardChangesAlertEnabled: false
      children:
        - type: component.choice-field
          instanceId: new-customer
          options:
            label: Are you a new customer?
            data: [email protected]
            item:
              type: component.choice-field-item
              options:
                title: [email protected]
                value: [email protected]
  - type: component.form
    instanceId: register
    when: [email protected] ='Yes' ? true:false
    options:
      children:
        # If yes is selected in the choice-field the form displays.       
        - type: component.text-field
          instanceId: firstName
          options:
            label: Fist name
            isRequired: true
        - type: component.text-field
          instanceId: lastName
          options:
            label: Last name
            isRequired: true
        - type: component.email-field
          instanceId: email
          options:
            label: Email address
            isRequired: true
        - type: component.number-field
          instanceId: phoneNumber
          options:
            label: Mobile number   
        - type: component.text-field
          instanceId: Address
          options:
            label: Address
            isMultiline: true              
# If yes go to online-store.
actions:
  - children:
      - type: action.action-list
        options:
          # Hide the button until the No option is selected.
          # Then show the button and go to the order jig.        
          isHidden: [email protected] ='No' ? false:true
          title: Place order
          isSequential: true
          actions:
            - type: action.go-to
              options:
                linkTo: component-product-item
      - type: action.execute-entity 
        options:
          style:
            # Disable the button until all fields in the form are filled in.           
            isDisabled: =$not(@ctx.components.register.state.isValid)
          # Hide the button until the Yes option is selected.
          # Then show the button, register the customer in Dymanica Data
          # Go to the order jig.            
          isHidden: [email protected] = 'Yes' ? false:true
          title: Register
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/customer
          method: create
          onSuccess: 
            type: action.go-to
            options:
              linkTo: component-product-item
          data:
            firstName: [email protected]
            lastName: [email protected]
            email: [email protected]
            Address: [email protected]

Choice-field with multiple selection

In this example, two choice-field components are used. The first is a single Yes/No selection to answer a question. The second choice-field is configured with a when property to only display is the Yes selection was made. The isMultiple property set to true allows multiple options to be selected in the component. Selecting submit uses an info-modal to show the form was successfully submitted.

Examples: See the full example in GitHub.

choice-field-multiple.jigx

title: Patient Details
description: Patient information
type: jig.default

header:
  type: component.jig-header
  options:
    height: medium
    children: 
      type: component.image
      options:
        source:
          uri: https://images.unsplash.com/photo-1532938911079-1b06ac7ceec7?q=80&w=1632&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
# Resets the component when pulling down on the jig.
# The form resets with the configured initialValues.  
onRefresh: 
  type: action.reset-state
  options:
    state: [email protected]
    
datasources:
  allergies: 
    type: datasource.static
    options:
      data:
        - id: 1
          allergen: legumes   
        - id: 2
          allergen: nuts  
        - id: 3
          allergen: shellfish  
        - id: 4
          allergen: milk      
        - id: 5
          allergen: eggs  
        - id: 6
          allergen: wheat   
          
  select-option:
    type: datasource.static
    options:
      data:
        - id: 1
          option: Yes
        - id: 2
          option: No
            
children:
  - type: component.form
    instanceId: new-patient
    options:
      isDiscardChangesAlertEnabled: false
      children:
        - type: component.text-field
          instanceId: firstName
          options:
            label: Fist name
            isRequired: true
        - type: component.text-field
          instanceId: lastName
          options:
            label: last name
            isRequired: true
        - type: component.email-field
          instanceId: email
          options:
            label: Email address
            isRequired: true
        - type: component.choice-field
          instanceId: select
          options:
            itemsPerRow: 2
            label: Do you have Allergies 
            data: [email protected]
            item:
              type: component.choice-field-item
              options: 
                title: [email protected]
                value: [email protected]
            
        - type: component.section
          when: [email protected] ='Yes' ? true:false
          options:
            title: What are you allergic to?
            children:
            - type: component.choice-field
              instanceId: allery
              options:
                # isMultiple allows for multiple selection
                isMultiple: true
                isRequired: true
                errorText: Required
                # Place the choice items two in a row     
                itemsPerRow: 2
                label: Patient Allergies
                data: [email protected]
                item:
                  type: component.choice-field-item
                  options:
                    title: [email protected] 
                    value: [email protected]
          
actions:
  - children:
      - type: action.execute-entity
        options:
          title: submit
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/patient
          method: create
          onSuccess: 
            type: action.info-modal
            options:
              modal:
                element: 
                  type: icon
                  icon: check
                  color: positive
                title: Form Submitted
                buttonText: Close
          data:
            firstName: [email protected]
            lastName: [email protected]
            email: [email protected]
            allergies: [email protected]

Loading of multiple selected options

In this example, we want to load the patient's form that they completed in the example above, and show their selected details and allergies. Each patient can have multiple allergies, and the data would be saved as an object in the database. To deserialize the object the jsonProperties property is configured with the column containing the object of multiple allergies. In the choice-field component the intialValue is then configured to return the selected allergies for the specific patient. The execute-entity action is configured to update the patient data.

title: Patient Details
description: Patient information
type: jig.default
# Add the input to receive the id for the specific patient 
inputs:
  patientId: 
    type: string
    required: true

header:
  type: component.jig-header
  options:
    height: medium
    children: 
      type: component.image
      options:
        source:
          uri: https://images.unsplash.com/photo-1532938911079-1b06ac7ceec7?q=80&w=1632&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
# Resets the component when pulling down on the jig.
# The form resets with the configured initialValues. 
onRefresh: 
  type: action.reset-state
  options:
    state: [email protected]
    
datasources:
  allergies: 
    type: datasource.static
    options:
      data:
        - id: 1
          allergen: legumes   
        - id: 2
          allergen: nuts  
        - id: 3
          allergen: shellfish  
        - id: 4
          allergen: milk      
        - id: 5
          allergen: eggs  
        - id: 6
          allergen: wheat   
          
  select-option:
    type: datasource.static
    options:
      data:
        - id: 1
          option: Yes
        - id: 2
          option: No
  # The datasource used to return the patient details.
  # queryParameter references the patientId input from the list
  # jsonProperties is specified to deserialize the allergies object,
  # allowing it to be loaded in the choice field as an initialValue       
  patient:
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC  
      entities:
        - default/patient  
      query: 
        SELECT 
        id, 
        '$.firstName',
        '$.lastName',
        '$.email',
        '$.allergies'
        FROM [default/patient] 
        WHERE id = @patientId
      queryParameters:
        patientId: [email protected]
      jsonProperties: 
        - allergies
      
children:
  - type: component.form
    instanceId: new-patient
    options:   
      isDiscardChangesAlertEnabled: false
      children:
        - type: component.text-field
          instanceId: firstName
          options:
            initialValue: [email protected]
            label: Fist name
            isRequired: true
        - type: component.text-field
          instanceId: lastName
          options:
            initialValue: [email protected]
            label: last name
            isRequired: true
        - type: component.email-field
          instanceId: email
          options:
            initialValue: [email protected]
            label: Email address
            isRequired: true
        - type: component.choice-field
          instanceId: select
          options:
            # For this choice-field we do not save the value in the datasource, 
            # using an expression we can see if there are allergies for the 
            # patient, if allergies column contains data,
            # then the Yes choice-field is populated.         
            initialValue: =$exists(@ctx.datasources.patient.allergies) ? 'Yes':'No'
            itemsPerRow: 2
            label: Do you have Allergies 
            data: [email protected]
            item:
              type: component.choice-field-item
              options: 
                title: [email protected]
                value: [email protected]
            
        - type: component.section
          options:
            title: What are you allergic to?
            children:
            - type: component.choice-field
              instanceId: allergy       
              options:
                # Show the selected patient's allergies using initialValue.
                initialValue: [email protected]
                isMultiple: true
                isRequired: true
                errorText: Required
                itemsPerRow: 2
                label: Patient Allergies
                data: [email protected]
                item:
                  type: component.choice-field-item
                  options:
                    title: [email protected] 
                    value: [email protected]
# Set up the action to update the patient's details and allergies.          
actions:
  - children:
      - type: action.execute-entity
        options:
          title: Update
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/patient
          method: update
          onSuccess: 
            type: action.info-modal
            options:
              modal:
                element: 
                  type: icon
                  icon: check
                  color: positive
                title: Form Submitted
                buttonText: Close
          data:
            id: [email protected]
            firstName: [email protected]
            lastName: [email protected]
            email: [email protected]
            allergies: [email protected]

title: Update Patient list
type: jig.list
icon: doctor-consultation-chat-1

header:
  type: component.jig-header
  options:
    height: medium
    children:
      type: component.image
      options:
        source:
          uri: https://images.unsplash.com/photo-1532938911079-1b06ac7ceec7?q=80&w=1632&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D

onFocus:
  type: action.action-list
  options:
    isSequential: true
    actions:
      - type: action.sync-entities
        options:
          provider: DATA_PROVIDER_DYNAMIC
          entities:
            - default/patient
       
datasources:
  patient-list: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC  
      entities:
        - default/patient 
      query: 
        SELECT 
        id, 
        '$.firstName',
        '$.lastName',
        '$.email',
        '$.allergies'
        FROM [default/patient] 

data: [email protected]
item:
  type: component.list-item
  options:
    title: [email protected]
    subtitle: [email protected]
    rightElement: 
      element: button
      title: View
      onPress: 
        type: action.go-to
        options:
          linkTo: choice-field-multiple
          parameters:
            patientId: [email protected]

Choice-field with three items per row

Using the itemsPerRow property in the choice-field component defines how many choice option items must be shown on each row. Keep in mind this is on a mobile device, having more than 3 could make the options hard to read.

Examples: See the full example in GitHub.

choice-field-items-per-row.jigx

title: Choice-field-items per ro
description: Customer Survey
type: jig.default

header:
  type: component.jig-header
  options:
    height: medium
    children:
      type: component.image
      options:
        source:
          uri: https://images.unsplash.com/photo-1628313388777-9b9a751dfc6a?q=80&w=1548&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D

datasources:
  customer-satisfaction: 
    type: datasource.static
    options:
      data:
        - id: 1
          option: 😀 Happy
        - id: 2
          option: 😕 Neutral  
        - id: 3
          option: 😡 Sad 

children:
  - type: component.form
    instanceId: customer-survey
    options:
      isDiscardChangesAlertEnabled: false
      children:
        - type: component.choice-field
          instanceId: satisfaction
          options:
            itemsPerRow: 3
            label: How satisfied were you with our service today?
            data: [email protected]
            item:
              type: component.choice-field-item
              options:
                title: [email protected]
                value: [email protected]
actions:
  - children:
      - type: action.execute-entity
        options:
          title: submit
          provider: DATA_PROVIDER_DYNAMIC
          entity: default/customer
          method: create
          onSuccess: 
            type: action.info-modal
            options:
              modal:
                element: 
                  type: image
                  uri: https://images.unsplash.com/photo-1643878037082-ba1fd9a60b16?q=80&w=1632&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
                title: Survey complete
                buttonText: Thank you
          data:
            satisfaction: [email protected]

Choice-field with an initial selection

In this example of the choice-field component the form opens with an option already selected. This is configured using an expression in the initialValue property. You can change the property. Note that the onRefresh event used to reset the form, resets the choice-field back to it's original state with the initialValueselected.

Examples: See the full example in GitHub.

choice-field-initialvalue.jigx

title: choice-field with initial value selected
type: jig.default
# Header section with medium-height image.
header:
  type: component.jig-header
  options:
    height: medium
    children:
      type: component.image
      options:
        source:
          uri: https://images.unsplash.com/photo-1617347454431-f49d7ff5c3b1?w=500&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8MjN8fG9ubGluZSUyMGRlbGl2ZXJ5fGVufDB8fDB8fHwy
# Set the component back to the initialValue when refreshed.
onRefresh: 
  type: action.reset-state
  options:
    state: [email protected]
# Data configuration - fetch shipping options from Dynamic Data database
datasources:
  shipping: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC  
      entities:
        - default/shipping  
      query: |
        SELECT 
        id, 
        '$.method', 
        '$.cost'
        FROM [default/shipping]
# Main UI structure.
children:
  - type: component.form
    instanceId: delivery
    options:
      children:
       # Choice field for shipping method selection.
        - type: component.choice-field
          instanceId: shipping-method
          options:
            # Pre-selected the first shipping method from the database.
            initialValue: [email protected][0].method
            label: Choose your shipping method 
            # Bind data from shipping datasource.
            data: [email protected]
            item:
              type: component.choice-field-item
              options:
                # Display format: "method cost" (e.g., "Express $15.99").
                title: =(@ctx.current.item.method & ' ' &  @ctx.current.item.cost)
                # The actual value stored when this option is selected.
                value: [email protected]
# Action buttons section.
actions:
  - children:
      # Navigation button to go back to previous screen.
      - type: action.go-back
        options:
          title: Checkout

Choice-field with onChange

In this example, when the choice-field-item is selected and onChange event triggers a open-url action providing the information on the holiday packages.

Examples: See the full example in GitHub.

choice-field-onchange/jigx

title: Choice-field with onChange
type: jig.default
# Header section with medium-height travel-themed image.
header:
  type: component.jig-header
  options:
    height: medium
    children:
      type: component.image
      options:
        source:
          uri: https://images.unsplash.com/photo-1618245318763-a15156d6b23c?q=80&w=1740&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
# Static datasource containing vacation package information.
datasources:
  packages:
    type: datasource.static
    options:
      data: 
        - name: Seychelles
          days: 30
          description: "10 days in luxury accomodation"
          Price: "$ 1500"
          url: https://www.clubmed.co.za/d/indian-ocean/seychelles
        - name: Maldives
          days: 60
          description: "7 days experience cultural activities"
          Price: "$ 1000"
          url: https://www.clubmed.co.za/d/indian-ocean/maldives
        - name: Mauritius
          days: 120
          description: "8 days includes watersports"   
          Price: "$ 2350"
          url: https://www.clubmed.co.za/d/indian-ocean/mauritius
        - name: Indonesia
          days: 95
          description: "15 days all inclusive experience"
          Price: "$ 3760"
          url: https://www.clubmed.co.za/d/asia/indonesia
# Main UI structure.
children:
  - type: component.form
    instanceId: island-holiday
    options:
      children:
        # Choice field for vacation package selection.
        - type: component.choice-field
          instanceId: select-package
          options:
            # Action triggered when user selects an option.
            onChange: 
              type: action.open-url
              options:
                # Open the URL of the selected package in browser/new tab.
                url: [email protected]
            label: Select an island package
            # Bind data from the packages datasource.
            data: [email protected]
            # Configure how the choice options are displayed.
            item:
              type: component.choice-field-item
              options:
                # Display format: "Destination starting from Price" 
                # (e.g., "Seychelles starting from $ 1500")
                title: =(@ctx.current.item.name & ' ' & 'starting from' & ' ' & @ctx.current.item.Price)
                value: [email protected]

Previouscheckbox Nextcountdown

Last updated 3 months ago

Was this helpful?

Good afternoon

Configuration options

Considerations

Examples and code snippets

Choice-field with single selection

Choice-field with multiple selection

Loading of multiple selected options

Choice-field with three items per row

Choice-field with an initial selection

Choice-field with onChange