List Collection

PreviousNext

A flexible list collection component for displaying vertical lists with images, titles, descriptions, and action menus

A versatile List Collection component for vertical list layouts with images, stacked content (title, description, meta), and dropdown action menus.

Basic Usage

The simplest form displays a vertical list with default styling and separators between items.

Project Alpha

Active

Project Alpha

Innovative design system implementation

Project Beta

In Progress

Project Beta

Next-generation user interface redesign

Project Gamma

Planning

Project Gamma

Mobile app performance optimization

Card Variant

Use variant="card" for elevated cards with shadows.

Q4 Marketing Strategy

Active

Q4 Marketing Strategy

Comprehensive plan for product launches

Brand Guidelines 2024

Draft

Brand Guidelines 2024

Updated visual identity standards

Action Menus

Add dropdown action menus to list items using the actions prop. Actions appear as a 3-dots menu on the right side.

Facilitator

Sarah Johnson

Group facilitator, Tuesday evening group

Facilitator

Thabo Nkosi

Programme facilitator, Exodus Recovery Skills

Member

Emma Williams

In active recovery, 6 months

Custom Meta Rendering

Use renderMeta to display badges, icons, or custom components for the meta content.

Facilitator Handbook
Active

Facilitator Handbook

Operational guide for running recovery groups

Safeguarding Policy
Active

Safeguarding Policy

Member safety and reporting procedures

Group Marketing Pack
Draft

Group Marketing Pack

Posters and social assets for your group

Legacy Programme Notes
Archived

Legacy Programme Notes

Archived session notes from a retired programme

Clickable Items

Make entire list items clickable using href for links or onItemClick for custom handlers.

Props Reference

ListCollectionProps

PropTypeDefaultDescription
itemsListCollectionItem[]RequiredArray of items to display
size"default" | "compact""default"Size variant controlling spacing and typography
variant"default" | "card""default"Visual style variant
imageShape"square" | "circle""square"Shape of item images
titleStyle"simple" | "bold""simple"Font weight for titles
metaPosition"above-title" | "below-title""above-title"Position of meta content
limitnumberundefinedMaximum number of items to display
onItemClick(item, index) => voidundefinedHandler for item clicks
renderMeta(meta, item) => ReactNodeundefinedCustom meta renderer
renderActions(item, index) => ReactNodeundefinedCustom actions renderer
clampTitleboolean | numberundefinedClamp title text (true = 2 lines, or specify number)
clampDescriptionboolean | numberundefinedClamp description text (true = 2 lines, or specify number)
itemAs"div" | "article""article"HTML element for items
classNamestringundefinedAdditional CSS classes

ListCollectionItem

PropTypeRequiredDescription
titlestringYesItem title
descriptionstringNoItem description
metastring | ReactNodeNoMeta content (category, date, status)
imagestringNoImage URL
imageAltstringNoAlt text for image
idstring | numberNoUnique identifier
hrefstringNoLink URL (makes item a link)
onClick() => voidNoClick handler for this item
imageShape"square" | "circle"NoOverride collection imageShape
titleStyle"simple" | "bold"NoOverride collection titleStyle
metaPosition"above-title" | "below-title"NoOverride collection metaPosition
actionsListCollectionAction[]NoAction menu items
ariaLabelstringNoAccessibility label

ListCollectionAction

PropTypeRequiredDescription
labelstringYesAction label
onClick() => voidYesAction handler
variant"default" | "destructive"NoAction variant
iconReactNodeNoOptional icon