Skip to main content

 

Patterns

 

Applies only to Traditional Web Apps

 

OutSystems

Sidebar

  • Edit
  • You can use the Sidebar UI Pattern to display additional information in the margin of the main content. The additional information supports the user's understanding of the main content.

    How to use the Sidebar UI Pattern

    In this example, we create a button that opens and closes the Sidebar widget.

    To trigger the sidebar, call a new screen action through a button with Ajax submit and use the ToggleSidebar action (found in the Logic Tab) to open/close it. Use the parameters to define if it has Overlay in the page.

    1. In Service Studio, in the Toolbox, search for Sidebar.

      The Sidebar widget is displayed.

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

    3. On the Properties tab, in the Name field, enter a name for the Sidebar widget. In this example, we call it MySidebar.

    4. Add your content to the Header and Content placeholders, for example, forms, images, text etc. In this example we add some text.

    5. From the Toolbox, drag the Button widget just below the Sidebar widget and on the Properties tab, in the Label field, enter the text you want to appear on the button (in this example, we enter Open) and from the Method drop-down, select Ajax Submit.

    6. To create a screen action for the button, double-click the button, select the Logic tab, and from the Server Actions folder, navigate to and drag the ToggleSidebar action onto the screen action.

    7. On the Properties tab, from the WidgetId drop-down, select the Id for the widget. In this example, MySidebar.Id.

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

    Properties

    Property Description
    HasOverlay(Boolean): Optional If set to True, an overlay is displayed behind the Sidebar. If set to False, there is no overlay. This is the default value.
    ExtendedClass (Text): Optional Add custom style classes to the Sidebar UI 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 Sidebar UI styles being applied.
    • ''myclass1'' ''myclass2'' - Adds the myclass1 and myclass2 styles to the Sidebar UI styles being applied.
    • Was this article helpful?