Skip to content
UI Brok

Loading…

No results

Browse catalog

Real-Time Cursors

A simulated multiplayer-presence overlay — labelled cursors glide around the surface along smooth paths, with an optional mode where one tracks the viewer's pointer. Token-coloured and reduced-motion safe.

Preview

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 real-time-cursors

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/real-time-cursors.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS 
import './real-time-cursors.js';

Registry contract

Install confidence

php artisan ui:add real-time-cursors 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/real-time-cursors.blade.php
js resources/js/ui/real-time-cursors.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

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 real-time-cursors 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
users array ['Alex', 'Sam', 'Jordan', 'Riley'] Declared by @props in the registry Blade source.
follow bool false Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.

Data slots

real-time-cursors real-time-cursors-cursor

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized reducedMotion

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
  • Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized, reducedMotion.

Usage

previews.components.real-time-cursors.default.blade.php Blade 
<x-ui.real-time-cursors
    :follow="true"
    class="block h-64 w-full max-w-xl rounded-lg border border-border bg-card"
/>

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.