Skip to main content

 

 

 

 
Language:
 
Applies only to Mobile Apps and Reactive Web Apps
Service Studio version:
 
 
OutSystems

Section Index

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • You can use the Section Index UI Pattern to organize the content of a screen, enabling quick navigation within the page.

    How to use the Section Index UI Pattern

    1. In Service Studio, in the Toolbox, search for Section Index.

      The Section Index widget is displayed.

      If the UI widget does not display, it may be because you used a ready-made app, which deletes unused widgets from the module. To make additional widgets available in your app:

      a. Go to Module > Manage dependencies.

      b. Search for and select the relevant Producer, for example OutSystemsUI. Ensure Show All is selected.

      c. On the Public elements for the selected Producer displayed on the right, ensure Show All is selected.

      d. Search for and select the element you want to add, and click Apply.

      e. In Service Studio, in the Toolbox, search for the widget again.

    2. From the Toolbox, drag the Section Index widget into the Main Content area of your application's screen.

      In this example, we drag the Section Index widget into a column.

    3. In the Toolbox, search for and drag the Section widget into the Main Content area of your application's screen. Add as many sections as you require for your app.

      In this example, we drag 4 Section widgets into a column. Each section widget contains Title and Content placeholders.

    4. Add the relevant content to Section widget's Title and Content placeholders.

      In this example, we add employee names to the Title placeholders, and Card Sectioned widgets with some text and images to the Content placeholder.

      A link is automatically created to every section you have on the screen. The name of the link is based on the text you entered in the Title placeholder of each section. In the following example, the links are set to the employee names we entered in step 2.

    5. On the Properties tab, you can customize the Section Index's look and feel by setting any of the optional properties.

    After following these steps and publishing the module, you can test the pattern in your app.

    Properties

    Property Description
    IsSmooth (Boolean): Optional If True, the navigation to the destination is animated. This is the default. If False, the navigation is instant.
    IsFixed (Text): Optional If True, the Section Index Pattern is always in the same position on the screen. This is the default. If False, the Section Index Pattern scrolls with the page content.
    TopPosition (Integer): Optional Distance in pixels from the top of the page to the first item in the section index. The default value is 0.
    ExtendedClass (Text): Optional Adds custom style classes to the Pattern. You define your custom style classes in your application using CSS.

    Examples

    • Blank - No custom styles are added (default value).
    • ''myclass'' - Adds the myclass style to the UI styles being applied.
    • ''myclass1'' ''myclass2'' - Adds the myclass1 and myclass2 styles to the UI styles being applied.
    You can also use the classes available on the OutSystems UI. For more information, see the OutSystems UI Live Style Guide.

    Additional notes

    Remember to use the Title placeholder in the Section Index pattern as this defines the text for each Section Index link.

    • Was this article helpful?