---
title: Feed
description: Feeds structure a stream of articles or activity items with consistent header, content, and action regions.
---

import { meta as FeedMeta, Default } from '@/content/stories/feed';
import Canvas from '@/components/component-docs/canvas';
import Demo from '@/components/component-docs/demo';

export const config = {
	dependencies: {
		components: [Canvas, Demo],
		scripts: [
			'../../../components/component-docs/demo.script.tsx',
			'../../../components/component-docs/canvas.script.tsx',
			'../../../components/component-docs/controls.script.tsx',
		],
	},
};


# Feed

<p class="docs-lede">Feeds structure a stream of articles or activity items with consistent header, content, and action regions.</p>

## Try it

<Demo of={Default} meta={FeedMeta} />

## Usage

Use `RuiFeedArticle` for each item. Compose bylines, metadata, and actions with the dedicated sub-components.

```tsx
import {
  RuiFeed,
  RuiFeedArticle,
  RuiFeedArticleHeader,
  RuiFeedArticleContent,
  RuiFeedByline,
} from '@ecopages/radiant-ui/feed';

<RuiFeed label="Activity">
  <RuiFeedArticle>
    <RuiFeedArticleHeader>
      <RuiFeedByline>Jane Cooper · 2 hours ago</RuiFeedByline>
    </RuiFeedArticleHeader>
    <RuiFeedArticleContent>Shipped order #4821.</RuiFeedArticleContent>
  </RuiFeedArticle>
</RuiFeed>
```

## Consistent article structure

<p>Keep header, content, and actions in the same order across items so users can scan the feed quickly.</p>

## Loading state

<p>Set `aria-busy` on the feed while fetching new items so assistive technologies announce the update.</p>

## Theming

Feed maps to **semantic surface and border roles**, never Tailwind palette steps:

| Part | CSS roles |
| --- | --- |
| Article surface (`rui-feed__article`) | `surface-container-lowest`, `border`, `radius-container` |
| Article hover | `background`, `border`, `shadow-control` |
| Meta / content / location | `on-surface` |
| Rating | `on-background`, `primary` |
| Meta separators | `border` |
| Focus | `focus-ring` |
| Geometry | `--space-*` scale (inline gap, inset padding, stack gaps) |

Override at the theme layer, not in component CSS.

## API

`RuiFeed` and its article helpers are presentational JSX views, no custom element.

### Props

| Component | Prop | Type | Default | Description |
| --- | --- | --- | --- | --- |
| `RuiFeed` | `label` | `string` | | Accessible name for the `feed` landmark. |
| `RuiFeed` | `aria-labelledby` | `string` | | Id of a visible heading that labels the feed. |
| `RuiFeed` | `aria-busy` | `boolean` | | Announce that more items are loading (APG). |
| `RuiFeedArticle` | `posinset` | `number` | | 1-based position in the feed. |
| `RuiFeedArticle` | `setsize` | `number` | | Total articles currently in the feed. |
| `RuiFeedArticle` | `labelledBy` | `string` | | Id(s) of the distinguishing label element(s). |
| `RuiFeedArticle` | `describedBy` | `string` | | Id(s) that summarize the article for skimming. |
| `RuiFeedArticle` | `tabindex` | `number` | `0` | Make the article focusable (APG feed navigation). |

### CSS classes

Public BEM classes on the rendered elements (documented via `@cssclass`):

| Class | Description |
| --- | --- |
| `.rui-feed` | Feed region (`role="feed"`). |
| `.rui-feed__article` | Article card surface. |
| `.rui-feed__header` | Article header stack. |
| `.rui-feed__byline` | Avatar + identity row. |
| `.rui-feed__byline-body` | Identity text stack. |
| `.rui-feed__meta` | Metadata row. |
| `.rui-feed__content` | Article body column. |
| `.rui-feed__actions` | Action row under a top border. |

### Theme roles

| Part | CSS variables consumed |
| --- | --- |
| Article surface | `--surface-container-lowest`, `--border`, `--radius-container` |
| Article hover | `--background`, `--border`, `--shadow-control` |
| Meta / content / location | `--on-surface` |
| Rating | `--on-background`, `--primary` |
| Meta separators | `--border` |
| Focus | `--focus-ring` |
| Geometry | `--space-inline`, `--space-inset`, `--space-2` … `--space-6` |

## Accessibility

- Label the feed region with the `label` prop or an external heading.
- Each article should have a discernible title or summary in the header.
- Action buttons inside articles need descriptive labels, not just icons.