Number Card

Number Cards display a quantity of objects in the system (e.g. number of views of a trailer), retrieved from a query.

Number Cards display a simple count of a specified object in the system, usually for monitoring purposes. Number Cards are most commonly used on dashboards to track high-level counts of an important metric (e.g. number of views on a movie trailer), but the queries can also be more complex, such as sourcing the number of views on all movie trailer videos for a particular year or in a given region.

The Number Card is much simpler than the Summary and Action Cards because it does not provide information about specific data about objects in the system or allow users to take any actions. It also does not allow the designer to include static text beyond a short description of the quantity that the card represents.

The Number Card is most useful for providing a quick count of a specific set of items, with little contextual information beyond that.

Anatomy

  1. Number

  2. Card title

  3. Icon

Best practices

  • While the larger section in which a card is located can add context to that card's content, ensure that cards stand alone and do not rely on other components for understanding or relevance.
  • Icons on cards should be simple and have a clear relation to the content of the card. When in doubt, don't include an icon.
  • Configure Number Cards as small or medium components on the grid. Avoid configuring a card in a single column, as this can create accessibility issues. Instead, stack Number Cards in two rows on the grid.
  • The largest card in a group determines the height of the row the cards are on.

Properties

  • Title field – Required. The static text that displays on the card.
  • Icon field – Optional. The UI icon that displays on the card.
  • Icon Background Color field – Optional. The hex code for the icon background color.
  • Data Source field – Required. The query that retrieves the data for the card, based on the data model.
  • Hide Card if Number is Zero checkbox – Optional. If selected, the card is hidden if the value is zero.
  • Hide Card if Data Source Fails checkbox – Optional. If selected, the card is hidden if the query to retrieve the data fails.
  • Visibility Permission field – Optional. The user's permission to access the component. If a user is not assigned a role that includes this permission, they cannot view or interact with the component.
  • Visibility Permission Not Assigned drop-down – Optional. If the user does not have permission to access the component, specifies whether to hide or disable it:
    • Hide – The component is hidden.
    • Disable – The component is visible but not cannot be interacted with.

Emitted Events

  • On Card Select – The user selects a card.

Functions

  • Get Value – When invoked in an event, the data for the selected card is retrieved.

With icon

  • Icon included.

Without icon

  • Icon not included.