Resource List
Compact entity lists with structured status, content and metadata but no tabular header.
Purpose
Use Resource List for compact entity collections such as contacts, tasks, leads or files that do not need a tabular header and strict columns.
Entity rows
Installation
With the Siteplane registry alias configured, add the component and import the installed source from your app.
CLI
pnpm dlx shadcn@4.16.1 add @siteplane/resource-listImport
import {
ResourceList,
ResourceListContent,
ResourceListDescription,
ResourceListIndicator,
ResourceListItem,
ResourceListMeta,
ResourceListTitle,
} from "@/components/ui/resource-list";Need the machine-readable source metadata? View registry JSON.
Usage
Use Resource List for compact entity rows. Use indicators for category accents and text for the actual meaning.
import { ResourceList, ResourceListContent, ResourceListItem, ResourceListTitle } from "@/components/ui/resource-list";
export function Example() {
return (
<ResourceList>
<ResourceListItem interactive>
<ResourceListContent><ResourceListTitle>Acme Co.</ResourceListTitle></ResourceListContent>
</ResourceListItem>
</ResourceList>
);
}Examples
Variants, density, item states and indicators are props of the same primitives.
Soft variant
variant="soft" wraps the rows in a tinted container for soft selection surfaces.
Compact density
density="compact" tightens gaps, row padding and meta size for sidebars and popovers.
Item states
Indicators
Shapes and tones are decorative accents; a labeled icon indicator becomes an image role.
Interactive list
Interactive items render as buttons and drive local selection state.
API Reference
The reference lists the source-owned exports and props that are easy to miss in visual examples. Inherited Base UI props remain available unless the wrapper narrows them.
ResourceListacceptsdensity="default" | "compact"andvariant="default" | "soft".- Compose
ResourceListItem,ResourceListIndicator,ResourceListContent,ResourceListTitle,ResourceListDescriptionandResourceListMeta. ResourceListItemacceptsinteractive,selected,active,disabledand Base UI'srenderprop for a semantic button or link.ResourceListIndicatorsupportsmuted,success,warning,info,errorandchart-1throughchart-5, plusbar,diamond,dotandringshapes.
Motion
Component motion uses the shared Siteplane motion contract. See the global motion guide for provider setup, tokens and reduced-motion behavior.
- Resource List uses quiet hover, active and selected state changes without row lift or entry animation.
- Indicator and selection changes do not alter row measurements; reduced motion requires no extra behavior.
Accessibility
- Interactive rows must render as semantic buttons or links and retain visible keyboard focus.
- Color indicators are supplementary. Provide status text, an icon label or another non-color explanation.
- Keep title, description and metadata in their named slots so reading order stays predictable.
Implementation Guidance
- Use Table for genuine column comparison and Resource List for lighter entity scanning.
- Use all available indicator tones through the documented
toneprop instead of adding local colors. - Do not simulate interactive rows with click handlers on non-focusable containers.