CivicTheme
  • Docs
  • Changelog
  • Getting started
    • Introduction
    • Installation
    • Getting help
    • Security policy
    • Partnerships
  • Installation
    • Drupal theme
  • Contributing
    • Contribution model
    • Contribution basics
    • Small contribution spec
    • Medium contribution spec
    • Major (RFC-level) contribution spec
    • Code of conduct
    • Figma contributions
  • Components
    • Component list
    • Atoms
      • Button
      • Chip
      • Content link
      • Check box
      • Field description
      • Field message
      • Fieldset
      • Label
      • Radio
      • Select
      • Textarea
      • Text field
      • Heading
      • Link
      • Paragraph
      • Popover
      • Quote
      • Table
      • Tag
      • Text list
    • Molecules
      • Accordion
      • Attachment
      • Breadcrumb
      • Callout
      • Event Card
      • Field
      • Figure
      • Group filter
      • Logo
      • Map
      • Navigation card
      • Next step
      • Pagination
      • Promo card
      • Search
      • Service card
      • Single filter
      • Snippet
      • Subject Card
      • Table of Contents
      • Tabs
      • Tag List
      • Tooltip
      • Video Player
    • Organisms
      • Alert
      • Banner
      • Campaign
      • Footer
      • Header
      • List
      • Message
      • Mobile Navigation
      • Navigation
      • Promo
      • Side Navigation
      • Skip link
      • Slider
      • Social links
  • Content Authoring
    • Overview
    • Global settings
      • Favicon
      • Header
        • Site slogan
        • Header logos
        • Primary navigation
        • Secondary navigation
      • Banner
      • Search
      • Link
      • Skip link
      • Side navigation
      • Signup
      • Footer
        • Footer logo
        • Social links
        • Footer navigation
        • Acknowledgement of Country
        • Copyright
      • Colours
    • Content types
      • Page
        • Configure the banner
      • Event
      • Alert
    • Content components
      • Accordion
      • Automated list
      • Attachment
      • Callout
      • Campaign
      • Content
        • Quote
      • iFrame
      • Manual List
        • Event card
        • Event reference card
        • Navigation card
        • Navigation reference card
        • Promo card
        • Promo reference card
        • Publication card
        • Service card
        • Subject card
        • Subject reference card
        • Snippet
      • Map
      • Next step
      • Promo
      • Slider
      • Webform
    • Vocabularies
      • Topics
      • Site sections
    • User accounts & roles
Powered by GitBook
On this page
  • When to use
  • When not to use
  • Best practice guidelines
  • Variations
  • Accessibility
  • Security
  • Component inspiration and uplift
  • User research on this component
  • Known issues
  • More research needed
  • Help improve this component
  • Resources
  • References
  • Changelog
  • Contact us

Was this helpful?

Edit on GitHub
Export as PDF
  1. Components
  2. Molecules

Promo card

A visually distinctive container that highlights key content, promotions, or calls to action to draw user attention within the interface.

When to use

Use the Promo Card component when you need to:

  • Highlight important content, promotions, or offers to users

  • Draw attention to specific features, events, or services on your website

  • Group related content into a visually distinct, scannable format

  • Display tertiary information in a visually appealing way

  • Encourage user action through prominent calls to action

  • Promote content across multiple sections of a website

When not to use

Do not use the Promo Card component when:

  • The information being displayed is primary content that should be part of the main page flow

  • The information requires detailed explanations or lengthy content that would make the card too text-heavy

  • The content is critical for all users to see and should not risk being overlooked

  • A more specific card type (such as Event Card, Publication Card, or Service Card) would better meet your needs

  • You need to display complex, structured data that would be better presented in a table format


Best practice guidelines

  • Clear hierarchy: Establish a clear visual hierarchy with a prominent headline and concise supporting text. Limit headings to 2-3 lines for optimal readability.

  • Focused content: Keep card content focused on a single topic or purpose to ensure clarity and prevent cognitive overload.

  • Visual consistency: Maintain consistent spacing, typography, and imagery across cards to create a cohesive experience.

  • Actionable elements: Include clear, descriptive calls to action that indicate what will happen when users interact with the card.

  • Responsive design: Ensure cards adapt appropriately to different screen sizes, with text remaining readable and actions accessible on mobile devices.

  • Appropriate imagery: When using images, select ones that are relevant to the content and enhance understanding rather than serving as mere decoration.

  • Accessibility consideration: Ensure sufficient colour contrast between text and background for readability, and maintain clear focus states for keyboard navigation.

  • Limit options: Avoid overwhelming users with too many calls to action; ideally, limit primary actions to one or two per card.

  • Scalable content: Design for variable content lengths by establishing minimum and maximum character counts for headings and descriptions.

Variations

  • With link / Without link: The card can function as either a clickable element or a static information display.

  • With image / Without image: Cards can incorporate imagery to enhance visual appeal or focus solely on text content.

  • Multiple buttons: Cards can include multiple call-to-action buttons for different user pathways.


Accessibility

Based on the CivicTheme v1.7.0 Accessibility Assessments document, the Promo Card component has been tested against WCAG 2.2 standards.

Summary of the most recent accessibility test results:

WCAG Criterion
Level
Compliance Notes

1.1.1 Non-text Content

A

The image is considered decoration and can be ignored by screen readers

1.4.3 Contrast (Minimum)

AA

Contrast meets the minimum 4.5:1 ratio

1.4.4 Resize text

AA

Text is still visible and readable when resized to at least 200%

1.4.12 Text Spacing

AA

Text is visible/readable when the line spacing is at least 1.5 times the font size, letter spacing is at least 0.12 times the font size, and word spacing is at least 0.16 times the font size

2.1.1 Keyboard

A

Elements are accessible using a keyboard only

2.4.4 Link Purpose (In Context)

A

The purpose of each link can be determined from the text alone

2.4.7 Focus Visible

AA

Focus is visible when navigating using a keyboard

4.1.2 Name, Role, Value

A

For all elements, the name and role can be programmatically determined

Security

No specific security considerations have been identified for this component. Standard web security practices should be followed for any interactive elements within the card.

Component inspiration and uplift

The Promo Card component has been modelled after the Card component from the Australian Government Design System (AGDS). It has been uplifted by Salsa Digital, as the custodian of the CivicTheme Design System, in the following ways:

  • Enhanced visual hierarchy: Includes additional attributes such as date and topic tags to provide more context and metadata.

  • Improved imagery integration: The ability to include relevant images within the card has been added for enhanced visual engagement.

  • Elevation enhancements: Elevation shadows have been more prominently used to emphasise hierarchy and encourage interactions.

  • Interactive indicators: The addition of a right-arrow icon (with link state) provides a visual cue that the card will navigate the reader to a new page.

  • Tag improvements: Replaced the Tag component with a Tag List component to allow multiple tags in one row.

  • Typography enhancement: Updated the heading size from 5 to 4 to make it visually larger and more accessible.

  • Simplified interaction model: Removal of the card title's default link underline for a cleaner appearance.

  • Modernised variations: Updated interactive states to Link and Without Link for more explicit interaction patterns.

These uplifts provide more flexibility and visual clarity while enhancing the accessibility and usability of the component.


User research on this component

★★★☆☆ Confidence rating = Medium (Limited research data available)

Based on the available information about Promo Cards in the CivicTheme documentation, there has been some research conducted on card component patterns as part of the design system development. However, specific user research data focused exclusively on the Promo Card component is limited.

The medium confidence rating reflects that while card patterns in general are well-established in user interface design with substantial research supporting their effectiveness, documentation of CivicTheme-specific user testing for this particular component variation is not comprehensive.

Research with users has shown that cards are generally effective at:

  • Helping users scan content quickly

  • Drawing attention to promotional or featured content

  • Providing clear pathways to more detailed information

However, specific performance metrics and detailed user feedback for this particular component implementation would require additional research.

Known issues

  • Mobile responsiveness: On smaller screen sizes, there may be challenges with maintaining the proper visual hierarchy and ensuring call-to-action buttons remain sufficiently prominent.

  • Content constraints: When card content exceeds recommended character limits, there is a risk of inconsistent appearance across a set of cards which can reduce the effectiveness of the component.

  • Multiple CTAs: When multiple call-to-action buttons are implemented, users may experience decision paralysis or confusion about the primary action they should take.

More research needed

More user research is needed in the following areas:

  • Effectiveness metrics: Quantitative research on conversion rates and engagement metrics for different Promo Card variations would help optimise the component design.

  • Mobile interaction patterns: Further research on how users interact with Promo Cards on mobile devices could inform more targeted responsive design approaches.

  • Content limits: Testing different content lengths and formats would help establish more definitive character limits and content guidelines.

  • Visual hierarchy impact: Research on how different visual elements (imagery, buttons, tags) impact user perception and interaction with the component.

If you have conducted user research that addresses any of these gaps, you can submit your research findings to help improve this component.

Help improve this component

To help make this component useful and up-to-date, you can:

  • Contribute to our Promo Card component discussion

  • Submit your user research findings to help improve the Promo Card component

  • Propose a change to the Promo Card component

Check out our contributing section to learn more.


Resources

  • Figma

  • Storybook

  • GitHub

References

  • Australian Government Digital Service Standard. (2024)

  • Nielsen Norman Group. (2019). "Cards: UI-Component Definition"

  • WCAG 2.2. (2023). Web Content Accessibility Guidelines. W3C

Changelog

Version
Date
Changes

1.8.0

23 Jul 2024

Renamed Card: Promo to Promo Card

1.7.0

Prior

Updated interactive states to Link and Without Link. Updated the heading size from 5 to 4.

Contact us

If you have a question about the CivicTheme design system or need our help, visit the Getting Help page for guidance.

PreviousPaginationNextSearch

Last updated 1 month ago

Was this helpful?