Custom Components for App Builder

Custom Components for App Builder live separately from the built-in App Builder standard components. These components are managed and updated independently from the Metric Insights releases, allowing for flexible changes without the need to update the Metric Insights application.

This article describes available Custom Components, their configuration options, and usage.

PREREQUISITES:

TABLE OF CONTENTS:

Top Menu

Top Menu is a horizontal navigation bar with optional logo, top-level items, and optional subitems. Both menu items and subitems allow linking to specific URLs or Apps. Each menu item can have multiple subitems and supports icons.

Settings

FieldDescription
Show IconSelect whether to show the icon.
AlignChoose whether the menu items are displayed on the Left or Right side from the logo.
Menu Items
TitleName of the item displayed on the menu.
IconSelect the source of the icon:
  • MI Icon: Click [Select Icon] to select from the built-in Metric Insights icons.
  • Upload image: Click [Upload file] to upload your own icon file.
  • URL: Enter icon URL in the icon_value field.
Navigate toSelect where the menu item will navigate:
  • External Link: Enter a URL in the Link field.
  • App Page: Select an App from the App Page dropdown.
Show SubmenuSelect whether the menu item has the submenu items.
Submenu Items
Submenu item <number>Name of the submenu item displayed on the submenu.
Navigate toSame as Navigate to for Menu Items.

Quick Access Box

Quick Access Box is a clickable section listing Favorites, Recently Viewed, or Most Popular items, supporting redirection to the clicked element's viewers. Tile thumbnails can be icon-only or include preview images.

Settings

FieldDescription
Content TypeSelect the displayed content: Favorites, Recently Viewed, or Most Popular.
SourceSelect how content is displayed:
  • Icon: Generic icons for different content types.
  • Preview image: Preview images where available; otherwise, generic icons.
Number of TilesSelect the number of displayed tiles.
Show Info IconSelect whether to display the info icon, which displays tile information on hover.

Navigation Tile is a clickable tile which navigates users to a specified URL or an App. It consists of an optional icon, title, and description.

FieldDescription
Show IconSelect whether to show the icon.
IconSelect the source of the icon:
  • MI Icon: Click [Change Icon] to select from the built-in Metric Insights icons.
  • Upload image: Click [Upload file] to upload your own icon file.
  • URL: Enter icon URL.
TitleTile heading.
DescriptionTile text.
Navigate toSelect where the tile will navigate:
  • External Link: Enter a URL in the Link field.
  • App Page: Select an App from the App Page dropdown.
DirectionSelect whether the icon and tile’s text are distributed horizontally or vertically.
AlignSelect how the tile’s icon and text are aligned within the tile.

Announcements

Announcements box displays Announcements in order of their creation, the same order as returned via the API.

Settings

FieldDescription
Announcements CountThe number of Announcements to display.