Skip to content

No results for

↑ ↓ navigate ↵ open Esc close 
php artisan aura:add stream

Copies the component source into resources/views/components/aura/. Run php artisan aura:init first if you haven't already. See the CLI guide for all options.

composer require bluestarsystem/aura-ui
php artisan aura:install

Full installation instructions in the Installation guide.

Pro Component — This component requires an Aura UI Pro license.

Overview

<x-aura::stream> renders progressively arriving text.

Basic Usage

<x-aura::stream :text="$partial" :streaming="$streaming" />

Props

Prop Type Default Description
text string|null null The text so far. Falls back to the slot.
streaming bool false Holds the announcement and shows the caret.
cursor bool true The blinking caret while streaming.
label string|null null Names the region.

Accessibility

  • The caret is a CSS element, not a character. A ▍ in the text is read aloud and ends up in whatever the reader copies.
  • aria-busy while text is arriving: a live region that fires on every fragment reads the same growing sentence over and over.
  • The caret stops blinking under prefers-reduced-motion, but stays visible — it still has to mark where the text ends.