Skip to main content

 

 

 

 
Language:
 
Applies only to Traditional Web Apps
 
 
OutSystems

Input with Icon

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • You can use the Input with Icon UI Pattern to allow the end user input data with the help of a hint in the form of an icon.

    The Input with Icon UI Pattern includes an icon and placeholder text that supports the user when entering data. Is assists the user's comprehension by providing an example of the type of input required.

    How to use the Input with Icon

    1. In Service Studio, in the Toolbox, search for Input with Icon.

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

    3. Select the Input widget, and on the Properties tab, from the Variable drop-down, select New Local Variable.

    4. Enter a name for variable. In this example we enter Username and set the Data Type property to Text.

    5. Select the Input widget again, and on the Properties tab, in the Prompt property, enter the text you want displayed in the input box that describes the expected value. In this example, we enter Username.

    6. To change the icon, select the Icon widget, and from the Name drop-down, select the icon you want to display in the input box. In this example, we select the user icon.

    7. You can change the Input with Icon's look and feel by setting the (optional) properties on the Property tab.

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

    Properties

    Property Description
    AlignIconRight (Boolean): Optional If True, the icon is displayed on the right of the input box. If False, the icon is displayed on the left of the input box. This is the default.
    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.
    • Was this article helpful?