Textblock
Design System - Textblock component
The Text Block component provides a structured typographic layout, combining various levels of hierarchy such as headings, subheadings, captions, and descriptions. It ensures clarity, consistency, and adaptability in presenting textual information across different screens and use cases.
// Sample code
<CheckBox
label="Label"
onChange={(e)=>{console.log(e.target.checked}}
/>Anatomy
Variants
Default
The default Text Block displays a structured combination of a caption, heading, subheading, and description. Each section can be individually toggled on or off based on the context or content requirement.
Properties
Heading Label
Displays a prominent title or main heading. Turning this off removes the main visual anchor of the text block.
Subheading Label
Adds supporting information below the heading. Can be turned off to simplify the text hierarchy.
Caption Label
Offers a small label above the heading, often used for categorization or section labeling.
Description Label
Provides a detailed explanation or contextual information below the subheading. Turning it off results in a more compact block.
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.
wrapperClassName
text
headerContentClassName
text
caption
yes/no
no
captionClassName
yes/no
no
header
number
headerClasName
yes/no
subHeader
yes/no
no
subHeaderClasName
yes/no
no
body
yes/no
no
bodyClasName
number
no
style
yes/no
no
Usage Guide
Use Textblocks for Clear and Structured Content
Use Textblocks to present readable, well-organised text with proper hierarchy (e.g., headings, subheadings, and body).
Never use Textblocks inconsistently or without a logical structure.
Changelog
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.
Writing 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?