Base UI and Card Templates (Managed Package)

For the managed package runtime, the following tables list the base templates that are available for use with Vlocity Cards. When editing a template, it’s best practice to clone the existing template first and to edit the cloned version.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Note
Note

Beginning with the Vlocity Summer '19 release, Vlocity supports Salesforce's Lightning Web Components programming model with Vlocity Lightning Web Components. Vlocity Lightning Web Components include components, functionalities, and templates exclusive to LWC Cards.

Note
Note

You can’t modify base Vlocity Cards authored by Vlocity. If you must edit the card, such as its configuration settings, card states, or data sources, clone the card.

Card and Card Layout Templates

Apply Card and Layout templates in Vlocity Cards to control the information and actions that are available to a user. When active, the resulting Layout template becomes available in Vlocity Cards Component's Layout dropdown. The Vlocity Cards component is available in the Community Builder and the Lightning App Builder.

image

Card Layouts

Layout templates act as containers for Card templates and control how the cards display.

To apply a Layout Template:

  1. In the Layout section of a Vlocity Card, ensure the Type is set to Layout.

  2. Enter a Layout Template into the Template field.

Card Layout Template

Description

Card Layout Template Preview

Compatible Card Templates

card-canvas-1x-simple-slds

One-column container

Image unavailable

action-grid-card

action-grid-card-slds

card-active-placeholders-slds

card-active-slds

card-active-slds-VlocityTrack

card-highlight-totals

card-horiz-actions-slds

card-horiz-noActions-slds

large-card-slds

card-canvas-1x-slds

One-column container with search feature

image

action-grid-card

action-grid-card-slds

card-active-placeholders-slds

card-active-slds

card-active-slds-VlocityTrack

card-highlight-totals

card-horiz-actions-slds

card-horiz-noActions-slds

large-card-slds

card-canvas-3x-slds

Three-column container with search feature

image

action-grid-card

action-grid-cards-slds

card-active-placeholders-slds

card-active-slds

card-active-slds-VlocityTrack

card-horiz-open-slds

card-open-slds

card-simple-slds

offer-card-active-slds

card-canvas-3x-zones-slds

Three-column card container with search feature and zones

image

action-grid-card

action-grid-card-slds

card-active-placeholders-slds

card-active-slds

card-active-slds-VlocityTrack

card-horiz-open-slds

card-open-slds

card-simple-slds

offer-card-active-slds

column

Simple column of cards

Image unavailable

action-grid-card

action-grid-card-slds

card-active-placeholders-slds

card-active-slds

card-active-slds-VlocityTrack

card-highlight-totals

card-horiz-actions-slds

card-horiz-noActions-slds

large-card-slds

infinite-list

List template with infinite scrolling for records using pagination

See list-card-canvas

list-card-slds

list-card-canvas

One-column container with each card's fields and actions displayed in a row

image

list-card

list-card-canvas-slds

One-column container with each card's fields and actions displayed in a row in SLDS

image

list-card-slds

list-table

One-column container in a table. Each card's fields and actions are displayed in a row. Actions show in a vertical list.

image

list-table-card

Cards

To apply a Card Template:

  1. In the Cards section of Vlocity Cards, ensure your Card isn’t active.

  2. In the States section of Vlocity Cards, enter a Card template name into the Template field.

    image

Card Template

Description

Template Preview

Compatible Card Layout Templates

action-grid-card

Displays actions (icon and label) in a responsive grid format

image

card-canvas-1x-slds

card-canvas-1x-simple-slds

card-canvas-3x-slds

card-canvas-3x-zones-slds

column

action-grid-card-slds

Displays actions (icon and label) in a responsive grid format using SLDS.

image

card-canvas-1x-slds

card-canvas-1x-simple-slds

card-canvas-3x-slds

card-canvas-3x-zones-slds

column

card-active-placeholders-slds

Displays a list of fields and an adjacent list of actions along with placeholder.

image

card-canvas-1x-slds

card-canvas-1x-simple-slds

card-canvas-3x-slds

card-canvas-3x-zones-slds

column

card-active-slds

Displays a list of fields and an adjacent list of actions.

image

card-canvas-1x-slds

card-canvas-1x-simple-slds

card-canvas-3x-slds

card-canvas-3x-zones-slds

column

card-active-slds-VlocityTrack

Displays a list of fields and an adjacent list of actions, using SLDS with tracking. For more information on tracking,

image

card-canvas-1x-slds

card-canvas-1x-simple-slds

card-canvas-3x-slds

card-canvas-3x-zones-slds

column

card-highlight-totals

Displays entire card in single column with pagination, with four fields per page.

image

card-canvas-1x-slds

card-canvas-1x-simple-slds

column

card-horiz-actions-slds

Displays entire card in single column with horizontal fields. Actions display horizontally under fields.

image

card-canvas-1x-slds

card-canvas-1x-simple-slds

column

card-horiz-noActions-slds

Displays entire card in single column with horizontal fields. Actions available only in dropdown.

image

card-canvas-1x-slds

card-canvas-1x-simple-slds

column

card-horiz-open-slds

Displays entire card in single column with button and label.

image

card-canvas-3x-slds

card-canvas-3x-zones-slds

card-open-slds

Displays one button and label in SLDS.

image

card-canvas-3x-slds

card-canvas-3x-zones-slds

card-simple-slds

Displays list of field labels adjacent list of fields.

image

card-canvas-3x-slds

card-canvas-3x-zones-slds

large-card-slds

Displays entire card in a single column with a list of fields and an adjacent list of actions. In SLDS, includes placeholders, tracking and icon pattern.

image

card-canvas-1x-slds

card-canvas-1x-simple-slds

column

list-card

Displays fields in one row with all action icons listed on same row.

image

list-card-canvas

list-card-slds

Displays fields in one row with all actions only available in dropdown.

image

list-card-canvas-slds

list-table-card

Displays fields in one row with all action icons and text listed in a vertical list.

image

list-table

offer-card-active-slds

Displays image-only button.

image

card-canvas-3x-slds

card-canvas-3x-zones-slds

Flyout Templates

Flyout Templates enable users to view information or access additional actions for the current record or a child record. Similar to Cards, Flyouts are created in Vlocity Cards and use a Flyout Layout template to contain Flyout Card Templates. When active, the resulting Flyout becomes available in the Flyout Template dropdown.

image

Flyout Layout Templates

Flyout Layout templates act as containers for Flyout Card Templates and control how the Flyout Card displays.

To apply a Flyout Layout Template:

  1. In the Layout section of a Vlocity Card, ensure the Type is set to Flyout.

  2. Enter a Flyout Template into the Template field.

    image

Flyout Layout Template

Description

Template Preview

Compatible Flyout Card Templates

flyout-grid

Simple one-column container for flyout components.

image

flyout-grid-items

flyout-grid-slds

Three-column container for flyout components in SLDS.

Overflow actions from parent card and flyout cards.

image

flyout-grid-items-slds

flyout-grid-actions

Two-column container for overflow actions from parent card.

image

flyout-grid-items

flyout-grid-actions-slds

One-column container for overflow actions from parent card.

image

flyout-grid-items-slds

flyout-grid-noActions-slds

Three-column container for flyout components in SLDS.

No overflow actions from parent card.

image

flyout-grid-items-slds

Flyout Card Templates

To apply a Flyout Card Template:

  1. In the Cards section of Vlocity Cards, ensure your Card isn’t active.

  2. In the States section of Vlocity Cards, enter a Flyout Card template name into the Template field.

    image

Flyout Card Template

Description

Preview

Compatible Flyout Layout Templates

flyout-grid-items

Flyout container for card items.

See Compatible Flyout Layout Templates

flyout-grid

flyout-grid-actions

flyout-grid-items-slds

Flyout container for card items in SLDS.

See Compatible Flyout Layout Templates

flyout-grid-slds

flyout-grid-actions-slds

flyout-grid-noActions-slds

Console Card and Layout Templates

Console Card templates enable multiple records to be accessible and actionable all from the same view. In addition to Console Card and Layout Templates, there are out of the box Layouts that contain out of the box Cards. Console Cards also rely on embedded templates to display additional information all within one parent layout.

image

Out of the Box Console Layouts

The Console Layouts are accessible in the Vlocity Cards landing page.

image

Layout

Description

Layout Preview

Layout Template

Cards

Card Templates

Embedded Templates

console-sidebar-slds

Sidebar layout that displays left sidebar cards and the embedded story-card-canvas template.

image

console-sidebar-slds

profile-account-slds

profile-account-info-slds

left-profile-slds

left-account-info-slds

story-card-canvas

console-right-sidebar-slds

Layout for right sidebar cards.

Displays offer cards based on Vlocity Intelligence inputs and profile cards.

Cards for the left-profile-tag template are embedded in this template.

image

console-right-sidebar-slds

acuity-sidebar-offer-card

profileTags

acuity-sidebar-offer-card

left-profile-tag

story-slds

Embedded in the console-sidebar-slds template the story-slds layout presents story cards to the user and includes sorting by story type.

image

story-card-canvas

Various Story Cards

story-card

n/a

Out of the Box Console Cards

The Console Cards are accessible through the out of the box Console Layouts.

image

Card

Description

Card Preview

Card Template

Layout

Layout Template

acuity-sidebar-offer-card

Card that displays offer links in the console sidebar.

image

acuity-sidebar-offer-card

console-right-sidebar-slds

console-right-sidebar-slds

profile-account-slds

Displays twitter photo, information, and actions in SLDS.

image

left-profile-slds

console-sidebar-slds

console-sidebar-slds

profile-account-info-slds

Displays information for console sidebar in SLDS.

image

left-account-info-slds

console-sidebar-slds

console-sidebar-slds

profileTags

Displays the Profile component in the right sidebar.

Profile tags are embedded in the console-right-sidebar-slds template.

image

left-profile-tag

console-right-sidebar-slds

console-right-sidebar-slds