einundzwanzig-app/.junie/guidelines.md

Livewire Flux Component Guidelines

Usage Pattern

Components use the format: <flux:name />

Component Reference

Layout & Structure

• flux:card - Basic container with default slot
• flux:field - Form field wrapper with label/description support
• flux:brand - Logo/company name display with href navigation

Navigation

• flux:breadcrumbs - Navigation breadcrumbs

  • flux:breadcrumbs.item - Individual breadcrumb with href/icon

• flux:accordion - Collapsible content sections

  • flux:accordion.item - Individual accordion item with heading/content
  • flux:accordion.heading - Accordion header
  • flux:accordion.content - Accordion body

Form Controls

• flux:input - Text input with wire:model, validation, icons, masks
• flux:select - Select input
• flux:select.option - Select options
• flux:autocomplete - Searchable input with dropdown items
• flux:checkbox - Single checkbox or grouped checkboxes
• flux:date-picker - Date selection with calendar, ranges, presets
• flux:editor - Rich text editor with toolbar

Interactive Elements

• flux:button - Button with variants (primary, outline, danger), icons, loading states
• flux:dropdown - Dropdown menu with positioning options
• flux:menu - Complex menu with items, submenus, separators, checkboxes, radio buttons
• flux:command - Command palette with searchable items
• flux:context - Right-click context menu wrapper

Display Components

• flux:avatar - User avatar with initials, images, badges, grouping
• flux:badge - Status/label badges with colors and variants
• flux:callout - Highlighted information blocks with icons and actions
• flux:calendar - Calendar display with date selection modes
• flux:chart - Data visualization with lines, areas, axes, tooltips

Key Props

• wire:model - Livewire property binding
• variant - Visual style options (outline, primary, filled, etc.)
• size - Component sizing (xs, sm, base, lg, xl, 2xl)
• disabled/invalid - State management
• icon/icon:trailing - Icon placement with variants
• label/description - Form field labeling
• color - Color theming options

Common Patterns

• Most form components support wire:model binding
• Many components have label/description props for field wrapping
• Icon components accept variant options (outline, solid, mini, micro)
• Size props typically offer xs, sm, base, lg, xl, 2xl options
• Variant props provide visual style alternatives

===

=== foundation rules ===

Laravel Boost Guidelines

The Laravel Boost guidelines are specifically curated by Laravel maintainers for this application. These guidelines should be followed closely to enhance the user's satisfaction building Laravel applications.

Foundational Context

This application is a Laravel application and its main Laravel ecosystems package & versions are below. You are an expert with them all. Ensure you abide by these specific packages & versions.

• php - 8.4.14
• laravel/framework (LARAVEL) - v12
• laravel/prompts (PROMPTS) - v0
• livewire/flux (FLUXUI_FREE) - v2
• livewire/flux-pro (FLUXUI_PRO) - v2
• livewire/livewire (LIVEWIRE) - v3
• livewire/volt (VOLT) - v1
• laravel/mcp (MCP) - v0
• laravel/pint (PINT) - v1
• laravel/sail (SAIL) - v1
• pestphp/pest (PEST) - v3
• phpunit/phpunit (PHPUNIT) - v11
• tailwindcss (TAILWINDCSS) - v4

Conventions

• You must follow all existing code conventions used in this application. When creating or editing a file, check sibling files for the correct structure, approach, naming.
• Use descriptive names for variables and methods. For example, isRegisteredForDiscounts, not discount().
• Check for existing components to reuse before writing a new one.

Verification Scripts

• Do not create verification scripts or tinker when tests cover that functionality and prove it works. Unit and feature tests are more important.

Application Structure & Architecture

• Stick to existing directory structure - don't create new base folders without approval.
• Do not change the application's dependencies without approval.

Frontend Bundling

• If the user doesn't see a frontend change reflected in the UI, it could mean they need to run vendor/bin/sail yarn run build, vendor/bin/sail yarn run dev, or vendor/bin/sail composer run dev. Ask them.

Replies

• Be concise in your explanations - focus on what's important rather than explaining obvious details.

Documentation Files

• You must only create documentation files if explicitly requested by the user.

=== boost rules ===

Laravel Boost

• Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them.

Artisan

• Use the list-artisan-commands tool when you need to call an Artisan command to double check the available parameters.

URLs

• Whenever you share a project URL with the user you should use the get-absolute-url tool to ensure you're using the correct scheme, domain / IP, and port.

Tinker / Debugging

• You should use the tinker tool when you need to execute PHP to debug code or query Eloquent models directly.
• Use the database-query tool when you only need to read from the database.

Reading Browser Logs With the browser-logs Tool

• You can read browser logs, errors, and exceptions using the browser-logs tool from Boost.
• Only recent browser logs will be useful - ignore old logs.

Searching Documentation (Critically Important)

• Boost comes with a powerful search-docs tool you should use before any other approaches. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation specific for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages.
• The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc.
• You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches.
• Search the documentation before making code changes to ensure we are taking the correct approach.
• Use multiple, broad, simple, topic based queries to start. For example: ['rate limiting', 'routing rate limiting', 'routing'].
• Do not add package names to queries - package information is already shared. For example, use test resource table, not filament 4 test resource table.

Available Search Syntax

• You can and should pass multiple queries at once. The most relevant results will be returned first.

1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'
2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit"
3. Quoted Phrases (Exact Position) - query="infinite scroll" - Words must be adjacent and in that order
4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit"
5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms

=== php rules ===

PHP

• Always use curly braces for control structures, even if it has one line.

Constructors

• Use PHP 8 constructor property promotion in __construct().
  • public function __construct(public GitHub $github) { }
• Do not allow empty __construct() methods with zero parameters.

Type Declarations

• Always use explicit return type declarations for methods and functions.
• Use appropriate PHP type hints for method parameters.

protected function isAccessible(User $user, ?string $path = null): bool { ... }

Comments

• Prefer PHPDoc blocks over comments. Never use comments within the code itself unless there is something very complex going on.

PHPDoc Blocks

• Add useful array shape type definitions for arrays when appropriate.

Enums

• Typically, keys in an Enum should be TitleCase. For example: FavoritePerson, BestLake, Monthly.

=== sail rules ===

Laravel Sail

• This project runs inside Laravel Sail's Docker containers. You MUST execute all commands through Sail.
• Start services using vendor/bin/sail up -d and stop them with vendor/bin/sail stop.
• Open the application in the browser by running vendor/bin/sail open.
• Always prefix PHP, Artisan, Composer, and Node commands** with vendor/bin/sail. Examples:
• Run Artisan Commands: vendor/bin/sail artisan migrate
• Install Composer packages: vendor/bin/sail composer install
• Execute node commands: vendor/bin/sail yarn run dev
• Execute PHP scripts: vendor/bin/sail php [script]
• View all available Sail commands by running vendor/bin/sail without arguments.

=== tests rules ===

Test Enforcement

• Every change must be programmatically tested. Write a new test or update an existing test, then run the affected tests to make sure they pass.
• Run the minimum number of tests needed to ensure code quality and speed. Use vendor/bin/sail artisan test with a specific filename or filter.

=== laravel/core rules ===

Do Things the Laravel Way

• Use vendor/bin/sail artisan make: commands to create new files (i.e. migrations, controllers, models, etc.). You can list available Artisan commands using the list-artisan-commands tool.
• If you're creating a generic PHP class, use vendor/bin/sail artisan make:class.
• Pass --no-interaction to all Artisan commands to ensure they work without user input. You should also pass the correct --options to ensure correct behavior.

Database

• Always use proper Eloquent relationship methods with return type hints. Prefer relationship methods over raw queries or manual joins.
• Use Eloquent models and relationships before suggesting raw database queries
• Avoid DB::; prefer Model::query(). Generate code that leverages Laravel's ORM capabilities rather than bypassing them.
• Generate code that prevents N+1 query problems by using eager loading.
• Use Laravel's query builder for very complex database operations.

Model Creation

• When creating new models, create useful factories and seeders for them too. Ask the user if they need any other things, using list-artisan-commands to check the available options to vendor/bin/sail artisan make:model.

APIs & Eloquent Resources

• For APIs, default to using Eloquent API Resources and API versioning unless existing API routes do not, then you should follow existing application convention.

Controllers & Validation

• Always create Form Request classes for validation rather than inline validation in controllers. Include both validation rules and custom error messages.
• Check sibling Form Requests to see if the application uses array or string based validation rules.

Queues

• Use queued jobs for time-consuming operations with the ShouldQueue interface.

Authentication & Authorization

• Use Laravel's built-in authentication and authorization features (gates, policies, Sanctum, etc.).

URL Generation

• When generating links to other pages, prefer named routes and the route() function.

Configuration

• Use environment variables only in configuration files - never use the env() function directly outside of config files. Always use config('app.name'), not env('APP_NAME').

Testing

• When creating models for tests, use the factories for the models. Check if the factory has custom states that can be used before manually setting up the model.
• Faker: Use methods such as $this->faker->word() or fake()->randomDigit(). Follow existing conventions whether to use $this->faker or fake().
• When creating tests, make use of vendor/bin/sail artisan make:test [options] {name} to create a feature test, and pass --unit to create a unit test. Most tests should be feature tests.

Vite Error

• If you receive an "Illuminate\Foundation\ViteException: Unable to locate file in Vite manifest" error, you can run vendor/bin/sail yarn run build or ask the user to run vendor/bin/sail yarn run dev or vendor/bin/sail composer run dev.

=== laravel/v12 rules ===

Laravel 12

• Use the search-docs tool to get version specific documentation.
• Since Laravel 11, Laravel has a new streamlined file structure which this project uses.

Laravel 12 Structure

• No middleware files in app/Http/Middleware/.
• bootstrap/app.php is the file to register middleware, exceptions, and routing files.
• bootstrap/providers.php contains application specific service providers.
• No app\Console\Kernel.php - use bootstrap/app.php or routes/console.php for console configuration.
• Commands auto-register - files in app/Console/Commands/ are automatically available and do not require manual registration.

Database

• When modifying a column, the migration must include all of the attributes that were previously defined on the column. Otherwise, they will be dropped and lost.
• Laravel 11 allows limiting eagerly loaded records natively, without external packages: $query->latest()->limit(10);.

Models

• Casts can and likely should be set in a casts() method on a model rather than the $casts property. Follow existing conventions from other models.

=== fluxui-pro/core rules ===

Flux UI Pro

• This project is using the Pro version of Flux UI. It has full access to the free components and variants, as well as full access to the Pro components and variants.
• Flux UI is a component library for Livewire. Flux is a robust, hand-crafted, UI component library for your Livewire applications. It's built using Tailwind CSS and provides a set of components that are easy to use and customize.
• You should use Flux UI components when available.
• Fallback to standard Blade components if Flux is unavailable.
• If available, use Laravel Boost's search-docs tool to get the exact documentation and code snippets available for this project.
• Flux UI components look like this:

Available Components

This is correct as of Boost installation, but there may be additional components within the codebase.

accordion, autocomplete, avatar, badge, brand, breadcrumbs, button, calendar, callout, card, chart, checkbox, command, context, date-picker, dropdown, editor, field, heading, file upload, icon, input, modal, navbar, pagination, pillbox, popover, profile, radio, select, separator, switch, table, tabs, text, textarea, toast, tooltip

=== livewire/core rules ===

Livewire Core

• Use the search-docs tool to find exact version specific documentation for how to write Livewire & Livewire tests.
• Use the vendor/bin/sail artisan make:livewire [Posts\CreatePost] artisan command to create new components
• State should live on the server, with the UI reflecting it.
• All Livewire requests hit the Laravel backend, they're like regular HTTP requests. Always validate form data, and run authorization checks in Livewire actions.

Livewire Best Practices

• Livewire components require a single root element.

• Use wire:loading and wire:dirty for delightful loading states.

• Add wire:key in loops:

  @foreach ($items as $item)
      <div wire:key="item-{{ $item->id }}">
          {{ $item->name }}
      </div>
  @endforeach
  

• Prefer lifecycle hooks like mount(), updatedFoo() for initialization and reactive side effects:

public function mount(User $user) { $this->user = $user; } public function updatedSearch() { $this->resetPage(); }

Testing Livewire

Livewire::test(Counter::class) ->assertSet('count', 0) ->call('increment') ->assertSet('count', 1) ->assertSee(1) ->assertStatus(200);

<code-snippet name="Testing a Livewire component exists within a page" lang="php">
    $this->get('/posts/create')
    ->assertSeeLivewire(CreatePost::class);
</code-snippet>

=== livewire/v3 rules ===

Livewire 3

Key Changes From Livewire 2

• These things changed in Livewire 2, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions.
  • Use wire:model.live for real-time updates, wire:model is now deferred by default.
  • Components now use the App\Livewire namespace (not App\Http\Livewire).
  • Use $this->dispatch() to dispatch events (not emit or dispatchBrowserEvent).
  • Use the components.layouts.app view as the typical layout path (not layouts.app).

New Directives

• wire:show, wire:transition, wire:cloak, wire:offline, wire:target are available for use. Use the documentation to find usage examples.

Alpine

• Alpine is now included with Livewire, don't manually include Alpine.js.
• Plugins included with Alpine: persist, intersect, collapse, and focus.

Lifecycle Hooks

• You can listen for livewire:init to hook into Livewire initialization, and fail.status === 419 for the page expiring:

document.addEventListener('livewire:init', function () { Livewire.hook('request', ({ fail }) => { if (fail && fail.status === 419) { alert('Your session expired'); } });

Livewire.hook('message.failed', (message, component) => {
    console.error(message);
});

});

=== volt/core rules ===

Livewire Volt

• This project uses Livewire Volt for interactivity within its pages. New pages requiring interactivity must also use Livewire Volt. There is documentation available for it.
• Make new Volt components using vendor/bin/sail artisan make:volt [name] [--test] [--pest]
• Volt is a class-based and functional API for Livewire that supports single-file components, allowing a component's PHP logic and Blade templates to co-exist in the same file
• Livewire Volt allows PHP logic and Blade templates in one file. Components use the @volt directive.
• You must check existing Volt components to determine if they're functional or class based. If you can't detect that, ask the user which they prefer before writing a Volt component.

Volt Functional Component Example

@volt <?php use function Livewire\Volt\{state, computed};

state(['count' => 0]);

$increment = fn () => $this->count++; $decrement = fn () => $this->count--;

$double = computed(fn () => $this->count * 2); ?>

Count: {{ $count }}

Double: {{ $this->double }}

+ -

@endvolt

Volt Class Based Component Example

To get started, define an anonymous class that extends Livewire\Volt\Component. Within the class, you may utilize all of the features of Livewire using traditional Livewire syntax:

use Livewire\Volt\Component;

new class extends Component { public $count = 0;

public function increment()
{
    $this->count++;
}

} ?>

{{ $count }}

+

Testing Volt & Volt Components

• Use the existing directory for tests if it already exists. Otherwise, fallback to tests/Feature/Volt.

use Livewire\Volt\Volt;

test('counter increments', function () { Volt::test('counter') ->assertSee('Count: 0') ->call('increment') ->assertSee('Count: 1'); });

declare(strict_types=1);

use App\Models{User, Product}; use Livewire\Volt\Volt;

test('product form creates product', function () { $user = User::factory()->create();

Volt::test('pages.products.create')
    ->actingAs($user)
    ->set('form.name', 'Test Product')
    ->set('form.description', 'Test Description')
    ->set('form.price', 99.99)
    ->call('create')
    ->assertHasNoErrors();

expect(Product::where('name', 'Test Product')->exists())->toBeTrue();

});

Common Patterns

<?php

use App\Models\Product; use function Livewire\Volt{state, computed};

state(['editing' => null, 'search' => '']);

$products = computed(fn() => Product::when($this->search, fn($q) => $q->where('name', 'like', "%{$this->search}%") )->get());

$edit = fn(Product $product) => $this->editing = $product->id; $delete = fn(Product $product) => $product->delete();

?>

Save Saving...

=== pint/core rules ===

Laravel Pint Code Formatter

• You must run vendor/bin/sail bin pint --dirty before finalizing changes to ensure your code matches the project's expected style.
• Do not run vendor/bin/sail bin pint --test, simply run vendor/bin/sail bin pint to fix any formatting issues.

=== pest/core rules ===

Pest

Testing

• If you need to verify a feature is working, write or update a Unit / Feature test.

Pest Tests

• All tests must be written using Pest. Use vendor/bin/sail artisan make:test --pest {name}.
• You must not remove any tests or test files from the tests directory without approval. These are not temporary or helper files - these are core to the application.
• Tests should test all of the happy paths, failure paths, and weird paths.
• Tests live in the tests/Feature and tests/Unit directories.
• Pest tests look and behave like this: it('is true', function () { expect(true)->toBeTrue(); });

Running Tests

• Run the minimal number of tests using an appropriate filter before finalizing code edits.
• To run all tests: vendor/bin/sail artisan test.
• To run all tests in a file: vendor/bin/sail artisan test tests/Feature/ExampleTest.php.
• To filter on a particular test name: vendor/bin/sail artisan test --filter=testName (recommended after making a change to a related file).
• When the tests relating to your changes are passing, ask the user if they would like to run the entire test suite to ensure everything is still passing.

Pest Assertions

• When asserting status codes on a response, use the specific method like assertForbidden and assertNotFound instead of using assertStatus(403) or similar, e.g.: it('returns all', function () { $response = $this->postJson('/api/docs', []);

  $response->assertSuccessful(); });

Mocking

• Mocking can be very helpful when appropriate.
• When mocking, you can use the Pest\Laravel\mock Pest function, but always import it via use function Pest\Laravel\mock; before using it. Alternatively, you can use $this->mock() if existing tests do.
• You can also create partial mocks using the same import or self method.

Datasets

• Use datasets in Pest to simplify tests which have a lot of duplicated data. This is often the case when testing validation rules, so consider going with this solution when writing tests for validation rules.

it('has emails', function (string $email) { expect($email)->not->toBeEmpty(); })->with([ 'james' => 'james@laravel.com', 'taylor' => 'taylor@laravel.com', ]);

=== tailwindcss/core rules ===

Tailwind Core

• Use Tailwind CSS classes to style HTML, check and use existing tailwind conventions within the project before writing your own.
• Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc..)
• Think through class placement, order, priority, and defaults - remove redundant classes, add classes to parent or child carefully to limit repetition, group elements logically
• You can use the search-docs tool to get exact examples from the official documentation when needed.

Spacing

• When listing items, use gap utilities for spacing, don't use margins.

  Superior

  Michigan

  Erie

Dark Mode

• If existing pages and components support dark mode, new pages and components must support dark mode in a similar way, typically using dark:.

=== tailwindcss/v4 rules ===

Tailwind 4

• Always use Tailwind CSS v4 - do not use the deprecated utilities.

• corePlugins is not supported in Tailwind v4.

• In Tailwind v4, configuration is CSS-first using the @theme directive — no separate tailwind.config.js file is needed. @theme { --color-brand: oklch(0.72 0.11 178); }

• In Tailwind v4, you import Tailwind using a regular CSS @import statement, not using the @tailwind directives used in v3:

- @tailwind base; - @tailwind components; - @tailwind utilities; + @import "tailwindcss";

Replaced Utilities

• Tailwind v4 removed deprecated utilities. Do not use the deprecated option - use the replacement.
• Opacity values are still numeric.

| Deprecated | Replacement | |------------+--------------| | bg-opacity-* | bg-black/* | | text-opacity-* | text-black/* | | border-opacity-* | border-black/* | | divide-opacity-* | divide-black/* | | ring-opacity-* | ring-black/* | | placeholder-opacity-* | placeholder-black/* | | flex-shrink-* | shrink-* | | flex-grow-* | grow-* | | overflow-ellipsis | text-ellipsis | | decoration-slice | box-decoration-slice | | decoration-clone | box-decoration-clone |