Skip to main content




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


  • Edit
    Collaborate with us
    Edit this page on GitHub
  • You can use the Search UI Pattern to provide users with a search field. Use the Search UI Pattern to allow users find pieces of content by entering queries. Unlike navigation, knowledge of the content's location isn't required and searching is often the primary means of finding content.

    How to use the Search UI Pattern

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

      The Search 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 Search widget into the Main Content area of your application's screen.

      By default, the Search widget contains an Input placeholder and widget.

    3. Select the Input widget, and on the Properties tab, create a local variable by selecting the Variable dropdown and selecting New Local Variable.

    4. Enter a name for the variable.

      In this example, we enter SearchText.

      This variable holds the value entered by the user. This variable can be reused throughout your app.

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


    Properties Description
    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?