Navigation Component

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.

Hide Field                                                                            

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

Input Behavior                                                                            

Controls how end-users interact with the component. Choose from the following options:

• Enable User Input: Allow end-users to view and enter data in this field.

• Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol.

• Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays None.

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 modal.

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                                                                            

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.

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) 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) 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) 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) 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) 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.

Data Reference Key                                                                            

Enter a Property ID that contains a JSON array to use as the Data Source.

Save on User Navigation                                                                            

Set to (checked) to create a submission when your end-user navigates between the first and second pages. The submission then updates and saves any changes on every subsequent navigation.

By default, only clicking the Submit or Save Draft and Exit buttons create a submission.

Validate on User Navigation                                                                            

Set to (checked) to validate the module whenever your end-user clicks the Next or Submit buttons.

When validation errors are present, your end-user cannot navigate away.

Validate Upon Opening Submission                                                                            

Set to (checked) to validate the module when your end-user opens a new submission.

Validate All Module Fields                                                                            

Set to (checked) to validate all fields in the module, not just the fields visible on the current page.

All validation errors display on the final page when your end-user clicks Submit.

This setting is not supported when the Stagger Load for Performance setting is set to (checked).

Allow User to Navigate with Errors                                                                            

Set to (checked) to let your end-user navigate between pages despite validation errors. Your end-user can't submit their information when validation errors are present.

Hide Error Message                                                                            

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

Hide Success Message                                                                            

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

Disable Navigation Jumps                                                                            

Set to (checked) to prevent  end-users from navigating between pages in non-sequential order. For example, by clicking the navigation bubbles.

Persistent                                                                            

This setting is not required for the Navigation component

Stagger Load for Performance                                                                            

Set to (checked) to prevent the Navigation component's Panel components from being loaded into the module until the end-user makes them visible by navigating to that Panel component step.  Doing so improves loading and navigation performance in larger Navigation components with many Panel components or components in the Panel components.

When set to (checked), components remain hidden and do not trigger until displayed. These components include those with Hide Field set to (ON) or when a logic component controls another component with a hidden Output Type.

By default, the Stagger Load for Performance setting is set to ☐ (unchecked).

Debounce Setting                                                                            

The number of milliseconds that pass before the module loads this component. This is useful if you have a large module and you load several components at the same time.

1,000 milliseconds = 1 second.

Custom CSS Class                                                                            

Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules.

Updated CSS styling applies to all components that reference this custom class name.