Skip to main content

 

 

 

 
Language:
 
Applies only to Traditional Web Apps
 
 
OutSystems

Card Background

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • You can use the Card Background UI Pattern to group small pieces of information and highlight them on the screen using a background image. The information is grouped into a small block that is easily noticeable on-screen.

    How to use the Card Background UI Pattern

    1. In Service Studio, in the Toolbox, search for Card Background.

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

      By default, the Card Background widget contains a Content placeholder with some text and a Background Image placeholder with an image.

    3. Add your content to the placeholder. In this example we change the image. To do this, from the Widget Tree, select the Image, and on the Properties tab, from the Image drop-down, select the image you want to display.

    4. On the Properties tab, you can change the look and feel of the Card Background widget, by setting the (optional) properties, for example, the background color that overlays the image, the content's position and a minimum height for the card.

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

    Properties

    Property Description
    Color (Color Identifier): Optional Set the background color. Red, orange, yellow, lime, green, blue, violet, and pink are just some of predefined colors available for the badge.

    Examples

    • Blank - No background color is applied. This is the default (Entities.Color.Transparent).
    • Entities.Color.Red - Applies a red background color to the card.
    Position (PositionExtended Identifier): Optional Sets the widget position.

    Examples

    • Entities.PositionExtended.BottomRight - The widget displays on the bottom right of the screen.
    • Entities.PositionExtended.Center - The widget displays in the center of the screen.
    Height (Integer): Optional Set the height of the Card (in pixels). By default, the content is vertically aligned.

    Examples

    • Blank - The Card height is 300 pixels.
    • 500 - The Card height is 500 pixels.
    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?