Panel Card

Design System - Panel Card component

The Panel Card component is a composite component designed to communicate clear, high-visibility feedback messages, typically success or error outcomes. It brings together an icon, message, optional description, interactive actions, and optional widgets into one cohesive layout.

// Sample code

  <CheckBox
    label="Label"
    onChange={(e)=>{console.log(e.target.checked}}
  />

Anatomy

Variants


Success Panel

Displays a confirmation message indicating successful operations and uses a green colour scheme with success iconography and optional ID or confirmation number.

Error Panel Indicates failure or issues in the process, and this feature has a red colour scheme with an error icon, and optionally includes details on what failed and how to resolve it.

Properties

Description

Toggle the presence of additional descriptive text below the main message.

Edit Description Enables inline editing of the description field when required, allowing admins or users to update metadata or identifiers dynamically..

Actions Supports one or more action buttons such as “Go Back,” “Continue,” “Retry,” or custom CTAs.

Additional Widgets Includes optional elements like info cards, links, or nested content to provide supplementary guidance or system feedback.

Property Configuration Table

Each design component offers a range of configurable options. These options are intentionally platform-agnostic, allowing implementations to adapt and tailor them to align with the specific requirements of the chosen framework.

Property
Value
Default

className

text

-

style

text

-

children

yes/no

-

footerChildren

yes/no

-

message

number

-

type

yes/no

false

info

yes/no

-

response

yes/no

-

customIcon

yes/no

0

iconFill

number

false

multipleResponses

yes/no

-

footerclassName

yes/no

false

footerStyles

yes/no

-

cardClassName

yes/no

-

cardStyles

yes/no

-

maxFooterButtonsAllowed

yes/no

-

sortFooterButtons

yes/no

-

showChildrenInline

yes/no

-

description

yes/no

-

Usage Guide


Provide specific feedback

Display a unique reference ID, transaction number, or message that helps users verify or follow up.

Leave users guessing with vague messages like “Request submitted” without additional traceable context.

Change log


Date
Number
Notes

Dec 15, 2024

v-0.0.2

This component is added to the website. This component is now individually versioned.

Design Checklist


All interactive states - Includes all interactive states that are applicable (hover, down, focus, keyboard focus, disabled).

Accessible use of colours - Colour is not used as the only visual means of conveying information (WCAG 2.1 1.4.1)

Accessible contrast for text - Text has a contrast ratio of at least 4.5:1 for small text and at least 3:1 for large text (WCAG 2.0 1.4.3).

Accessible contrast for UI components - Visual information required to identify components and states (except inactive components) has a contrast ratio of at least 3:1 (WCAG 2.1 1.4.11).

Keyboard interactions - Includes all interactive states that are applicable (hover, down, focus, keyboard focus, disabled).

Screen reader accessible - All content, including headings, labels, and descriptions, is meaningful, concise, contextual and accessible by screen readers.

Responsive for all breakpoints - Responsiveness for 3 breakpoints - Mobile, Tablet and Desktop

Usage guidelines - Includes a list of dos and don'ts that highlight best practices and common mistakes.

Content guidelines - Content standards and usage guidelines for writing and formatting in-product content for the component.

Defined variants and properties - Includes relevant variants and properties (style, size, orientation, optional iconography, decorative elements, selection states, error states, etc.)

Defined behaviours - Guidelines for keyboard navigation and focus, layout management (including wrapping, truncation, and overflow), animations, and user interactions.

Design Kit - Access to the design file for the component in Figma, multiple options, states, colour themes, and platform scales.

Last updated

Was this helpful?