Skip to main content




Applies only to Traditional Web Apps


  • Edit
    Collaborate with us
    Edit this page on GitHub
  • 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.

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

      The Sidebar 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 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.


    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 Adds custom style classes to the Pattern. You define your custom style classes in your application using CSS.


    • 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.
    • Was this article helpful?