KeyValue
Labeled facts with stable ordering, wrapping and semantic links.
Use the web element directly without the semantic runtime.
A registered presentation adapter can bind this component to host-owned meaning and state.
The standard recipe resolver does not select this component automatically.
Import and live example#
Two ordered facts showing owner and current authorized scope.
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<AeliqoKeyValueElement>("aeliqo-key-value", root);
const items = [{
key: "owner",
label: "Owner",
value: "Ada Lovelace"
}, {
key: "scope",
label: "Scope",
value: "Authorized people",
description: "Current report scope"
}];
element.items = items;
element.scope = catalogScope;
}))(root);
Purpose#
Show a short ordered list of labeled facts as a definition list. Each fact can carry a description or a safe link.
When to use it#
- List a few stable facts like owner, status, or scope.
- Keep fact order fixed so labels stay predictable.
- Attach an approved link to a fact.
When to use a different component#
- Use Detail to show a selected record with identity and missing-field labels.
- Use RecordList when browsing and selecting records is the task.
Properties and defaults#
Each item carries a stable key, label, and host-supplied value or display value; links require approved hrefs.
| Property | Use and ownership | Declared type | Initial value |
|---|---|---|---|
items | Supplies the ordered bounded items with stable IDs and display labels. | readonly AeliqoKeyValueItem[] | [] |
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#
- None; links use native navigation
States and failure handling#
Relevant states:
- ready
- loading
- empty
- partial
- stale
- error
Expected result: Facts use definition-list semantics and preserve missing/status meaning.
Keyboard, focus, and accessibility#
Keyboard behavior:
- Tab reaches approved item links
Exposed semantics:
- a
- aria-describedby
- dd
- dl
- dt
- role
Responsive behavior#
Allow definition-list labels and values to wrap in reading order. Keep each label adjacent to its value.
Style hooks#
- Shadow parts:
description,item,label,link,list,scope,status,value - Varendo design tokens referenced:
--aeliqo-color-accent,--aeliqo-color-muted,--aeliqo-space-12,--aeliqo-space-4,--aeliqo-typography-font-size-caption
Related components#
Generated TypeScript declaration#
View generated declaration
export declare class AeliqoKeyValueElement extends LitElement {
static readonly aeliqoVersion = "0.1.0";
static readonly properties: {
items: {
attribute: boolean;
};
scope: {
attribute: boolean;
};
status: {
type: StringConstructor;
};
message: {
type: StringConstructor;
};
};
items: readonly AeliqoKeyValueItem[];
scope: AeliqoDataScope | undefined;
status: AeliqoDataStatus;
message: string;
protected render(): import("lit").TemplateResult<1>;
private renderItem;
static readonly styles: import("lit").CSSResult[];
}Version#
This page documents the Varendo 0.6 component contract.
