noerd-list-development

Noerd List Development

A Noerd list is a Livewire single-file component that uses the NoerdList trait and is configured by a YAML file. The hard rules live in the noerd/noerd Boost guideline (## Noerd Framework); this skill is the step-by-step procedure. The package docs are in vendor/noerd/noerd/docs/ (app-modules/noerd/docs/ for a submodule install) — read list-view.md first, then list-search.md and list-filters.md when search/filters are involved.

1. Decide what you are building

2. Create the component — resources/views/components/{entities}-list.blade.php

Plural name, directly in components/ (no subfolders). Reference: the noerd:make-resource stub src/Commands/stubs/resource/list.blade.stub.

<?php

use Livewire\Component;
use Noerd\Traits\NoerdList;
use Vendor\Module\Models\Thing;

new class extends Component {
    use NoerdList;

    public $listModel = Thing::class;

    public ?string $detailRoute = 'module.thing.detail';      // route modal, URL rewritten

    public $detailComponent = 'module::thing-detail';        // fallback when the route is missing
}; ?>

<x-noerd::page>
    <x-noerd::list/>
</x-noerd::page>

• Nothing else goes into a slim component. mount(), listAction(), listData(), renderingNoerdList() come from the trait.
• $detailRoute is mandatory for every list whose rows open a record: the row click ALWAYS opens the record by route (URL rewritten). Never override listAction() to open a component modal or a list narrowed by the clicked row. A record without an editable form (mirrored data) gets a read-only *-detail (readonly: true fields, no save bar, store()/delete() no-ops) that embeds the narrowed list through lists: — and the row opens THAT route.
• Default sort: a defaultSort: block in the list YAML (field: + optional direction: asc|desc, desc when omitted) — both synced copies, never component code. A user-picked sort persists in the session and wins; never set $sortField/$sortAsc directly.
• Custom query: override listData() only — $rows = $this->listQuery($this->listModel)->where(...)->with(...)->paginate($this->perPage); return $this->buildList($rows); Keep extra view data (e.g. a summary) in a slim with() that shares the query via a private helper. Never put the query into with() once $listModel is declared.