Skip to content
UI Brok

Loading…

No results

Browse catalog

Notifications

In-app notification surfaces — a stacked feed panel, a single content card, and a corner count badge.

Notification Badge

Preview

5 notifications 128 notifications Zoe New notifications

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 notification-badge

Registry contract

Install confidence

php artisan ui:add notification-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/notification-badge.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Status and lightweight feedback

Communicate concise object or system state.

Use when

  • Use to show state, status, notification, or lightweight social feedback near the relevant object. Do not overload small status elements with explanations that should remain visible in text.

Avoid when

  • Avoid using notification-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
micro
Interaction cost
low
Interruptiveness
none
Input precision
none
Mobile / touch risk
low
Accessibility risk
high
Needs background context
Yes
Comparison needed
No

Preferred alternatives

  • Persistent explanatory text

Anti-patterns

  • Using color or icon alone to communicate state

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
count mixed|null null Declared by @props in the registry Blade source.
dot bool false Declared by @props in the registry Blade source.
max int 99 Declared by @props in the registry Blade source.
tone string primary Declared by @props in the registry Blade source.
ping bool false Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.

Data slots

notification-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.notification-badge.default.blade.php Blade
<div class="flex min-h-40 w-full items-center justify-center gap-8 rounded-lg border border-border bg-card p-8">
    <x-ui.notification-badge :count="5">
        <span class="inline-flex size-10 items-center justify-center rounded-lg border border-border bg-background text-muted-foreground">
            <svg class="size-5" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
                <path d="M6 8a6 6 0 0 1 12 0c0 7 3 9 3 9H3s3-2 3-9" />
                <path d="M10.3 21a1.94 1.94 0 0 0 3.4 0" />
            </svg>
        </span>
    </x-ui.notification-badge>

    <x-ui.notification-badge :count="128" tone="destructive">
        <span class="inline-flex size-10 items-center justify-center rounded-lg border border-border bg-background text-muted-foreground">
            <svg class="size-5" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
                <path d="M4 4h16v12H5.2L4 17.5V4Z" />
            </svg>
        </span>
    </x-ui.notification-badge>

    <x-ui.notification-badge dot tone="success" ping>
        <x-ui.avatar src="https://picsum.photos/seed/zoe/80/80" alt="Zoe" />
    </x-ui.notification-badge>
</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.