Skip to main content

Card element reference

This guide is a high-level summary of which card elements are supported in the Workbench card-builder and SDKs.

Top-level is how we refer to the default view of a card - the card content a customer sees in their stream container. Subviews are the secondary layouts, which are accessed by link-buttons on the top-level view.

Some content can only be added in either top-level or subview, but most elements can be used in both.

We have indicated for each element at which level it can be used.

Every element is optional.

Text elements

Category

Title at the top of a card that identifies its category. Only available in top-level view.

Example

alt text

Properties

PropertyDetail
TextThe text to display for the category title.
e.g. “Overdue Tasks”

Support

Card editoriOS SDKAndroid SDKWeb SDK

Media banner which displays at the top of a card. Only available in top-level view. The Images safe areas section provides a detailed description of how to optimise the aspect ratios of these images.

Properties

PropertyDetail
Source URLThe URL to the full size to display when the user taps on the image.
Thumbnail URLThe URL to the thumbnail image which displays inline with the card.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Headline

A title intended as the main heading for a card. Available in top-level and subview.

Example

alt text

Properties

PropertyDetail
TextThe text to display in the headline.
e.g. “You have 3 overdue tasks to complete”

Support

Card editoriOS SDKAndroid SDKWeb SDK

Text

A body of text, supporting Markdown formatting and an optional icon on its left. Available in top-level and subview.

Properties

PropertyDetail
TextThe text to display.
E.g. “Last task due 3rd July 2019”
Supported Markdown includes:
**bold** or __bold__
*italic* or _italic_
- list item
1. list item
[link](https://atomic.io/)
Icon(Optional) The icon to display to the left of the text.
Icons from the Free Font Awesome collection are supported.

Support

Card editoriOS SDKAndroid SDKWeb SDK


List

Renders a list of items as a bulleted, numbered or comma separated list. Available in top-level and subview.

Properties

PropertyDetail
TypeThe type of list to render:
number, which renders a numbered list;
bullet, which renders a bulleted list;
comma, which renders a comma separated list.
SourceAn array of items, provided as a list variable, that will be displayed in the list.

Support

Card editoriOS SDKAndroid SDKWeb SDK

(comma type not supported)

(comma type not supported)

(comma type not supported)

Title

The title displayed at the top of the subview. Only available subview.

Properties

PropertyDetail
TextThe title to display at the top of the subview.
E.g. “Update tasks”

Support

Card editoriOS SDKAndroid SDKWeb SDK

Input elements

Date picker

Renders a date picker in the chosen format, allowing the user to select a day, month and year from a platform-specific picker UI. Available in top-level and subview.

Properties

PropertyDetail
LabelThe text to display on the left of the component (if format is inline) or the text to display above the value (if the format is stacked).
Thumbnail URL(Optional) URL to a thumbnail image on the left of the component.
PlaceholderValue to display if no default date is specified, and the user has yet to select a date.
Input nameThe identifier for this field in the response.
Minimum valueThe minimum date that this picker will allow.
Maximum valueThe maximum date that this picker will allow.
Default valueThe default date that the picker should select.
FormatThe format to render the date picker in (inline or stacked).

Support

Card editoriOS SDKAndroid SDKWeb SDK

Does not support Placeholder or stacked display format

Does not support Placeholder

Renders a dropdown in the chosen format, allowing the user to select from a list of pre-defined values. Available in top-level and subview.

Properties

PropertyDetail
LabelThe text to display on the left of the component (if format is inline) or the text to display above the value (if the format is stacked).
Thumbnail URL(Optional) URL to a thumbnail image on the left of the component.
PlaceholderValue to display when the user has yet to activate the dropdown. Once the user activates the dropdown, the default value (if specified) or the first item in the list is selected.
Input nameThe identifier for this field in the response.
Default valueThe default value that the dropdown should select.
FormatThe format to render the dropdown in (inline or stacked).
Data sourceThe list of items, from the event, that should be rendered in the dropdown.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Does not support Placeholder or stacked display format

Does not support Placeholder

Stepper

Allows the user to step up and down between a minimum and maximum value. The value can also be changed by selecting the current value and entering a value manually. Available in top-level and subview.

Properties

PropertyDetail
LabelThe text to display on the left of the component.
Thumbnail URL(Optional) URL to a thumbnail image on the left of the component.
Input nameThe identifier for this field in the response.
Minimum valueThe minimum value allowed by the stepper.
Maximum valueThe maximum value allowed by the stepper.
Step valueThe amount to increase or decrease the stepper by when the increment and decrement buttons are pressed.
Default valueThe default value that the stepper starts at.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Switch

Allows a user to provide a binary response. Available in top-level and subview.

Properties

PropertyDetail
LabelThe text to display on the left of the component.
Thumbnail URL(Optional) URL to a thumbnail image on the left of the component.
Input nameThe identifier for this field in the response.
Default onIf the switch should default to the ‘on’ state.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Text input

Allows a user to provide a single or multi-line text response. Available in top-level and subview.

Properties

PropertyDetail
LabelThe placeholder to display when the user has not entered any text.
Thumbnail URL(Optional) URL to a thumbnail image on the left of the component.
Input nameThe identifier for this field in the response.
Default valueThe default value displayed in the text input. If there is no default value, the placeholder displays until the user enters text.
Number of LinesThe number of lines the text input can receive without scrolling:

- If number of lines is 0, the text field auto-grows to accommodate the text entered into it.
- If number of lines is 1, the text field is restricted to a single line of text.
- If number of lines is greater than 1, the text field provides enough space for the given number of lines without scrolling, auto-growing after that.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Number input

Renders a single line input that allows only numeric values (integer or decimal). Available in top-level and subview.

Properties

PropertyDetail
LabelThe placeholder to display when the user has not entered any numeric value.
Thumbnail URL(Optional) URL to a thumbnail image on the left of the component.
Input nameThe identifier for this field in the response.
Default valueThe default value displayed in the number input. If there is no default value, the placeholder displays until the user enters a value.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Card actions

Submit button

A button that results in a card being submitted. Available in top-level and subview.

Only 1 submit button can be added in a subview.

Properties

PropertyDetail
TextThe title to display on the button.
E.g. “Submit”.
Icon(Optional) The icon to display to the left of the text. Icons from the Free Font Awesome collection are supported. The icon is not displayed on subviews.
Post submit action > ValuesWhen the submit button is triggered, the json payload in the values input field is sent within the card-submitted analytic event as part of the card response payload. This payload is optional, and is sent regardless of the selected post submit action.
Post submit action > NoneNo additional data is sent and no additional actions are taken when the submit button is triggered.
Post submit action > URLA URL that the user is navigated to when submission completes, the URL can be specified to open either in the same window or a new window.
To direct to a callable link (e.g. phone number), use the prefix tel: . e.g. tel:0123456789
Post submit action > PayloadAn optional JSON payload that is passed to the host app on the client side when the submit button is triggered.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Does not support URL in subview.

A button that triggers a subview, or launches an external URL, when tapped or clicked. Only available in top-level view.

Properties

PropertyDetail
TextThe title to display on the button.
E.g. “More information”.
Icon(Optional) The icon to display to the left of the text. Icons from the Free Font Awesome collection are supported.
SubviewThe subview that the user will be navigated to when pressing the link button.
External URLA URL to open when the user presses the link button.
The URL can be specified to open either in the same window or a new window.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Dismiss button

A button that results in a card being dismissed. Only available in top-level view.

Properties

PropertyDetail
TextThe title to display on the button.
E.g. “Dismiss".
Icon(Optional) The icon to display to the left of the text. Icons from the Free Font Awesome collection are supported.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Snooze button

A button that results in a card being snoozed. If no snooze period is specified against the button in the card editor, the customer can determine how long the card will be snoozed for. Otherwise the card will be snoozed directly on button tap. Only available in top-level view.

Properties

PropertyDetail
TextThe title to display on the button.
E.g. "Snooze".
Icon(Optional) The icon to display to the left of the text. Icons from the Free Font Awesome collection are supported.
PeriodThe time period the card is snoozed for. For reference see duration format.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Vote up button

A button that results in a card being voted up, which means a corresponding analytics event is sent for that card (card-voted-up). Only available in top-level view.

Properties

PropertyDetail
TextThe title to display on the button.
E.g. “Vote up".
Icon(Optional) The icon to display to the left of the text. Icons from the Free Font Awesome collection are supported.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Vote down button

A button that redirects to a secondary screen to provide further feedback. Only available in top-level view.

After tapping "Submit", an analytics event containing this feedback is sent (card-voted-down).
More information about voting, such as customizing the feedback options, can be found in the Card voting guide.

Properties

PropertyDetail
TextThe title to display on the button.
E.g. “Vote down".
Icon(Optional) The icon to display to the left of the text. Icons from the Free Font Awesome collection are supported.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Media

Image

An image rendered in a specified format. Tapping or clicking on the image shows a larger version, which can be zoomed or panned. Available in top-level and subview.

Supported image formats across our SDKs are outlined in the Supported media formats table.

The Images safe areas section provides a detailed description of how to optimise the aspect ratios of these images.

Properties

PropertyDetail
FormatThe format to render the image in.
inline, displaying an image with additional horizontal space on each side;
text, displaying a text link to view the image;
thumbnail, displaying a thumbnail accompanied by a title and description.
Source URLThe URL to the full size to display when the user taps on the image.
Thumbnail URLThe URL to the thumbnail image to display when the format is inline or thumbnail.
DescriptionA description of the image, displayed below the title when format is thumbnail.
E.g. “Atomic.io”
LabelThe label displayed when format is thumbnail or text.
E.g. “Find out more”

Support

Card editoriOS SDKAndroid SDKWeb SDK

Video

A video rendered in a specified format. If the video format is inline, the video plays inline. If the video format is text or thumbnail, the video plays full screen (on iOS and Android). Available in top-level and subview.

Supported video formats across our SDKs are outlined in the Supported media formats table.

Properties

PropertyDetail
FormatThe format to render the video in.
inline, displaying a video thumbnail with additional horizontal space on each side;
text, displaying a text link to view the video;
thumbnail, displaying a video thumbnail accompanied by a title and description.
Source URLThe video to play when the user taps or clicks the play button.
Thumbnail URLThe URL to the thumbnail image to display when the format is inline or thumbnail.
DescriptionA description of the video, displayed below the title when format is thumbnail.
LabelThe label displayed when format is thumbnail or text.

Support

Card editoriOS SDKAndroid SDKWeb SDK

Formats

Support for various common video and image formats are outlined in the tables below.

Non-exhaustive lists

These are not intended as exhaustive lists, but as a guide only. Depending on the browsers or operating systems you target, there may be additional media formats that you can use.

Image formatiOSAndroidWeb
JPEG
PNG
GIF
Animated GIF
SVG
Video formatiOSAndroidWeb
MP4
M4V
MOV
HLS
(Safari only)
MKV
3GP

Image and video dimensions

By default, images and videos are scaled to fill the width of the containing card, which is defined by the width of the SDK container. The dimensions of their initial state do not adhere to a specific aspect ratio, but have predefined heights, with image content centered within this area. This helps prevent cards from growing too tall when the SDK is wide. Depending on the variant, the following dimensions will be used.

Always use high-resolution images, especially when they will be viewed on mobile devices with high-density displays.

VariantHeightWidth
Banner200pxFlexible
Inline200pxFlexible
Thumbnail100px100px

If displaying an entire image or video without cropping is important to view the additional detail, customers can do so by tapping them to open them in a subview. Here, they are displayed in their original aspect ratio.

Images safe areas

Include plenty of space around key elements within your images, as they may be cropped at different aspect ratios depending on the device they will be viewed on.

The element displaying banner and inline images have a predefined height of 200px. Images are centred vertically and horizontally within the element.

You should always test how your cards display across multiple devices and platforms – as cropping of banner and inline image elements will vary depending on the platform, device model, and if the device is rotated.

Image crops on cards displayed in the web SDK will depend on the width of the iframe, and can easily be tested via Atomic Connect.

Use images with aspect ratio of 2:1 for banner and inline elements

We recommend creating images with an aspect ratio of 2:1 – this works best with banner and inline image elements, across platform, device and rotation. The exception is the thumbnail element: that has an aspect ratio of 1:1.

The following is an approximate guide to the amount of cropping an image may have, based on some common aspect ratios. The crop percentages are based on our own testing across a number of devices (a mix of iOS and Android, phone and tablet). We can not guarantee exact percentages for specific devices - always perform your own testing.

2:1Mobile: PortraitMobile: LandscapeTablet: PortraitTablet: Landscape
Banner~5% right & left~20% top & bottom~25% top & bottom~30% top & bottom
Inline~10% right & left~20% top & bottom~25% top & bottom~30% top & bottom


1:1Mobile: PortraitMobile: LandscapeTablet: PortraitTablet: Landscape
Banner~20% top & bottom~35% top & bottom~35% top & bottom~30% top & bottom
Inline~20% top & bottom~35% top & bottom~35% top & bottom~30% top & bottom
4:3Mobile: PortraitMobile: LandscapeTablet: PortraitTablet: Landscape
Banner~15% top & bottom~30% top & bottom~35% top & bottom~45% top & bottom
Inline~10% top & bottom~30% top & bottom~35% top & bottom~45% top & bottom
3:2Mobile: PortraitMobile: LandscapeTablet: PortraitTablet: Landscape
Banner~10% top & bottom~30% top & bottom~30% top & bottom~35% top & bottom
Inline~5% top & bottom~30% top & bottom~30% top & bottom~35% top & bottom
16:9Mobile: PortraitMobile: LandscapeTablet: PortraitTablet: Landscape
Banner~5% top and bottom~25% top & bottom~30% top & bottom~35% top & bottom
Inline~5% left & right~25% top & bottom~30% top & bottom~35% top & bottom