section

Learn how to use the section component in your user interface to group related items together.

The section component groups related items together under a single title. A section can be set up on a jig.default under the entity component or on a form component as its container. The component can contain field-row and entity-field components or children components on a form component.

A component.section can be set up with the following combinations:

  1. An entity containing sections with rows and entity-field for display purposes.

  2. An entity containing sections and entity-field for display purposes.

  3. A form component containing sections with rows and children for display/capturing purposes.

  4. A form component containing sections and children components for display/capturing purposes.

  5. Horizontal lists cannot be used with the section components as an empty white jig will be displayed.

Configuration options

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

Core structure

title

The title property defines the main text displayed in the section. It supports multiple configuration options; you can provide a static string, bind it dynamically using an expression, or extend it with advanced styling and formatting.

You can control text appearance using properties such as fontSize, isbold, and color, transform, as well as specify the numberOfLines to display.

children

Add components that are grouped inside the section, such as number, text, and email fields. Text that can be evaluated, translated, and formatted

Other options

icon

Icon to be displayed on the left side of the header. The icon displays on the left side of the section, providing a visual cue. The icon can be fully customized using styling options such as type (duotone, contained, or basic), shape (rounded, circle, or basic), and color to align with your app’s design.

subtitle

The subtitle property defines the secondary text displayed beneath the section’s title. It supports multiple configuration options; you can provide a static string, bind it dynamically using an expression, or extend it with advanced styling and formatting.

You can control text appearance using properties such as fontSize, isbold, and color, transform, as well as specify the numberOfLines to display.

Actions

actions

The action property defines what happens when the section’s action button is tapped. You can configure it to trigger any supported app action, such as navigating to another screen, opening a URL/map, or updating data. Use IntelliSense to explore the full list of available actions.

State

status

Global state variable that can be used throughout the solution.

filter searchtext

Jig-level state that applies to the specific jig (screen) context, with available keys depending on the jig type (e.g., for list jigs: activeItem, filter, searchText, etc.)

value

State variable of a specific component in the jig.

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

Considerations

  • When no title formatting or styling is applied, section titles default to transform: UPPERCASE with isSubtle: true.

  • You can determine the fontSize by configuring an expression.

Examples and code snippets

Sections with icons, text styling, rows, and entity fields

 Jig with sections Jig with sections, icons and text styling
Jig with sections, icons and text styling

Using sections, rows, and entity fields, along with icons and text styling, to create relevant display sections for information that is functional, elegant, and neatly organized. (Display only)

Examples: See the full example using dynamic data in GitHub.

Sections with text styling, rows, and children components (Display and input)

Jig with sections text styling and actions
Jig with sections text styling and actions

Similar to the above example, this has the same functionality, except that this is for adding or editing data too, and not just for display purposes. The execute-entity action is added to the section header.

Examples: See the full example using dynamic data in GitHub.

Datasource: See the full datasource for dynamic data in GitHub.

Sections with icons & multi-lined subtitle

Sections with icons, multi-line subtitle, list children
Sections with icons, multi-line subtitle, list children

This example demonstrates how to use sections with styled icons, formatted titles, and multi-line subtitles to create a clear and visually engaging layout. Each section represents a project team, displaying their key details and task summaries in an organized structure.

Examples: See the full example in GitHub.

Basic form with sections (Display and input)

Basic form with sections
Basic form with sections

Using sections, along with icons and text styling, creates relevant display sections for information that is functional, elegant, and neatly organized. (Display and input)

Examples: See the full example using dynamic data in GitHub.

Datasources: See the full datasource for dynamic data in GitHub.

Form sections with icon, actions, and text styling

This example demonstrates how component.section can be used in a form to organize related information into clear, structured groups. Each section has been configured with properties such as title, subtitle, icons, and actions to improve usability for frontline workers in the field.

Sections with icon, action and text styling
Sections with icon, action and text styling

Last updated

Was this helpful?