Skip to content
UI Brok

Loading…

No results

Browse catalog

Release Badge

A release/version badge with tag, name, date, asset count and a 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 2d ago
v2.4.0

Spring release

Released 2 days ago 6 assets

Controls

Theme
Surface
Direction
Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal
php artisan ui:add release-badge

Registry contract

Install confidence

php artisan ui:add release-badge writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version
1.0.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/release-badge.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Developer and documentation tool

Expose exact technical or diagnostic information.

Use when

  • Use for exact technical detail, code readability, diagnostics, and copyable reference material. Do not surface developer-specific patterns in end-user flows unless the task genuinely requires them.

Avoid when

  • Avoid using release-badge as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
Task length
medium
Interaction cost
medium
Interruptiveness
none
Input precision
precise
Mobile / touch risk
low
Accessibility risk
medium
Needs background context
No
Comparison needed
No

Preferred alternatives

  • Plain-language product UI for nontechnical users

Anti-patterns

  • Exposing developer tooling in end-user flows without a task need

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
version string v1.0.0 Declared by @props in the registry Blade source.
name mixed|null null Declared by @props in the registry Blade source.
date mixed|null null Declared by @props in the registry Blade source.
assets mixed|null null Declared by @props in the registry Blade source.
prerelease bool false Declared by @props in the registry Blade source.
layout string inline Declared by @props in the registry Blade source.
variant string default Declared by @props in the registry Blade source.
href mixed|null null Declared by @props in the registry Blade source.
showDate bool true Declared by @props in the registry Blade source.
showAssets bool false Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

release-badge

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.release-badge.default.blade.php 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>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels
  • Accessibility target: wcag-2.2-aa-target.
  • Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
  • Focus-visible rings use the ring token 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 above.
  • Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.0.0. See the site changelog for the full release history.