HelixOverviewDocsComponentsSandboxTheme builderCortexDocsEngramBuildingTraceBuildingRecallDeclaredServicesInsightsGet in touchSource on GitHub
Loading the reference
ListView SourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorA set of rows, read as a set.StableSince 0.1.0DataUsageimport'@fusion.dev/helix/list'import'@fusion.dev/helix-headless/list'Preview
API ReferenceRoothelix-listA set of rows, read as a set.
PropTypeDefaultDescriptiondividedbooleanfalseWhether a rule sits between rows.kind"default"|"description"|"ordered"|"unordered"What kind of list this is, which is a fact about the content.labelstring""Accessible name for the set.marker"rail"Where the marker sits.type"1"|"a"|"A"|"i"|"I"Which markers an ordered list draws, in `<ol type>`'s own five values.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The rows.
CSS PropertyDescription--list-gapSpace between rows.--list-marker-gutterRoom the ordered and unordered markers hang into.--list-rail-inline-sizeThe width of the rail's track.--list-rail-styleWhat a rail counts with. Any `list-style-type`.
Itemhelix-list-itemOne row of a list.
PropTypeDefaultDescriptionhrefstring""Where the row goes, and nothing when it goes nowhere.relstring""What the link declares about where it goes. The consumer's decision rather
than one derived from `target`, for the reason `Tree.Item` gives.targetstring""Where the link opens, for the rare row that leaves the site.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The label.endTrailing content.startLeading content, usually an icon or an avatar.supportingSecondary text under the label.
PartDescriptionrailThe cell a railed list draws its number in.rowThe layout, held off the host so the host can carry a marker.
CSS PropertyDescription--list-item-paddingPadding inside the row.--list-item-rail-contentWhat the rail cell shows. Written by the list.--list-item-rail-displayWhether there is a rail at all. Written by the list.--list-item-term-weightWeight of a description list's term.
Roothelix-headless-listA set of rows, read as a set.
PropTypeDefaultDescriptionkind"default"|"description"|"ordered"|"unordered"What kind of list this is, which is a fact about the content.labelstring""Accessible name for the set.type"1"|"a"|"A"|"i"|"I"Which markers an ordered list draws, in `<ol type>`'s own five values.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The rows.
Itemhelix-headless-list-itemOne row of a list.
PropTypeDefaultDescriptionhrefstring""Where the row goes, and nothing when it goes nowhere.relstring""What the link declares about where it goes. The consumer's decision rather
than one derived from `target`, for the reason `Tree.Item` gives.targetstring""Where the link opens, for the rare row that leaves the site.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The label.endTrailing content.startLeading content, usually an icon or an avatar.supportingSecondary text under the label.
PartDescriptionrowThe layout, held off the host so the host can carry a marker.
ExamplesNameDescriptionKindsThe list as plain rows, as rows with rules, and as separate cards.LinkedRows that navigate, each whole row being the target.PreviewRows with rules between them.PreviewRows with rules between them.RailedA numbered argument, with the numbers in a rail rather than beside the words.