npm package: @o2s/blocks.article-list
Description: Block for displaying a list of articles.
Latest version: 1.8.3

# @o2s/blocks.article-list

Block for displaying a list of articles.

The article-list block shows a feed of articles, ideal for "latest articles" sections, category landing pages, or knowledge base browsability. Content editors configure the limit (how many to show) and optionally filter by category. The block supports pagination so users can browse larger collections.

- **Configurable limit** – Control how many articles appear (e.g. 3, 6, 10)
- **Category filter** – Optionally display only articles from a given category
- **Pagination** – Load more or navigate pages for larger lists
- **CMS-driven** – Block placement and labels configured via CMS

Content editors choose which category (if any) to feature and how many articles to display. Developers get a flexible article feed that works with any Articles integration.

## Domain

**Domain:** Content

## Installation

```bash
npm install @o2s/blocks.article-list
```

## Usage

### Backend (API Harmonization)

Register the block in `app.module.ts`:

```typescript
import * as ArticleList from '@o2s/blocks.article-list/api-harmonization';
import { AppConfig } from './app.config';

@Module({
    imports: [
        ArticleList.Module.register(AppConfig),
    ],
})
export class AppModule {}
```

### Frontend

Register the block in `renderBlocks.tsx`:

```typescript
import * as ArticleList from '@o2s/blocks.article-list/frontend';

export const renderBlocks = async (blocks: CMS.Model.Page.SlotBlock[]) => {
    return blocks.map((block) => {
        if (block.type === 'article-list') {
            return (
                <ArticleList.ArticleListRenderer
                    key={block.id}
                    id={block.id}
                    slug={slug}
                    locale={locale}
                    accessToken={session?.accessToken}
                    userId={session?.user?.id}
                    routing={routing}
                />
            );
        }
        // ... other blocks
    });
};
```

### SDK

Use the SDK to fetch article list:

```typescript
import { sdk } from '@o2s/blocks.article-list/sdk';

// SDK uses NEXT_PUBLIC_API_URL for the API base URL
const articleList = await sdk.blocks.getArticleList(
    { id: 'block-id' },
    { 'x-locale': 'en' },
    accessToken
);
```

## Configuration

This block requires the following integrations to be configured in `AppConfig`:

```typescript
import { Articles, CMS } from '@o2s/configs.integrations';

export const AppConfig: ApiConfig = {
    integrations: {
        articles: Articles.ArticlesIntegrationConfig,  // Required
        cms: CMS.CmsIntegrationConfig,                 // Required
    },
};
```

## Environment Variables

The required environment variables depend on which CMS integration you're using:

- **For Strapi CMS**: See `@o2s/integrations.strapi-cms` documentation
- **For Contentful CMS**: See `@o2s/integrations.contentful-cms` documentation
- **For mocked integration**: No additional environment variables needed

## API

### Block Endpoint

```
GET /api/blocks/article-list/:id
```

**Headers:**
- `x-locale`: Content locale (required)

**Response:**

```typescript
{
    id: string;
    data: {
        articles: Article[];
        pagination: Pagination;
    };
}
```

## Related Blocks

- `@o2s/blocks.article`
- `@o2s/blocks.article-search`
- `@o2s/blocks.category`
- `@o2s/blocks.category-list`
- `@o2s/blocks.faq`
- `@o2s/blocks.document-list`


## About Blocks in O2S

Blocks are self-contained, reusable UI components that combine harmonizing and frontend components into a single package. Each block is independently packaged as an NPM module and includes three primary parts: API Harmonization Module, Frontend Components, and SDK Methods. Blocks allow you to quickly add or remove functionality without impacting other components of the application.

- **See all blocks**: [Blocks Documentation](https://www.openselfservice.com/docs/main-components/blocks/)
- **View this block in Storybook**: [article-list](https://storybook-o2s.openselfservice.com/?path=/story/blocks-articlelist--default)

## About O2S

**Part of [Open Self Service (O2S)](https://www.openselfservice.com/)** - an open-source framework for building composable customer self-service portals. O2S simplifies integration of multiple headless APIs into a scalable frontend, providing an API-agnostic architecture with a normalization layer.

- **Website**: [https://www.openselfservice.com/](https://www.openselfservice.com/)
- **GitHub**: [https://github.com/o2sdev/openselfservice](https://github.com/o2sdev/openselfservice)
- **Documentation**: [https://www.openselfservice.com/docs](https://www.openselfservice.com/docs)