Update
Display changelog entries with dates, tags, and anchor links
The Update component creates timeline-style changelog entries with automatic anchor links for navigation. Perfect for "What's New" pages, API changelogs, and release notes.
Basic Usage
Added support for dark mode across all themes.
<Update label="January 10, 2025">
Added support for dark mode across all themes.
</Update>With Description
Add context below the date:
Breaking change
The getData() function now requires an options object.
<Update label="January 5, 2025" description="Breaking change">
The `getData()` function now requires an options object.
</Update>With Tags
Categorize entries with tags:
- Removed deprecated
legacyModeoption - Updated authentication flow
<Update label="December 20, 2024" tags={["breaking", "api"]}>
- Removed deprecated `legacyMode` option
- Updated authentication flow
</Update>Multiple Entries
Stack Update components for a complete changelog:
New export functionality for PDF and CSV formats.
Fixed timezone handling in scheduled posts.
The v1 API endpoints are now deprecated. Migrate to v2 by March 2025.
Anchor Links
Each Update automatically generates an anchor ID from its label:
label="January 10, 2025"creates#january-10-2025label="v2.0 Release"creates#v2-0-release
Link directly to entries: [See January update](#january-10-2025)
Table of Contents Integration
Update labels automatically appear in the right sidebar Table of Contents. This enables quick navigation on changelog pages without any additional configuration. The TOC displays all your Update labels alongside regular headings.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
label | string | - | Date or version label (creates anchor ID) |
description | string | - | Secondary text below the label |
tags | string[] | - | Category tags displayed as badges |
Best Practices
Each label creates an anchor ID, so use unique labels to ensure proper deep linking:
- Use specific dates:
January 10, 2025(not justJanuary 2025) - Include version numbers:
v2.1.0vsv2.0.0 - Duplicate labels will create duplicate IDs, breaking anchor navigation
Pick one format and stick with it:
January 10, 2025(recommended)2025-01-10(ISO format)v2.0.0(for version-based changelogs)
Common tags with automatic color coding:
| Tag | Color | Use for |
|---|---|---|
breaking | Red | Breaking changes |
feature / new | Green | New functionality |
deprecation / deprecated | Amber | Deprecated features |
| Other tags | Gray | General categories like api, fix |
- Lead with the most important change
- Use bullet points for multiple items
- Link to detailed docs for complex changes