Skip to content
Brok UI

Loading…

No results

Glow & border effects

Open source

Animated colored treatments that travel around an element's border, plus cursor-tracked and ambient glow effects.

Version
v1.2.1
Stability
stable
License
MIT
Related
Border Glow
Spotlight

Glow — A decorative, positioned radial-gradient backdrop — the soft brand bloom behind heroes and CTAs, with top/center/bottom/above/below placements.

Preview

Brand glow backdrop

previews.components.glow.default.blade.php Blade
<div class="relative isolate flex min-h-64 w-full max-w-md items-center justify-center overflow-hidden rounded-xl border border-border bg-background p-10">
    <x-ui.glow variant="center" />
    <p class="relative z-10 text-center text-foreground">Brand glow backdrop</p>
</div>

Installation

terminal
php artisan ui:add glow

Registry contract

php artisan ui:add glow 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.

  • blade resources/views/components/ui/glow.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.

glow.md
# Brok UI: Glow (`glow`)

A decorative, positioned radial-gradient backdrop — the soft brand bloom behind heroes and CTAs, with top/center/bottom/above/below placements.

Brok UI is a Laravel Blade component registry. Installed components are plain Blade files the app owns.

## Install

```bash
php artisan ui:add glow
```

## Usage

```blade
<div class="relative isolate flex min-h-64 w-full max-w-md items-center justify-center overflow-hidden rounded-xl border border-border bg-background p-10">
    <x-ui.glow variant="center" />
    <p class="relative z-10 text-center text-foreground">Brand glow backdrop</p>
</div>
```

## Props

- `variant` (top|center|bottom|above|below, default `top`) — Placement: top, center, bottom, above, or below.
- `color` (string, default `ring`) — Token colour: primary, accent, foreground, ring, or chart-1 through chart-5.

## Use when

- Use only when visual expression supports storytelling, brand differentiation, or a clear showcase moment.
- Adding a soft, positioned radial-gradient bloom behind a hero, CTA, or section header for brand ambiance.
- Needing top, center, bottom, above, or below placement options within a relative isolate parent.

## Avoid when

- Do not place heavy effects in task-dense workflows where clarity, speed, and readability matter more.
- Wanting an animated or rotating glow around a border; use border-glow instead.
- Wanting a cursor-following highlight on a surface; use spotlight instead.

## Anti-patterns

- Heavy effects in forms or task-dense workflows
- Motion that interferes with reading or focus

## Rules

- Use the `<brok:glow>` tag (or `<x-ui.glow>`) 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/glow
- Registry JSON (files, props, contract): https://brokui.dev/r/open/glow.json

Working in Claude Code, Cursor or Codex? Give the agent the whole registry through the MCP server or the Brok UI skill.

API

manifest knowledge + registry-derived coverage

Props

Props accepted by this component: name, type, default value and description.
Prop Type Default Description
variant top | center | bottom | above | below top Placement: top, center, bottom, above, or below.
color string ring Token colour: primary, accent, foreground, ring, or chart-1 through chart-5.

Slots

  • default — Unused; the component has no visible default slot content.

Data slots

Stable hooks for CSS overrides and browser tests.

glow

Behavior

  • Renders two layered, blurred radial gradients in currentColor, positioned absolutely within its nearest relative isolate ancestor.
  • The colour is entirely token-driven, so the bloom adapts automatically between light and dark mode.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Guidance

Expressive and showcase effect

Support brand expression or a showcase moment.

Use when

  • Use only when visual expression supports storytelling, brand differentiation, or a clear showcase moment.
  • Adding a soft, positioned radial-gradient bloom behind a hero, CTA, or section header for brand ambiance.
  • Needing top, center, bottom, above, or below placement options within a relative isolate parent.

Avoid when

  • Do not place heavy effects in task-dense workflows where clarity, speed, and readability matter more.
  • Wanting an animated or rotating glow around a border; use border-glow instead.
  • Wanting a cursor-following highlight on a surface; use spotlight instead.

Use instead

  • Static content-first presentation

Anti-patterns

  • Heavy effects in forms or task-dense workflows
  • Motion that interferes with reading or focus
Anatomy
root
Theming hooks
glow

Accessibility

WCAG 2.2 AA Keyboard focus-visible RTL-ready Localized labels Dark mode
Keyboard
No component-owned keyboard interaction; native element behavior applies.
Focus
none
  • The root is aria-hidden and pointer-events-none, since it is purely decorative and never intercepts focus or clicks.
  • No motion is used, so it needs no reduced-motion handling.
  • Semantic HTML and a stable data-slot attribute for styling and 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 in the preview.
  • Labels go through __() and layout uses logical properties (ms-*, text-start), so it mirrors under dir="rtl" — flip the preview to RTL to confirm.
  • Dark mode uses the same semantic tokens under the dark class; high contrast follows forced-color system tokens.

Livewire

Safe

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.

resources/views/components/ui/glow.blade.php Blade
@props([
    'variant' => 'top',
    // primary | accent | foreground | ring | chart-1 … chart-5. `ring` by
    // default: in the neutral palette `primary` is near black and a black
    // bloom reads as a shadow, not a glow.
    'color' => 'ring',
])

@php
    $styles = require base_path(config('ui.component_path', 'resources/views/components/ui').'/_styles.php');
    $variant = $styles['normalizeVariant']($variant);
    // Glow — a decorative, positioned radial-gradient backdrop (the soft brand
    // bloom behind heroes and CTAs). Drop it inside a `relative isolate` parent;
    // it paints two layered radial gradients with `currentColor` (themed by a
    // `text-*` token, never a raw colour) so it adapts to light and dark. Purely
    // ornamental: aria-hidden and pointer-events-none.
    $colorClass = match ($color) {
        'primary' => 'text-primary',
        'accent' => 'text-accent',
        'foreground' => 'text-foreground',
        'ring' => 'text-ring',
        'chart-1' => 'text-chart-1',
        'chart-2' => 'text-chart-2',
        'chart-3' => 'text-chart-3',
        'chart-4' => 'text-chart-4',
        'chart-5' => 'text-chart-5',
        default => 'text-ring',
    };

    // Anchor + offset per position. Horizontal centring is mirror-symmetric, so
    // `left-1/2` stays correct under dir="rtl".
    $position = match ($variant) {
        'top' => 'left-1/2 top-0 -translate-x-1/2 -translate-y-1/3',
        'center' => 'left-1/2 top-1/2 -translate-x-1/2 -translate-y-1/2',
        'bottom' => 'left-1/2 bottom-0 -translate-x-1/2 translate-y-1/3',
        'above' => 'left-1/2 top-0 -translate-x-1/2 -translate-y-2/3',
        'below' => 'left-1/2 bottom-0 -translate-x-1/2 translate-y-2/3',
        default => 'left-1/2 top-0 -translate-x-1/2 -translate-y-1/3',
    };
@endphp

<div
    data-slot="glow"
    data-variant="{{ $variant }}"
    aria-hidden="true"
    {{ $attributes->merge(['class' => "pointer-events-none absolute z-0 {$position} {$colorClass}"]) }}
>
    {{-- Wide, soft brand bloom --}}
    <div
        class="h-[40rem] w-[70rem] max-w-[180vw] opacity-30 blur-2xl"
        style="background: radial-gradient(ellipse at center, currentColor 0%, transparent 60%);"
    ></div>
    {{-- Tighter, brighter core for depth --}}
    <div
        class="absolute left-1/2 top-1/2 h-[22rem] w-[42rem] max-w-[140vw] -translate-x-1/2 -translate-y-1/2 opacity-40 blur-3xl"
        style="background: radial-gradient(ellipse at center, currentColor 0%, transparent 55%);"
    ></div>
</div>

Ownership & lifecycle

Owner, release state, review evidence and adoption for this item.
Owner
Platform UI (@JoshJML)
Current version
1.2.1
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