Release Badge
A release/version badge showing the latest tag, release name, date, asset count and an optional pre-release marker, as a pill, row or card.
Preview
v2.4.0
2d ago
v3.0.0-rc.1
pre
5h ago
v2.4.0
v2.4.0
Spring release
<div class="flex flex-col items-start gap-4">
<div class="flex flex-wrap items-center gap-2">
<x-ui.release-badge version="v2.4.0" date="2d ago" />
<x-ui.release-badge version="v3.0.0-rc.1" :prerelease="true" date="5h ago" />
<x-ui.release-badge version="v2.4.0" variant="primary" :show-date="false" />
</div>
<x-ui.release-badge layout="row" version="v2.4.0" name="Spring release" date="2d ago" />
<x-ui.release-badge
layout="card"
version="v2.4.0"
name="Spring release"
date="Released 2 days ago"
:assets="6"
:show-assets="true"
/>
</div>
Installation
php artisan ui:add release-badge
Registry contract
php artisan ui:add release-badge
writes only the files below. The CLI validates each file hash before writing and asks before it replaces a local change, unless you pass --force.
-
resources/views/components/ui/release-badge.blade.php
- Registry dependencies
- None — installs on its own.
- Packages
-
composer: jml/brok:^0.2
Use with AI
A brief for your coding agent: install command, usage, props, guidance and the rules. Copy it, or open a prompt about this component in an assistant.
# Brok UI: Release Badge (`release-badge`)
A release/version badge showing the latest tag, release name, date, asset count and an optional pre-release marker, as a pill, row or card.
Brok UI is a Laravel Blade component registry. Installed components are plain Blade files the app owns.
## Install
```bash
php artisan ui:add release-badge
```
## Usage
```blade
<div class="flex flex-col items-start gap-4">
<div class="flex flex-wrap items-center gap-2">
<x-ui.release-badge version="v2.4.0" date="2d ago" />
<x-ui.release-badge version="v3.0.0-rc.1" :prerelease="true" date="5h ago" />
<x-ui.release-badge version="v2.4.0" variant="primary" :show-date="false" />
</div>
<x-ui.release-badge layout="row" version="v2.4.0" name="Spring release" date="2d ago" />
<x-ui.release-badge
layout="card"
version="v2.4.0"
name="Spring release"
date="Released 2 days ago"
:assets="6"
:show-assets="true"
/>
</div>
```
## Props
- `version` (string, default `v1.0.0`)
- `name` (mixed|null, default `null`)
- `date` (mixed|null, default `null`)
- `assets` (mixed|null, default `null`)
- `prerelease` (bool, default `false`)
- `layout` (string, default `inline`)
- `variant` (default|outline|primary, default `default`)
- `href` (mixed|null, default `null`)
- `showDate` (bool, default `true`)
- `showAssets` (bool, default `false`)
## Use when
- Use for exact technical detail, code readability, diagnostics, and copyable reference material.
- Showing the latest published version of a package or repository.
- Linking a release tag to its notes from a docs header or a changelog.
## Avoid when
- Do not surface developer-specific patterns in end-user flows unless the task genuinely requires them.
- Showing build state; ci-badge covers a run outcome.
- Labelling arbitrary metadata, where badge is the general primitive.
## Anti-patterns
- Exposing developer tooling in end-user flows without a task need
## Rules
- Use the `<brok:release-badge>` tag (or `<x-ui.release-badge>`) in Blade; do not rewrite the component.
- Prefer the documented props and variants over utility-class overrides; when a utility must win, use the `!` important modifier.
- Use semantic design tokens (`bg-primary`, `text-muted-foreground`), never raw colour utilities.
- Keep the `data-slot` attributes; they are the styling and test hooks.
## Links
- Docs: https://brokui.dev/docs/components/release-badge
- Registry JSON (files, props, contract): https://brokui.dev/r/open/release-badge.json
Working in Claude Code, Cursor or Codex? Give the agent the whole registry through the MCP server or the Brok UI skill.
API
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| version | string | v1.0.0 | |
| name | mixed | null | null | |
| date | mixed | null | null | |
| assets | mixed | null | null | |
| prerelease | bool | false | |
| layout | string | inline | |
| variant | default | outline | primary | default | |
| href | mixed | null | null | |
| showDate | bool | true | |
| showAssets | bool | false |
Slots
default—
Data slots
Stable hooks for CSS overrides and browser tests.
Behavior
- layout moves between a pill, a row and a card; the date and asset count appear only when their show flags allow it.
- prerelease adds a distinct marker so a tag is never mistaken for a stable release.
- With href the whole badge renders as a link to the release.
- Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.
Guidance
Expose exact technical or diagnostic information.
Use when
- Use for exact technical detail, code readability, diagnostics, and copyable reference material.
- Showing the latest published version of a package or repository.
- Linking a release tag to its notes from a docs header or a changelog.
Avoid when
- Do not surface developer-specific patterns in end-user flows unless the task genuinely requires them.
- Showing build state; ci-badge covers a run outcome.
- Labelling arbitrary metadata, where badge is the general primitive.
Use instead
- Plain-language product UI for nontechnical users
Anti-patterns
- Exposing developer tooling in end-user flows without a task need
- Anatomy
- Theming hooks
Accessibility
- Keyboard
- No component-owned keyboard interaction; native element behavior applies.
- Focus
none
- A composed accessible name states the version and, where shown, the release name, so a link is never read as bare punctuation.
- Decorative icons are aria-hidden and the pre-release marker is text, not colour alone.
- Semantic HTML and a stable
data-slotattribute for styling and scripting hooks. - Focus-visible rings use the
ringtoken, so keyboard focus is always visible. - Disabled and invalid states are conveyed to assistive tech, not by color alone.
- Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces in the preview.
- Labels go through
__()and layout uses logical properties (ms-*,text-start), so it mirrors underdir="rtl"— flip the preview to RTL to confirm. - Dark mode uses the same semantic tokens under the
darkclass; high contrast follows forced-color system tokens.
Livewire
Livewire can update this component through forwarded wire:* attributes.
Source
The exact, editable file ui:add writes
into your app. Previews render this same code; there are no preview-only components.
@props([
'version' => 'v1.0.0',
'name' => null,
'date' => null,
'assets' => null,
'prerelease' => false,
'layout' => 'inline',
'variant' => 'default',
'href' => null,
'showDate' => true,
'showAssets' => false,
])
@php
$styles = require base_path(config('ui.component_path', 'resources/views/components/ui').'/_styles.php');
$variant = $styles['normalizeVariant']($variant);
$layout = in_array($layout, ['inline', 'row', 'card'], true) ? $layout : 'inline';
$variant = in_array($variant, ['default', 'outline', 'primary'], true) ? $variant : 'default';
$prerelease = filter_var($prerelease, FILTER_VALIDATE_BOOLEAN);
$showDate = filter_var($showDate, FILTER_VALIDATE_BOOLEAN);
$showAssets = filter_var($showAssets, FILTER_VALIDATE_BOOLEAN);
$shell = match ($variant) {
'primary' => 'border-transparent bg-primary text-primary-foreground',
'outline' => 'border-border bg-transparent text-foreground',
default => 'border-border bg-card text-foreground',
};
$tagIcon = '<svg class="size-4 shrink-0" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M12.586 2.586A2 2 0 0 0 11.172 2H4a2 2 0 0 0-2 2v7.172a2 2 0 0 0 .586 1.414l8.704 8.704a2.426 2.426 0 0 0 3.42 0l6.58-6.58a2.426 2.426 0 0 0 0-3.42z"/><circle cx="7.5" cy="7.5" r=".5" fill="currentColor"/></svg>';
$a11y = trim(__('Release').' '.$version.($prerelease ? ' '.__('pre-release') : '').($name ? ' '.$name : ''));
@endphp
@php
// Pre-release marker — amber, via the warning token.
$pre = $prerelease
? '<span class="inline-flex items-center rounded-sm bg-warning/15 px-2 py-0.5 text-[0.625rem] font-semibold uppercase tracking-wide text-warning">'.__('pre').'</span>'
: '';
@endphp
@if ($layout === 'card')
<{{ $href ? 'a' : 'div' }}
@if ($href) href="{{ $href }}" @endif
data-slot="release-badge"
data-layout="card"
data-prerelease="{{ $prerelease ? 'true' : 'false' }}"
aria-label="{{ $a11y }}"
{{ $attributes->merge(['class' => 'flex items-start gap-3 rounded-md border border-border bg-card p-3 text-foreground '.($href ? 'transition-colors hover:bg-muted/50' : '')]) }}
>
<span class="mt-0.5 flex size-9 shrink-0 items-center justify-center rounded-full bg-muted text-muted-foreground">{!! $tagIcon !!}</span>
<div class="min-w-0 flex-1">
<div class="flex items-center gap-2">
<code class="font-mono font-semibold text-foreground">{{ $version }}</code>
{!! $pre !!}
</div>
@if ($name)<p class="mt-0.5 truncate text-sm text-muted-foreground">{{ $name }}</p>@endif
<div class="mt-1 flex flex-wrap items-center gap-x-3 gap-y-0.5 text-xs text-muted-foreground">
@if ($showDate && $date)<span>{{ $date }}</span>@endif
@if ($showAssets && $assets !== null)<span>{{ trans_choice('{0}no assets|{1}:count asset|[2,*]:count assets', (int) $assets, ['count' => $assets]) }}</span>@endif
</div>
</div>
</{{ $href ? 'a' : 'div' }}>
@elseif ($layout === 'row')
<{{ $href ? 'a' : 'div' }}
@if ($href) href="{{ $href }}" @endif
data-slot="release-badge"
data-layout="row"
data-prerelease="{{ $prerelease ? 'true' : 'false' }}"
aria-label="{{ $a11y }}"
{{ $attributes->merge(['class' => 'inline-flex items-stretch divide-x divide-border overflow-hidden rounded-md border border-border bg-card text-xs text-foreground rtl:divide-x-reverse '.($href ? 'transition-colors hover:bg-muted/50' : '')]) }}
>
<span class="inline-flex items-center gap-2 bg-muted/50 px-2 py-1 font-mono font-semibold">{!! $tagIcon !!}{{ $version }}</span>
@if ($name)<span class="inline-flex items-center px-2 py-1 text-muted-foreground">{{ $name }}</span>@endif
@if ($showDate && $date)<span class="inline-flex items-center px-2 py-1 text-muted-foreground">{{ $date }}</span>@endif
@if ($prerelease)<span class="inline-flex items-center px-2 py-1">{!! $pre !!}</span>@endif
</{{ $href ? 'a' : 'div' }}>
@else
<{{ $href ? 'a' : 'span' }}
@if ($href) href="{{ $href }}" @endif
data-slot="release-badge"
data-layout="inline"
data-prerelease="{{ $prerelease ? 'true' : 'false' }}"
aria-label="{{ $a11y }}"
{{ $attributes->merge(['class' => 'inline-flex items-center gap-2 rounded-full border px-2 py-1 text-xs font-medium '.$shell.($href ? ' transition-colors hover:opacity-90' : '')]) }}
>
{!! $tagIcon !!}
<code class="font-mono font-semibold {{ $variant === 'primary' ? '' : 'text-foreground' }}">{{ $version }}</code>
{!! $pre !!}
@if ($showDate && $date)<span class="{{ $variant === 'primary' ? 'opacity-80' : 'text-muted-foreground' }}">{{ $date }}</span>@endif
</{{ $href ? 'a' : 'span' }}>
@endif
Ownership & lifecycle
Owner, release state, review evidence and adoption for this item.
- Owner
- Platform UI (@JoshJML)
- Current version
-
1.1.5 - Status
- Stable
- License
-
open - Accessibility reviewed
- No review date recorded
- Last breaking change
- No date recorded
- Deprecation
- Not deprecated
- Contract
-
v6 - Foundation
-
≥ 1.0.0