Skip to content

No results for

navigate open Esc close
php artisan aura:add prose

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.

Overview

<x-aura::prose> styles a block of rendered HTML — a Markdown post, a stored description, output from an editor — where you cannot put a class on each element.

The rules follow the Aura theme, so headings, lists, quotes and code inside it match the rest of the interface instead of a plugin's own scale.

Basic Usage

<x-aura::prose>
    {!! $post->rendered_content !!}
</x-aura::prose>

A heading inside prose

A paragraph of body copy, with a link and some inline code.

  • First item
  • Second item
<x-aura::prose size="sm">
    <h3>A heading inside prose</h3>
    <p>A paragraph of body copy, with <a href="#">a link</a> and some <code>inline code</code>.</p>
    <ul><li>First item</li><li>Second item</li></ul>
</x-aura::prose>

Props

Prop Type Default Description
size string 'base' sm, base, lg.

Notes

Use it for content you did not author element by element. For an interface you are building yourself, style the components directly — prose is a fallback for HTML that arrives as a blob.

Content rendered from user input should be sanitised before it reaches {!! !!}. Prose styles markup; it does not make it safe.