Navigation Component

Navigation Component

The Navigation component creates a multi-page navigation experience in a single module. The Navigation component uses Panel components to represent different pages for end-users to navigate through an application.

By default, the Navigation component has a variety of navigation and event buttons. These include:

  • Previous and Next buttons.
  • A Save Draft and Exit button.
  • A Submit button.

You can also add custom navigation buttons. To learn more, see our Custom Navigation Buttons article.

The default navigation style is navigation bubbles at the top of the page. You can also use tabs or a table of contents-style navigation.

You'll find the Navigation component in the Display & Layout group to the left of the Module Builder.

Click on the tabs below to learn more about the Navigation component:

Field Text

A static image displaying the Navigation component's Display settings.

Settings Description

Canvas Label Text

The Label Text field conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

Use user-friendly labels to make your module accessible. It's best practice to use brief and descriptive labels (one or two words). Use title case for short entries and sentence case for long entries.

Default State Options

Settings Description

Hide Error Message

Set to Checked Box Icon (checked) to prevent the end-user from seeing the error message.

Hide Success Message

Set to Checked Box Icon (checked) to prevent the end-user from seeing the success message.

Disable User Input

Set to Checked Box Icon (checked) to disable input for all nested components in Express View. Navigation between pages continues to work.

Hide Field

Set to Checked Box Icon (checked) to hide the Navigation component and all nested components in Express View. The components are always visible in the Module Builder.

Formatting

Settings Description

Navigation Title

Enter a title to display on every page.

Navigation Subtitle

Enter a subtitle to display on every page.

Confirmation Button

The text that displays in the Success and Error message modals.

The default value is OK.

Next Button

The text that displays on the Next navigation button.

The default text is Next.

Previous Button

The text that displays on the Previous navigation button.

The default label is Previous.

Submit Button

The text for the Submit button. The default value is Submit.

Submit URL

The URL to redirect your end-user to after they click Submit.

Success Message

The message that displays on successfully saving the submission.

The default value is Success!

Save Draft and Exit Button

The text that displays on the Save Draft and Exit button.

The default value is Save Draft and Exit.

After clicking Save Draft and Exit, your end-user sees a confirmation modal.

Save and Exit Message

The text that displays in the Save and Exit modal. The modal displays when clicking the Save Draft and Exit button.

Save Draft URL

The URL to redirect your end-user to after they click Save Draft and Exit.

Error Title

The message that displays in a modal when validation errors are present.

Error Message

The text that displays in the error message modal when validation errors are present.

Vertical Display

Set to  (ON) to display the navigation in vertical order. This navigation style looks like a table of contents at the left side of the page, with expandable groups of pages. Use the Group column in the Panels table to create and add top-level titles to the page groups.

The default navigation style is navigation bubbles displayed in horizontal order.

The default setting is (OFF).

Show as Tabs

Set to  (ON) to use tabs-style navigation. The default navigation style is navigation bubbles.

The default setting is (OFF).

Validate on Every Navigation

Set to  (ON) to validate the module when the end-user clicks the Previous or Next buttons.

You must also select either the Validate on User Navigation or Validate All Module Fields setting.

For the Vertical Display to work, there must be a Group value in the Panels table.

The default setting is (OFF).

Display Errors on Top

Set to  (ON) to display validation error messages at the top of the page instead of the bottom.

The default setting is (OFF).

Scroll Position on Navigation

Settings Description

Scroll Position on Navigation

This setting controls the end-user's scroll position when navigating between pages.

Options include:

  • Scroll to Top: Scrolls to the top of the application when a new page is accessed.

  • Stay in Place: Displays the new page without scrolling.

The default setting is Scroll to Top.

Vertical Offset

The number of pixels to move the Navigation component down by. Use this in applications with fixed headers to prevent the Navigation component from overlapping with the header.

The Vertical Offset value is in pixels.

The Panels table defines each page in the Navigation component. The Panel referenced in the first row of the table becomes the first page. The Panel referenced in the second row of the table becomes the second page, and so on. To improve end-user experience, use the smallest amount of pages possible.

The Panels referenced in this table must nest inside the Navigation component.

A static image displaying the Navigation component's Panels table.

Setting Description

Group

Enter a title for a group of Panels. This title displays when the Vertical Display setting is enabled. The Vertical Display navigation style looks like a Table of Contents, with expandable groups of pages.

Set the top-level title for each group in this column. Using the same title in multiple rows will add that Panel to the page group.

There must be a Group value for the Vertical Display to work.

Title

Enter a title to display below each navigation bubble. With Show as Tabs set to  (ON), the value in this column displays as the tab's title. With Vertical Display set to  (ON), the value in this column displays as the second-level title.

Heading

Enter a heading to display on this Panel's page.

Value

Enter the Property ID of a Panel component to act as a page.

Panel

Enter the Property ID of a Panel component to act as a page.

Hide Previous

Set to Checked Box Icon (checked) to hide the Previous navigation button on this Panel's page.

By default, the Previous button does not display on the first page.

Hide Next

Set to Checked Box Icon (checked) to hide the Next navigation button on this Panel's page.

By default, the Next button does not display on the final page.

Hide Submit

Set to Checked Box Icon (checked) to hide the Submit button on this Panel's page.

By default, the Submit button displays only on the final page.

Hide Draft

Set to Checked Box Icon (checked) to hide the Save Draft and Exit button on this Panel's page.

By default, the Save Draft and Exit button displays on every page.

Save

Set to Checked Box Icon (checked) to create a new submission or save to an existing submission after the end-user navigates away from this Panel's page.

Post Trigger

Enter the Property ID of the component to trigger when navigating away from this Panel's page.

Post Validation Trigger

Enter the Property ID of the component to trigger on validation of the module.

Use in combination with either of the following settings:

  • Validate on User Navigation: Validates when the end-user clicks the Next button on any page or Submit button on the final page.

  • Validate All Module Fields: Validates when the end-user clicks the Submit button on the final page.

Pre Trigger

Enter the Property ID of the component to trigger when navigating to this Panel's page. Post Trigger triggers on the preceding page fire first.

Post Save Trigger

Enter the Property ID of the component to trigger on saving the submission.

Use in combination with either of the following settings:

  • Panels table - Save Column: Check the Save checkbox in the same row.

  • Save on User Navigation: Set to  (ON) to enable save on forward navigation. The Post Save Trigger triggers on user navigation.

Save events created by clicking either the Submit button or the Save and Exit button won't trigger components entered in the Post Save Trigger field.

Let's say you want to collect information about a claim your end-user submitted. Configure a Navigation component with a two-page navigation experience. Use Panel components for each page of your module. On one page, end-users enter some basic information. On the next page, end-users enter some claim details before submitting the form.

Configure the Navigation Component

First, add and configure the Navigation component. This component holds two Panel components that act as pages of the application.

1. In the Module Builder, drag and drop a Navigation Component Icon Navigation component onto your canvas.
2. In the Property ID field, enter navField.
3. In the Canvas Label Text field, enter navField.
4. In the Panels table, enter the following:
Group Title Heading Value Panel

 

Basic Information

Complete the following fields

panelBasicInfo

panelBasicInfo

 

Your Claim

Enter details about your claim

panelClaim

panelClaim

You'll set up the panelBasicInfo and panelClaim Panel components next.

A static image displaying the Navigation Component's Panels-table settings. The Title, Heading, Value, and Panel columns are filled out.

5. Navigate to the Advanced settings.
6. Set Validate on User Navigation to  (ON).
7. Click Save Component.

Configure the Panel Components

Add two Panel components inside the Navigation component. Each of these Panels becomes a page in your module.

1. Drag and drop a Panel component onto your canvas, placing it inside the navfield Navigation Component Icon Navigation component.
2. In the Property ID field, enter panelBasicInfo.
3. Set Hide Panel to  (ON).
4. Click Save Component.
5. Drag and drop a second Panel component onto your canvas, placing it inside the navfield Navigation Component Icon Navigation component and below the panelBasicInfo Panel component.
6. In the Property ID field, enter panelClaim.
7. Set Hide Panel to  (ON).
8. Click Save Component.

Configure the Text Field Components

Next, add some Text Fields into the panelBasicInfo Panel component.

1. Drag and drop a  Text Field component onto your canvas, placing it inside the panelBasicInfo Panel component.
2. In the Property ID field, enter firstName.
3. In the Label Text field, enter First Name.
4. Navigate to the Validation settings.
5. Set the Required toggle to  (ON).
6. Click Save Component.
7. Drag and drop a  Text Field component onto your canvas, placing it under the firstName  Text Field component.
8. In the Property ID field, enter lastName.
9. In the Label Text field, enter Last Name.
10. Navigate to the Validation settings.
11. Set the Required toggle to  (ON).
12. Click Save Component.

Configure the Date Input Component

Add a Date Input component so your end-user can enter the date of their claim.

1. Drag and drop a Date Input Icon Date Input component onto your canvas, placing it inside the panelClaim Panel component.
2. In the Property ID field, enter dateClaim.
3. In the Label Text field, enter Date of Claim.
4. Navigate to the Validation settings.
5. Set the Required toggle to  (ON).
6. Click Save Component.

Configure the Number Component

Lastly, add a Number component for your end-user to add their claim's reference number.

1. Drag and drop a Number component onto your canvas, placing it under the dateClaim Date Input Icon Date Input component.
2. In the Property ID field, enter claimNumber.
3. In the Label Text field, enter Claim Reference Number.
4. Navigate to the Validation settings.
5. Set the Required toggle to  (ON).
6. Click Save Component.

Preview your module in Express View. You'll see the following functionality:

The Navigation component presents as a key/value pair, where the key is the Property ID of the Navigation component, and the value is the Property ID of the Panel component displaying to the end-user. In the above example, the navfield Navigation Component Icon Navigation component is the key, and the panelClaim Panel component is the value.

A static image displaying the Developer Console in Express view. The angular command reveals the Navigation component's key value pair.