Dashboards Overview

Component that shows tiles for all the Platform Analytics dashboards that the viewer can access. These include dashboards migrated from Core UI in Compatibility Mode. The tiles show the title and creator of the dashboard, and also whether it is certified across the company or bookmarked by the viewer. Viewers can filter the dashboards by name, bookmark, certification, or whether they created it. The Overview also has functionality for creating new dashboards.

Overview

  • Release version
    Zurich
  • Available sinceQuebec
  • A11Y WCAG 2.1 AA

Anatomy

Learn about the individual parts of dashboards overview.

Dashboards overview

dashboards overview anatomy
  1. Heading: Title of the component
  2. Action button: Bare button that takes the user to the all-dashboards page
  3. Dashboard card: Direct link to a specific dashboard page
  4. Filter panel: Contains search and filtering capabilities
  5. Search input field: Allows the user to search for a dashboard by name or owner
  6. Dashboard card: Represents a specific dashboard; when selected, the user goes directly to the dashboard
  7. Pagination control: Subcomponent that helps the user navigate between pages

Dashboard card

dashboard card anatomy
  1. Dashboard title: Name of the dashboard
  2. Info/Description: Description of the dashboard
  3. Bookmark: Bookmark the artifact over the card
  4. Certified: Artifacts that are certified
  5. Last viewed: Shows the last viewed information
  6. Dashboard owner: Name of the dashboard owner

Subcomponents

See usage guidance for heading

See usage guidance for button bare

See usage guidance for card

See usage guidance for search input field

See usage guidance for pagination control

Usage

Use the dashboards overview component to help users easily view and access all available Dashboards directly from one page.

dashboards overview used in a landing page

In this example, the dashboards overview component helps users access dashboards.

Configurations

You can customize the dashboards overview by configuring the following properties.

Heading name

You can change the titles of the dashboards overview and all-dashboards views to suit your use case.

custom title for dashboards overview

Number of cards

You can display as many cards as you want within the dashboards overview component. The default number of cards is 6.

Design recommendations

Learn how to apply dashboard overview in your design.

UI text guidelines

These are some recommendations for using text within dashboards overview:

  • Use sentence case for all titles
  • Keep titles informative and short to increase readability and scanning
  • Capitalize only the first letter and any proper nouns in a string of text

Behavior

Learn how dashboards overview behaves when the display changes or a user interacts with the component.

Responsive behaviors

Learn how dashboards overview responds to changes in a container or display.

Card size

Dashboard card width automatically adjusts, based on the configured height and width of the component.

card size adjusting to the overall size of the component

Card overflow

When the total number of cards doesn't fit the dashboards overview size, a scrollbar appears to let the user scroll through the complete list of cards within the dashboards overview.

scroll bar that appears when cards overflow the configured component size

Interactions

Learn how dashboards overview responds when a user interacts with it.

Selecting dashboard card

When the user selects an individual dashboard card, they go to that dashboard.

When the user selects the bare button link, they go to the all-dashboards pages.

Truncation

When the heading of the dashboards overview exceeds the width of the container or content area, the text truncates. A See all link appears, allowing users to display the entire heading.

truncated component heading with link to display more

When the dashboard name in a dashboard card exceeds the width of the container or content area, the text goes to the next line. If the dashboard name exceeds the width of the second line, the name truncates. If the dashboard owner's name exceeds the width of the container or content area, the name truncates.

truncated cashboard card title

Usability

Dashboards overview complies with all internationalization and accessibility requirements.

Internationalization

When the display translates to a right-to-left (RTL) language, the component heading aligns on the right and the button link aligns on the left. Dashboard cards orient from the top-right, going to the bottom-left.
All subcomponents follow their own internalization rules.

right-to-left language alignment for dashboard component and dashboard cards

Alignment on all-dashboards pages follows the same principle. However, the filters panel aligns to the right.

all-dashboards page with RTL alignment of heading and filter

Accessibility

Learn how to access the actionable elements of dashboards overview through keyboard interactions and screen readers.

Keyboard interactions

You can access the actionable elements of dashboards overview with these keyboard keys:

  • Tab: Navigates through actionable items in the dashboards overview in the specified order
  • Shift + Tab: Navigates through actionable items in reverse order
  • Arrow up, down, right, left: Scrolls up and down the entire page in the dashboard card section and navigate between the items in the filters section
  • Enter: Opens related page, dashboard, or interacts with subcomponents (for example, a search input field, bookmark and info icons in the dashboard cards)
    This is the tab order for dashboards overview:
tab order for keyboard interactions

This is the tab order for the all-dashboards page:

keyboard for the all-dashboards page

Screen readers

When you apply ARIA labels to a component, screen readers announce the controls and content of pagination control in the prescribed tab order.