# Badge

Small pill-shaped status label with a colored dot for neutral, primary, success, warning, and danger.

- Category: Feedback
- Status: stable
- Registry: https://markas.jenderalcorp.com/r/badge.json
- CLI: `npx markasui@latest add badge`

## When to use

Marking a short status or category in tables, cards, or headings.

- Keep badge text to one or two words
- Do not turn a badge into a button or link
- Do not rely on color alone to convey status

## Code

### Blade

Save at `resources/views/components/markas/badge.blade.php`. No extra dependencies.

```blade
@props([
    'variant' => 'neutral',
    'dot' => true,
])

@php
    $base = 'inline-flex items-center gap-1.5 rounded-full border px-2.5 py-0.5 text-xs font-medium whitespace-nowrap';
    $variants = [
        'neutral' => 'border-line bg-subtle text-ink',
        'primary' => 'border-primary-line bg-primary-soft text-primary',
        'success' => 'border-success/30 bg-success/10 text-ink',
        'warning' => 'border-warning/30 bg-warning/10 text-ink',
        'danger' => 'border-danger/30 bg-danger/10 text-ink',
    ];
    $dotBase = 'size-1.5 shrink-0 rounded-full';
    $dots = [
        'neutral' => 'bg-muted',
        'primary' => 'bg-primary',
        'success' => 'bg-success',
        'warning' => 'bg-warning',
        'danger' => 'bg-danger',
    ];
@endphp

<span {{ $attributes->class([$base, $variants[$variant]]) }}>@if ($dot)<span class="{{ $dotBase }} {{ $dots[$variant] }}" aria-hidden="true"></span>@endif{{ $slot }}</span>
```

```blade
<x-markas.badge>Draft</x-markas.badge>
<x-markas.badge variant="success">Active</x-markas.badge>
<x-markas.badge variant="danger">Failed</x-markas.badge>
```

### React

Save at `src/components/markas/Badge.tsx`. No extra dependencies.

```tsx
import type { ComponentProps } from "react";

const base =
  "inline-flex items-center gap-1.5 rounded-full border px-2.5 py-0.5 text-xs font-medium whitespace-nowrap";
const variants = {
  neutral: "border-line bg-subtle text-ink",
  primary: "border-primary-line bg-primary-soft text-primary",
  success: "border-success/30 bg-success/10 text-ink",
  warning: "border-warning/30 bg-warning/10 text-ink",
  danger: "border-danger/30 bg-danger/10 text-ink",
};
const dotBase = "size-1.5 shrink-0 rounded-full";
const dots = {
  neutral: "bg-muted",
  primary: "bg-primary",
  success: "bg-success",
  warning: "bg-warning",
  danger: "bg-danger",
};
const cx = (...c: (string | false | null | undefined)[]) =>
  c.filter(Boolean).join(" ");

export type BadgeProps = ComponentProps<"span"> & {
  variant?: keyof typeof variants;
  /** Titik warna di depan teks. Matikan untuk badge berikon atau angka. */
  dot?: boolean;
};

export function Badge({
  variant = "neutral",
  dot = true,
  className,
  children,
  ...props
}: BadgeProps) {
  return (
    <span className={cx(base, variants[variant], className)} {...props}>
      {dot && (
        <span className={cx(dotBase, dots[variant])} aria-hidden="true" />
      )}
      {children}
    </span>
  );
}
```

```tsx
import { Badge } from "@/components/markas/Badge";

<Badge>Draft</Badge>
<Badge variant="success">Active</Badge>
<Badge variant="danger">Failed</Badge>
```

### Vue

Save at `src/components/markas/Badge.vue`. No extra dependencies.

```vue
<script setup lang="ts">
const props = withDefaults(
  defineProps<{
    variant?: "neutral" | "primary" | "success" | "warning" | "danger";
    dot?: boolean;
  }>(),
  { variant: "neutral", dot: true },
);

const base =
  "inline-flex items-center gap-1.5 rounded-full border px-2.5 py-0.5 text-xs font-medium whitespace-nowrap";
const variants = {
  neutral: "border-line bg-subtle text-ink",
  primary: "border-primary-line bg-primary-soft text-primary",
  success: "border-success/30 bg-success/10 text-ink",
  warning: "border-warning/30 bg-warning/10 text-ink",
  danger: "border-danger/30 bg-danger/10 text-ink",
};
const dotBase = "size-1.5 shrink-0 rounded-full";
const dots = {
  neutral: "bg-muted",
  primary: "bg-primary",
  success: "bg-success",
  warning: "bg-warning",
  danger: "bg-danger",
};
</script>

<template>
  <span :class="[base, variants[props.variant]]"
    ><span
      v-if="props.dot"
      :class="[dotBase, dots[props.variant]]"
      aria-hidden="true" /><slot
  /></span>
</template>
```

```vue
<script setup lang="ts">
import Badge from "@/components/markas/Badge.vue";
</script>

<template>
  <Badge>Draft</Badge>
  <Badge variant="success">Active</Badge>
  <Badge variant="danger">Failed</Badge>
</template>
```

### Svelte

Save at `src/lib/components/markas/Badge.svelte`. No extra dependencies.

```svelte
<script lang="ts">
  import type { Snippet } from "svelte";
  import type { HTMLAttributes } from "svelte/elements";

  const base =
    "inline-flex items-center gap-1.5 rounded-full border px-2.5 py-0.5 text-xs font-medium whitespace-nowrap";
  const variants = {
    neutral: "border-line bg-subtle text-ink",
    primary: "border-primary-line bg-primary-soft text-primary",
    success: "border-success/30 bg-success/10 text-ink",
    warning: "border-warning/30 bg-warning/10 text-ink",
    danger: "border-danger/30 bg-danger/10 text-ink",
  };
  const dotBase = "size-1.5 shrink-0 rounded-full";
  const dots = {
    neutral: "bg-muted",
    primary: "bg-primary",
    success: "bg-success",
    warning: "bg-warning",
    danger: "bg-danger",
  };

  type Props = HTMLAttributes<HTMLSpanElement> & {
    variant?: keyof typeof variants;
    /** Colored dot before the text. Turn it off for badges with an icon or a number. */
    dot?: boolean;
    children?: Snippet;
  };

  let {
    variant = "neutral",
    dot = true,
    class: className,
    children,
    ...rest
  }: Props = $props();
</script>

<span class={[base, variants[variant], className]} {...rest}
  >{#if dot}<span class={[dotBase, dots[variant]]} aria-hidden="true"
    ></span>{/if}{@render children?.()}</span
>
```

```svelte
<script lang="ts">
  import Badge from "$lib/components/markas/Badge.svelte";
</script>

<Badge variant="success">Active</Badge>
<Badge variant="primary" dot={false}>12</Badge>
```

### Astro

Save at `src/components/markas/Badge.astro`. No extra dependencies.

```astro
---
import type { HTMLAttributes } from "astro/types";

const base =
  "inline-flex items-center gap-1.5 rounded-full border px-2.5 py-0.5 text-xs font-medium whitespace-nowrap";
const variants = {
  neutral: "border-line bg-subtle text-ink",
  primary: "border-primary-line bg-primary-soft text-primary",
  success: "border-success/30 bg-success/10 text-ink",
  warning: "border-warning/30 bg-warning/10 text-ink",
  danger: "border-danger/30 bg-danger/10 text-ink",
};
const dotBase = "size-1.5 shrink-0 rounded-full";
const dots = {
  neutral: "bg-muted",
  primary: "bg-primary",
  success: "bg-success",
  warning: "bg-warning",
  danger: "bg-danger",
};

type Props = HTMLAttributes<"span"> & {
  variant?: keyof typeof variants;
  /** Colored dot before the text. Turn it off for badges with an icon or a number. */
  dot?: boolean;
};

const { variant = "neutral", dot = true, class: className, ...rest } =
  Astro.props;
---

<span class:list={[base, variants[variant], className]} {...rest}
  >{dot && <span class:list={[dotBase, dots[variant]]} aria-hidden="true" />}<slot
  /></span
>
```

```astro
---
import Badge from "@/components/markas/Badge.astro";
---

<Badge variant="success">Active</Badge>
<Badge variant="primary" dot={false}>12</Badge>
```

### Angular

Save at `src/app/markas/badge.component.ts`. No extra dependencies.

```ts
import {
  booleanAttribute,
  ChangeDetectionStrategy,
  Component,
  computed,
  input,
} from "@angular/core";

const base =
  "inline-flex items-center gap-1.5 rounded-full border px-2.5 py-0.5 text-xs font-medium whitespace-nowrap";
const variants = {
  neutral: "border-line bg-subtle text-ink",
  primary: "border-primary-line bg-primary-soft text-primary",
  success: "border-success/30 bg-success/10 text-ink",
  warning: "border-warning/30 bg-warning/10 text-ink",
  danger: "border-danger/30 bg-danger/10 text-ink",
};
const dotBase = "size-1.5 shrink-0 rounded-full";
const dots = {
  neutral: "bg-muted",
  primary: "bg-primary",
  success: "bg-success",
  warning: "bg-warning",
  danger: "bg-danger",
};

export type BadgeVariant = keyof typeof variants;

/**
 * Attribute selector on a native span: the user class and any aria-* or title stay on the
 * badge itself, so nothing has to be forwarded.
 */
@Component({
  selector: "span[markas-badge]",
  changeDetection: ChangeDetectionStrategy.OnPush,
  host: { "[class]": "classes()" },
  template: `@if (dot()) {
      <span [class]="dotClasses()" aria-hidden="true"></span>
    }
    <ng-content />`,
})
export class Badge {
  readonly variant = input<BadgeVariant>("neutral");
  /** Colored dot before the text. Turn it off for badges with an icon or a number. */
  readonly dot = input(true, { transform: booleanAttribute });

  protected readonly classes = computed(
    () => `${base} ${variants[this.variant()]}`,
  );
  protected readonly dotClasses = computed(
    () => `${dotBase} ${dots[this.variant()]}`,
  );
}
```

```ts
import { Component } from "@angular/core";
import { Badge } from "./markas/badge.component";

@Component({
  selector: "app-invoice-status",
  imports: [Badge],
  template: `
    <span markas-badge variant="success">Active</span>
    <span markas-badge variant="primary" [dot]="false">12</span>
  `,
})
export class InvoiceStatus {}
```

## Props

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `variant` | `'neutral' \| 'primary' \| 'success' \| 'warning' \| 'danger'` | neutral | Background, border, and status dot color. |
| `dot` | `boolean` | true | Colored dot before the text. Turn it off for badges with an icon or a count. |

## Accessibility

- A plain span without a role. The badge text is read as is.
- The colored dot is decorative (aria-hidden), so the status must be written in the text.
- Success, warning, and danger text uses ink so contrast meets AA in light and dark mode.

## Notes

- Success, warning, and danger text uses `ink`. The status color comes from the background, border, and dot, because light `success` and `warning` lack enough contrast for small text.
