Skip to content
Brok UI

Loading…

No results

Project Overview

Open source

A project overview screen: a page header with status, team avatars and the primary action, an overall progress meter, KPI cards, and a task list.

Responsive Dark mode RTL Localized SEO

Preview

resources/views/pages/project-overview.blade.php Blade
{{--
    Project Overview — one project's screen: the page header carries the
    name, the status and the team beside the primary action, then overall
    progress, the KPI tiles and the task list. Every list is a prop, so a host
    binds its own project; the defaults render the sample screen the docs show.
--}}
@props([
    'project' => null,
    'stats' => null,
    'tasks' => null,
    'team' => null,
])

@php
    $project ??= ['name' => 'Mobile App Redesign', 'description' => 'Q3 initiative to refresh the mobile experience.', 'status' => 'On track', 'statusTone' => 'success', 'progress' => 68];
    $stats ??= [
        ['label' => 'Tasks done', 'value' => '34 / 50'],
        ['label' => 'Due date', 'value' => 'Aug 15'],
        ['label' => 'Budget used', 'value' => '62%'],
    ];
    $tasks ??= [
        ['title' => 'Finalize design tokens', 'assignee' => 'AB', 'status' => 'Done', 'tone' => 'success'],
        ['title' => 'Build component library', 'assignee' => 'LC', 'status' => 'In progress', 'tone' => 'info'],
        ['title' => 'User testing round 2', 'assignee' => 'ND', 'status' => 'Todo', 'tone' => 'secondary'],
    ];
    // Team entries are avatar-group people: a name, or ['name' => …, 'src' => …, 'initials' => …].
    $team ??= ['Ava Bell', 'Liam Cole', 'Noa Diaz', 'Mia Evans'];
@endphp

<x-ui.section as="main" data-slot="project-overview" data-surface="admin" space="none" class="min-h-svh py-4 sm:py-6 lg:py-8" {{ $attributes }}>
    <x-ui.container size="md" class="space-y-6">
        <x-ui.admin.page-header :title="$project['name']" :scope="__($project['description'])">
            <x-slot:actions>
                <x-ui.badge :variant="$project['statusTone'] ?? 'default'">{{ __($project['status']) }}</x-ui.badge>
                <x-ui.avatar-group :avatars="$team" size="sm" :max="4" />
                <x-ui.button size="sm">{{ __('Add task') }}</x-ui.button>
            </x-slot:actions>
        </x-ui.admin.page-header>

        <x-ui.card>
            <x-ui.card.content class="pt-6">
                <div class="mb-2 flex items-center justify-between text-sm">
                    <span class="font-medium">{{ __('Overall progress') }}</span>
                    <span class="text-muted-foreground">{{ $project['progress'] }}%</span>
                </div>
                <x-ui.progress :value="$project['progress']" :label="__('Overall progress')" />
            </x-ui.card.content>
        </x-ui.card>

        <div class="grid gap-4 sm:grid-cols-3">
            @foreach ($stats as $stat)
                <x-ui.stat :label="__($stat['label'])" :value="$stat['value']" />
            @endforeach
        </div>

        <x-ui.card>
            <x-ui.card.header>
                <x-ui.card.title>{{ __('Tasks') }}</x-ui.card.title>
            </x-ui.card.header>
            <x-ui.card.content class="space-y-2">
                @foreach ($tasks as $i => $task)
                    @if ($i > 0)
                        <x-ui.separator />
                    @endif
                    <div class="flex items-center justify-between gap-4 py-4">
                        <div class="flex min-w-0 items-center gap-4">
                            <x-ui.avatar :fallback="$task['assignee']" size="sm" />
                            <span class="truncate text-sm font-medium">{{ __($task['title']) }}</span>
                        </div>
                        <x-ui.badge :variant="$task['tone'] ?? 'secondary'">{{ __($task['status']) }}</x-ui.badge>
                    </div>
                @endforeach
            </x-ui.card.content>
        </x-ui.card>
    </x-ui.container>
</x-ui.section>

Installation

terminal
php artisan ui:add pages/project-overview

Registry contract

Install confidence

php artisan ui:add pages/project-overview 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.1
License
open
Stability
stable
Contract
v1
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/pages/project-overview.blade.php

Registry dependencies

section container admin-page-header button card badge separator progress stat avatar-group

Package dependencies

composer: jml/brok:^0.2

Use with AI

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

project-overview.md
# Brok UI page: Project Overview (`project-overview`)

A project overview screen: a page header with status, team avatars and the primary action, an overall progress meter, KPI cards, and a task list.

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

## Install

```bash
php artisan ui:add pages/project-overview
```

## Render it

```blade
<x-pages.project-overview />
```

## Use when

- One project's home screen: what it is, how far along it is, the figures that matter and the tasks in flight.
- A SaaS workspace that needs a per-project landing page beside its dashboard.

## Avoid when

- A cross-project dashboard; use dashboard-overview..05.
- A single record with sections and tabs; use admin-record.

## Rules

- Render the installed page with `<x-pages.project-overview />` 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/pages/project-overview
- Registry JSON (files, props, contract): https://brokui.dev/r/open/pages/project-overview.json

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

  • One project's home screen: what it is, how far along it is, the figures that matter and the tasks in flight.
  • A SaaS workspace that needs a per-project landing page beside its dashboard.

Avoid when

  • A cross-project dashboard; use dashboard-overview..05.
  • A single record with sections and tabs; use admin-record.

Anti-patterns

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

Usage

Render the page as a component, or wire it to a route. Pass data where useful:

resources/views/welcome.blade.php Blade
<x-pages.project-overview />

Built from blocks & primitives

This page 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 pages.

resources/views/pages/project-overview.blade.php Blade
{{--
    Project Overview — one project's screen: the page header carries the
    name, the status and the team beside the primary action, then overall
    progress, the KPI tiles and the task list. Every list is a prop, so a host
    binds its own project; the defaults render the sample screen the docs show.
--}}
@props([
    'project' => null,
    'stats' => null,
    'tasks' => null,
    'team' => null,
])

@php
    $project ??= ['name' => 'Mobile App Redesign', 'description' => 'Q3 initiative to refresh the mobile experience.', 'status' => 'On track', 'statusTone' => 'success', 'progress' => 68];
    $stats ??= [
        ['label' => 'Tasks done', 'value' => '34 / 50'],
        ['label' => 'Due date', 'value' => 'Aug 15'],
        ['label' => 'Budget used', 'value' => '62%'],
    ];
    $tasks ??= [
        ['title' => 'Finalize design tokens', 'assignee' => 'AB', 'status' => 'Done', 'tone' => 'success'],
        ['title' => 'Build component library', 'assignee' => 'LC', 'status' => 'In progress', 'tone' => 'info'],
        ['title' => 'User testing round 2', 'assignee' => 'ND', 'status' => 'Todo', 'tone' => 'secondary'],
    ];
    // Team entries are avatar-group people: a name, or ['name' => …, 'src' => …, 'initials' => …].
    $team ??= ['Ava Bell', 'Liam Cole', 'Noa Diaz', 'Mia Evans'];
@endphp

<x-ui.section as="main" data-slot="project-overview" data-surface="admin" space="none" class="min-h-svh py-4 sm:py-6 lg:py-8" {{ $attributes }}>
    <x-ui.container size="md" class="space-y-6">
        <x-ui.admin.page-header :title="$project['name']" :scope="__($project['description'])">
            <x-slot:actions>
                <x-ui.badge :variant="$project['statusTone'] ?? 'default'">{{ __($project['status']) }}</x-ui.badge>
                <x-ui.avatar-group :avatars="$team" size="sm" :max="4" />
                <x-ui.button size="sm">{{ __('Add task') }}</x-ui.button>
            </x-slot:actions>
        </x-ui.admin.page-header>

        <x-ui.card>
            <x-ui.card.content class="pt-6">
                <div class="mb-2 flex items-center justify-between text-sm">
                    <span class="font-medium">{{ __('Overall progress') }}</span>
                    <span class="text-muted-foreground">{{ $project['progress'] }}%</span>
                </div>
                <x-ui.progress :value="$project['progress']" :label="__('Overall progress')" />
            </x-ui.card.content>
        </x-ui.card>

        <div class="grid gap-4 sm:grid-cols-3">
            @foreach ($stats as $stat)
                <x-ui.stat :label="__($stat['label'])" :value="$stat['value']" />
            @endforeach
        </div>

        <x-ui.card>
            <x-ui.card.header>
                <x-ui.card.title>{{ __('Tasks') }}</x-ui.card.title>
            </x-ui.card.header>
            <x-ui.card.content class="space-y-2">
                @foreach ($tasks as $i => $task)
                    @if ($i > 0)
                        <x-ui.separator />
                    @endif
                    <div class="flex items-center justify-between gap-4 py-4">
                        <div class="flex min-w-0 items-center gap-4">
                            <x-ui.avatar :fallback="$task['assignee']" size="sm" />
                            <span class="truncate text-sm font-medium">{{ __($task['title']) }}</span>
                        </div>
                        <x-ui.badge :variant="$task['tone'] ?? 'secondary'">{{ __($task['status']) }}</x-ui.badge>
                    </div>
                @endforeach
            </x-ui.card.content>
        </x-ui.card>
    </x-ui.container>
</x-ui.section>

Ownership & lifecycle

Owner, release state, review evidence and adoption for this item.
Owner
Platform UI (@JoshJML)
Current version
1.0.1
Status
Stable
License
open
Deprecation
Not deprecated
Contract
v1
Foundation
≥ 1.0.0