Skip to content
UI Brok

Loading…

No results

Browse catalog

Todo Item

A task row whose checkbox strikes the title through on completion, with optional due date, tags and a priority badge.

Preview

Finalise the launch announcement

high
Today Marketing

Review pull request #482

medium

Token migration for the chart suite.

Tomorrow

Archive last quarter's boards

low

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 todo-item

Registry contract

Install confidence

php artisan ui:add todo-item 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/todo-item.blade.php

Registry dependencies

checkbox badge

Package dependencies

composer: jml/brok:^1.0

Guidance

Card and content widget

Present a self-contained content object with local context.

Use when

  • Use when self-contained content objects benefit from a recognizable card-like presentation with local actions or metadata. Do not use card widgets where a simpler list, table, or plain text block would make comparison faster.

Avoid when

  • Avoid using todo-item 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
short
Interaction cost
medium
Interruptiveness
none
Input precision
none
Mobile / touch risk
medium
Accessibility risk
medium
Needs background context
No
Comparison needed
Yes

Preferred alternatives

  • List for compact scanning
  • Table for exact comparison

Anti-patterns

  • Using cards for dense cross-item comparison
Related: checkbox badge

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
title string Draft the launch announcement Declared by @props in the registry Blade source.
description mixed|null null Declared by @props in the registry Blade source.
done bool false Declared by @props in the registry Blade source.
priority mixed|null null Declared by @props in the registry Blade source.
due mixed|null null Declared by @props in the registry Blade source.
tags array [] Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

todo-item

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.todo-item.default.blade.php Blade
<div class="mx-auto w-full max-w-sm space-y-2">
    <x-ui.todo-item
        title="Finalise the launch announcement"
        due="Today"
        priority="high"
        :tags="['Marketing']"
    />
    <x-ui.todo-item
        title="Review pull request #482"
        description="Token migration for the chart suite."
        due="Tomorrow"
        priority="medium"
    />
    <x-ui.todo-item
        title="Archive last quarter's boards"
        :done="true"
        priority="low"
    />
</div>

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.