Pop Ups

Design System - Pop Up component

The Popups Card component is a focused, interruptive component used to convey critical information or require immediate user interaction. It follows DIGIT’s principles of accessibility, responsiveness, and contextual clarity to ensure that users are guided without ambiguity and can take informed action without navigating away from their current flow.

Component React

// Sample code

<PopUp
  alertHeading=""
  alertMessage=""
  className=""
  customIcon=""
  description="Please contact the administrator if you have forgotten your password."
  equalWidthButtons
  footerChildren={[
    <Button label="Cancel" onClick={() => {}} type="button"/>,
    <Button icon="FileDownload" label="Download Template" onClick={function noRefCheck() {}} type="submit"/>
  ]}
  footerStyles={{}}
  footerclassName=""
  headerMaxLength=""
  headerclassName=""
  heading="Heading"
  iconFill=""
  maxFooterButtonsAllowed={5}
  onClose={function noRefCheck() {}}
  onOverlayClick={function noRefCheck() {}}
  overlayClassName=""
  props={{}}
  showIcon
  sortFooterButtons
  style={{}}
  subHeaderMaxLength=""
  subheading="Subheading"
  type="default"
>
  <div>
    This is the content of the Popup
  </div>
  <AlertCard
    className="popup-alert-card"
    text="This is an alert card"
  />
</PopUp>

Component Flutter

Component Design

Anatomy

Variants

---

	Default Displays informative messages or prompts for user actions with optional titles, descriptions, and buttons.
	Alert Used to communicate critical errors or system-level alerts, typically styled in red with an alert icon to grab attention.

Properties

Icon for heading Both variants support contextual icons next to headings, such as info or warning icons, to enhance clarity and visual hierarchy.
Descriptions A paragraph below the heading provides additional details or instructions for the user.
Action buttons Configurable with either a single primary button or both primary and secondary actions, allowing flexible interaction.
Custom height & width The component adapts to mobile, tablet, and desktop screen sizes, with scalable height and width to maintain visual balance and usability, adjusting the button's height and font size.

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.

React

Property	Value	Default
className	text	-
style	text	-
children	yes/no	no
headerclassName	yes/no	no
footerclassName	number	-
footerStyles	yes/no	-
footerChildren	yes/no	no
maxFooterButtonsAllowed	yes/no	no
sortFooterButtons	yes/no	no
equalWidthButtons	number	no
onClose	yes/no	no
onOverlayClick	yes/no	no
type	yes/no	no
showIcon	yes/no	no
customIcon	yes/no	no
iconFill	yes/no	no
heading	yes/no	no
subheading	yes/no	no
headerMaxLength	yes/no	no
subHeaderMaxLength	yes/no	no
description	yes/no	no
showChildrenInline	yes/no	no
overlayClassName	yes/no	no
alertHeading	yes/no	no
alertMessage	yes/no	no
showAlertAsSvg	yes/no	no
showIcon	yes/no	no

Flutter

Usage Guide

---

	Prioritise user actions Use a clear call-to-action like “Continue” or “Submit” as the primary button, and pair it with a secondary option like “Cancel” when applicable. Don’t overload the pop-up with too many buttons or unclear labels that can confuse the user.

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.