Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,15 @@ For UI changes, also inspect affected demo routes with `npm run dev` (port 5180)
There is no automated test script. Documentation-only changes need path and
format validation rather than application builds.

`CHANGELOG.md` is for consumers and is written by release-please from the
squash-merged PR title, so make that title a Conventional Commit that describes
the change as a consumer sees it (`feat:` new components or options, `fix:`
behaviour and skill corrections, `fix(deps):` runtime dependencies; `chore:`,
`ci:` and `docs:` stay out of the changelog). When one PR carries several
consumer-visible changes, list each as its own Conventional Commit between
`BEGIN_COMMIT_OVERRIDE` and `END_COMMIT_OVERRIDE` in the PR body. If an upgrade
needs action from consumers, add an "Upgrading" note to the release PR's
`CHANGELOG.md` entry before merging it.

Preserve the Claude plugin and marketplace configuration. Before editing a
subdirectory, read any nested agent guidance and applicable scoped rules.
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ npm install @liasoft/lit-ui bootstrap

```ts
import '@liasoft/lit-ui/styles.css';
import { initTheme } from '@liasoft/lit-ui';
import { initTheme, installConfirmHandler } from '@liasoft/lit-ui';

initTheme();
const uninstallConfirm = installConfirmHandler(); // call on app teardown
```

Import the whole kit, or just the families you need:
Expand Down Expand Up @@ -57,10 +58,21 @@ working in your repo loads exactly the component knowledge it needs — nothing
After that, asking Claude Code to "add a members listing with row actions" makes it
reach for `TableListing` and `lia-data-table` the way this README would.

The same skills ship in the npm package, matching the installed version, under
`node_modules/@liasoft/lit-ui/plugins/lit-ui/skills/`. Point other agents (Codex,
Copilot) at `overview/SKILL.md` there, for example from your `AGENTS.md`.

## What changed

[CHANGELOG.md](CHANGELOG.md) lists every release: new components and options, fixes,
and what to change when you upgrade.

---

## A complete page

For a routed app, start with the [complete shell and page recipe](plugins/lit-ui/skills/layout/SKILL.md#compose-a-routed-application). Extend `LiaTransparentElement` for app/view wrappers, let `lia-page` own the heading and gutter, and use `lia-card` for titled sections. Set the shell’s `content-class=""` when a router view or error boundary wraps the page.

```ts
import { html, render } from 'lit';
import '@liasoft/lit-ui';
Expand All @@ -70,12 +82,13 @@ render(html`
brand-label="Orbit Console"
.navItems=${nav}
.user=${{ loginname: 'amara', isAdmin: true }}
search-enabled
.searchEnabled=${false}
>
<lia-page title="Members" icon="fa-solid fa-users"
<lia-page .title=${'Members'} icon="fa-solid fa-users"
.actions=${[{ id: 'add', label: 'Invite a member', icon: 'fa-solid fa-plus',
variant: 'primary' }]}
>
<lia-card .title=${'Members'} icon="fa-solid fa-users" .content=${html`
<lia-data-table
listing-id="members"
.columns=${[
Expand All @@ -91,15 +104,16 @@ render(html`
confirm: { message: `Delete ${row.name}?` } },
]}
@lia-action=${(e) => console.log(e.detail.action.id, e.detail.row)}
></lia-data-table>
></lia-data-table>`}></lia-card>
</lia-page>
</lia-app-shell>
`, document.querySelector('#app'));
```

That is the whole page: sidebar, navbar with global search, heading bar with a toolbar,
sortable and selectable table with bulk actions, per-row confirm dialogs, pagination,
column manager and search.
This composes the sidebar, navbar, heading toolbar and attached table with pagination,
column manager and search. Supply `nav`, `members` and your action handlers; install
the confirmation handler from the setup above for styled per-row dialogs. Enable
global search only when the app handles `lia-search` and supplies results.

---

Expand Down
Loading
Loading