Description List

Open source

Detail panels — key/value information rendered as a semantic description list with a status badge and attachments.

resources/views/blocks/description-list-inline.blade.php Blade

@props([
    'heading'    => 'Account overview',
    'subheading' => 'Personal details and preferences for this account.',
    'editHref'   => '#',
    'rows'       => null,
])

@php
    $rows ??= [
        ['label' => 'Full name', 'value' => 'Alex Morgan', 'type' => 'text'],
        ['label' => 'Email address', 'value' => 'alex.morgan@example.com', 'type' => 'text'],
        ['label' => 'Phone', 'value' => '+1 (555) 234-5678', 'type' => 'text'],
        ['label' => 'Location', 'value' => 'San Francisco, CA', 'type' => 'text'],
        ['label' => 'Member since', 'value' => 'January 12, 2024', 'type' => 'text'],
        ['label' => 'Plan', 'value' => 'Pro', 'type' => 'badge', 'variant' => 'default'],
        ['label' => 'Account status', 'value' => 'Active', 'type' => 'badge', 'variant' => 'success'],
        ['label' => 'Interests', 'value' => ['Design Systems', 'Laravel', 'Open Source', 'Accessibility'], 'type' => 'tags'],
    ];
@endphp

<x-ui.section space="md" {{ $attributes }}>
    <div class="mx-auto max-w-3xl px-4">
        <div class="flex items-start justify-between gap-4">
            <div class="min-w-0 flex-1">
                <h2 class="text-lg font-semibold leading-6 text-foreground">{{ __($heading) }}</h2>
                @if ($subheading)<p class="mt-2 text-sm text-muted-foreground">{{ __($subheading) }}</p>@endif
            </div>
            <x-ui.button variant="ghost" size="sm" :href="$editHref" class="shrink-0">
                <x-slot:icon><svg class="size-4" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M17 3a2.85 2.83 0 1 1 4 4L7.5 20.5 2 22l1.5-5.5Z" /><path d="m15 5 4 4" /></svg></x-slot:icon>
                {{ __('Edit') }}
            </x-ui.button>
        </div>

        <x-ui.fact-list layout="grid" size="lg" :facts="$rows" class="mt-6 border-y border-border" />
    </div>
</x-ui.section>

Installation

terminal

php artisan ui:add blocks/description-list-inline

Installs these dependencies automatically:

badge button section fact-list

Registry contract

Install confidence

php artisan ui:add blocks/description-list-inline 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.1.1
License: open
Stability: stable
Contract: v1
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/blocks/description-list-inline.blade.php

Registry dependencies

badge button section fact-list

Package dependencies

composer: jml/brok:^0.2

Use with AI

A brief for your coding agent: what the block is, the install command, how to render it, its props and the rules. Copy it, or open a prompt about this block in an assistant.

description-list-inline.md

# Brok UI block: Description List Inline (`description-list-inline`)

A description list rendered as clean ruled rows without a card, with a heading, edit action, status badge and a tags row.

Brok UI is a Laravel Blade registry. `ui:add` copies this block into the app as plain Blade the app owns; it composes installed `<brok:*>` primitives and semantic design tokens.

## Install

```bash
php artisan ui:add blocks/description-list-inline
```

## Render it

```blade
<x-blocks.description-list-inline />
```

## Props

- `heading` (string, default `Account overview`)
- `subheading` (string, default `Personal details and preferences for this account.`)
- `edit-href` (string, default `#`)
- `rows` (mixed|null, default `null`)

## Use when

- Presenting account details as clean ruled rows without a surrounding card, with a heading, edit action and status badge.
- Showing a multi-value field, such as interests, as a wrapped tags row within the list.

## Avoid when

- Use description-list-detail for a card-wrapped version with attachments, or description-list-sections for grouped section cards.

## Rules

- Render the installed block with `<x-blocks.description-list-inline />` and pass data through its props; edit the copied file only for structural changes.
- Keep the semantic design tokens (`bg-background`, `text-muted-foreground`); never swap in raw colour utilities.
- Keep the `data-slot` attributes and the logical (start/end) spacing so the markup still mirrors under `dir="rtl"`.

## Links

- Docs: https://brokui.dev/blocks/description-list-inline
- Registry JSON (files, props, contract): https://brokui.dev/r/open/blocks/description-list-inline.json

Ask about Description List Inline in

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

Guidance

Use when

Presenting account details as clean ruled rows without a surrounding card, with a heading, edit action and status badge.
Showing a multi-value field, such as interests, as a wrapped tags row within the list.

Avoid when

Use description-list-detail for a card-wrapped version with attachments, or description-list-sections for grouped section cards.

Anti-patterns

Do not replace semantic props with conflicting utility classes.
Do not remove labels, focus styles, or state attributes.

Usage

Render the block as a component, passing data where useful:

resources/views/welcome.blade.php Blade

<x-blocks.description-list-inline />

Built from primitives

Composes <brok:*> Semantic tokens Re-themeable RTL-ready

This block composes installed <brok:*> primitives and semantic design tokens only — it does not reimplement any primitive. Re-theme it (light, dark, admin, customer) by editing CSS variables; flip the preview to RTL to confirm it mirrors.

Source

The exact, editable file ui:add writes into your app. The preview above renders this same source — there are no preview-only blocks.