---
title: "Table badge"
description: "Use the table badges to create easily scannable tags for a record."
sidebar_label: "Table badge"
slug: /reference/components/table-badge
---

import ComponentDemo from '@site/src/components/ComponentDemo';

# Table badge

Use the table badges to create easily scannable tags for a record.

**Package:** `@terreno/ui`  
**Categories:** Component  
**Props interface:** `TableBadgeProps`  
**Story source:** [`demo/stories/Tablebadge.stories.tsx`](https://github.com/flourishhealth/terreno/blob/master/demo/stories/Tablebadge.stories.tsx)

## Live demo

<ComponentDemo name="Table badge" />

## Props

| Prop | Type | Required | Description |
| --- | --- | --- | --- |
| `value` | `string` | Yes | The value of the badge. |
| `badgeIconName` | `IconName` |  | The icon name of the badge. |
| `badgeStatus` | `union` |  | The status of the badge. |
| `editingOptions` | `array` |  | The options available for editing the badge. |
| `isEditing` | `boolean` |  | If true, the component is in editing mode. |
| `onSave` | `reflection` |  | The function to call when the badge status is saved. |