RecordList
Scannable records with identity-based selection and reachable additional fields.
Use the web element directly without the semantic runtime.
A registered presentation adapter can bind this component to host-owned meaning and state.
A standard recipe can select this component when its task, bindings, data, and policy are eligible.
Import and live example#
Three people rendered as a single-select identity list.
Interactive preview requires JavaScript.
View the complete example source
import {registerAeliqoElements} from "@varendo/web";
import {
AeliqoCardCollectionElement,
AeliqoDeltaElement,
AeliqoDetailElement,
AeliqoFilterBuilderElement,
AeliqoKeyValueElement,
AeliqoMetricElement,
AeliqoRecordListElement,
AeliqoSelectionSummaryElement,
AeliqoTableElement,
type AeliqoKeyValueItem,
type AeliqoTableColumn,
type AeliqoTableRow,
} from "@varendo/web/data";
import type {ResultRef,
Scalar,
} from "@varendo/core";
import type {AeliqoDataColumn, AeliqoDataScope, AeliqoFieldOption} from "@varendo/web/data";
const catalogRef: ResultRef = {
id: "aeliqo-catalog-example",
revision: "1",
outputId: "people",
queryDigest: "catalog-query",
scopeDigest: "catalog-scope",
};
const catalogRows: readonly Readonly<Record<string, Scalar>>[] = [
{id: "ada", name: "Ada Lovelace", team: "Research", date: "2026-09-08", amount: 120},
{id: "lin", name: "Lin Chen", team: "Product", date: "2026-09-09", amount: 96},
{id: "grace", name: "Grace Hopper", team: "Research", date: "2026-09-10", amount: 144},
];
const catalogColumns: readonly AeliqoDataColumn[] = [
{key: "id", label: "ID", type: "text", sortable: true},
{key: "name", label: "Name", type: "text", sortable: true},
{key: "team", label: "Team", type: "text"},
{key: "date", label: "Date", type: "date", sortable: true},
{key: "amount", label: "Amount", type: "integer", align: "end"},
];
const catalogFields: readonly AeliqoFieldOption[] = [
{id: "name", label: "Name", type: "text"},
{id: "team", label: "Team", type: "text"},
{id: "amount", label: "Amount", type: "integer"},
];
const catalogScope: AeliqoDataScope = {
loaded: catalogRows.length,
filteredTotal: catalogRows.length,
populationDigest: catalogRef.scopeDigest,
kind: "filtered",
label: "Authorized people",
};
const tableColumns: readonly AeliqoTableColumn[] = catalogColumns.map(({key, label, sortable, align}) => ({key, label, ...(sortable === undefined ? {} : {sortable}), ...(align === undefined ? {} : {align})}));
const tableRows: readonly AeliqoTableRow[] = catalogRows.map((row) => ({id: row.id ?? null, name: row.name ?? null, team: row.team ?? null, date: row.date ?? null, amount: row.amount ?? null}));
const personKeys = ["string:3:ada", "string:5:grace"] as const;
registerAeliqoElements();
const host = document.querySelector<HTMLElement>("#aeliqo-example") ?? (() => {
const created = document.createElement("div");
created.id = "aeliqo-example";
(document.body ?? document.documentElement).append(created);
return created;
})();
function createCatalogRoot(container: HTMLElement): HTMLElement {
const root = document.createElement("div");
root.dataset.catalogSourceRoot = "true";
root.style.display = "grid";
root.style.gap = "12px";
container.append(root);
return root;
}
function createCatalogElement<T extends HTMLElement>(tagName: string, container: HTMLElement): T {
const element = document.createElement(tagName) as T;
element.setAttribute("data-aeliqo-theme", "light");
container.append(element);
return element;
}
function appendSlottedText(root: HTMLElement, slot: string, textContent: string): void {
const content = document.createElement("span");
content.slot = slot;
content.textContent = textContent;
root.append(content);
}
const root = createCatalogRoot(host);
(((root) => {
const element = createCatalogElement<AeliqoRecordListElement>("aeliqo-record-list", root);
element.title = "People";
element.rows = catalogRows;
element.columns = catalogColumns;
element.identity = ["id"];
element.entity = "person";
element.selection = "single";
element.selectedKeys = [personKeys[0]];
element.result = catalogRef;
element.scope = catalogScope;
}))(root);
Purpose#
Show records in a compact, scannable list. Selection emits stable record keys; the application applies them.
When to use it#
- Browse records where reading order matters more than columns.
- Let people select one or more records by stable identity.
- Expose extra fields on demand while rows stay compact.
When to use a different component#
- Use Table when sorting, paging, or comparing columns is the task.
- Use CardCollection when each record needs a heading and card layout.
Properties and defaults#
selectedKeys is controlled by the host and keys derive from declared identity fields, never visible row indexes.
| Property | Use and ownership | Declared type | Initial value |
|---|---|---|---|
rows | Supplies the bounded records to render. The component never fetches or widens this set. | readonly AeliqoDataRecord[] | [] |
columns | Defines ordered visible fields, labels, formatting, alignment, and supported column interactions. | readonly AeliqoDataColumn[] | [] |
identity | Lists stable identity fields used for selection, detail targeting, and state transfer. | readonly string[] | [] |
entity | Names the catalog entity whose records and identities are displayed. | string | 'record' |
selection | Chooses none, single, or multiple selection behavior. | AeliqoSelectionMode | 'none' |
selectedKeys | Controls the current collection selection using stable encoded identities. | readonly string[] | [] |
result | Supplies the Result reference that binds displayed data to its query and scope evidence. | ResultRef | undefined | undefined |
title | Provides the visible title for the current data or compound surface. | string | '' |
emptyLabel | Provides the text shown when no value or row is available. | string | 'No records to display.' |
scope | Supplies the visible authorization and population scope associated with the displayed value or rows. | AeliqoDataScope | undefined | undefined |
status | Supplies the explicit ready, loading, empty, partial, stale, or error state. | AeliqoDataStatus | 'ready' |
message | Provides the user-facing status, error, or recovery message. | string | '' |
Events#
| Event | Payload | Emitted | Application responsibility |
|---|---|---|---|
aeliqo-record-list-selection | Stable selected identity keys plus result lineage. | After record-list selection changes. | Validate scope and update controlled selectedKeys. |
Events cross the component boundary as user proposals. Validate their detail and current authority before applying a business effect.
Listen for aeliqo-record-list-selection
const element = document.querySelector('aeliqo-record-list');<p>element?.addEventListener('aeliqo-record-list-selection', (event) => {
const proposal = (event as CustomEvent<unknown>).detail;
// Validate the proposal, update host state, then assign controlled properties.
applyProposal(proposal);
});States and failure handling#
Relevant states:
- ready
- empty
- loading
- partial
- stale
- error
Expected result: Rows remain in the supplied scope and selection requests carry stable identities and lineage.
Keyboard, focus, and accessibility#
Keyboard behavior:
- Tab
- Enter
- Space
- Arrow keys where list navigation applies
Exposed semantics:
- aria-label
- aria-pressed
- button
- li
- role
- section
- ul
Responsive behavior#
Keep rendered row counts bounded for long lists. Preserve stable identity and the selected state as the list width changes.
Style hooks#
- Shadow parts:
fact,facts,field-label,field-value,list,primary,record,record-button,records,scope,status,title - Varendo design tokens referenced:
--aeliqo-color-accent,--aeliqo-color-border,--aeliqo-color-muted,--aeliqo-color-surface,--aeliqo-control-border-width,--aeliqo-radius-medium,--aeliqo-space-12,--aeliqo-space-4,--aeliqo-space-8,--aeliqo-typography-font-size-caption,--aeliqo-typography-font-size-title,--aeliqo-typography-font-weight-semibold
Related components#
Generated TypeScript declaration#
View generated declaration
export declare class AeliqoRecordListElement extends LitElement {
static readonly aeliqoVersion = "0.1.0";
static readonly properties: {
rows: {
attribute: boolean;
};
columns: {
attribute: boolean;
};
identity: {
attribute: boolean;
};
entity: {
type: StringConstructor;
};
selection: {
type: StringConstructor;
};
selectedKeys: {
attribute: boolean;
};
result: {
attribute: boolean;
};
title: {
type: StringConstructor;
};
emptyLabel: {
attribute: string;
type: StringConstructor;
};
scope: {
attribute: boolean;
};
status: {
type: StringConstructor;
};
message: {
type: StringConstructor;
};
};
rows: readonly AeliqoDataRecord[];
columns: readonly AeliqoDataColumn[];
identity: readonly string[];
entity: string;
selection: AeliqoSelectionMode;
selectedKeys: readonly string[];
result: ResultRef | undefined;
title: string;
emptyLabel: string;
scope: AeliqoDataScope | undefined;
status: AeliqoDataStatus;
message: string;
protected render(): import("lit").TemplateResult<1>;
private renderRow;
private selectionLabel;
private readonly requestSelection;
static readonly styles: import("lit").CSSResult[];
}Version#
This page documents the Varendo 0.6 component contract.
