Skip to content
Velkin LogoVelkin Logo
Velkin
VELKIN/UI

Modern UI components for product teams and their AI agents. Lit core, typed wrappers, live MCP.

sales@velkinui.com

Product

  • Docs
  • Components
  • Studio
  • Pricing

Resources

  • Quick start
  • Blog
  • Changelog
  • Roadmap
  • Status

Project

  • About
  • Contact
  • License
  • Privacy
  • Terms

© 2026 Velkin. MIT core · Pro licenses available.

VELKIN

List

A list component with selection, type-ahead, and keyboard navigation.

vu-list · @velkin/react/list

Copy page

Import

React
npm i @velkin/react

import { VuList } from "@velkin/react/list";

Examples

API

Tables match the member selected under Import.

Props

PropTypeDefaultDescription
selectionVuListSelectionMode"none"Selection mode for child rows. Default: `"none"`.
selectedValuesstring[]—Controlled selection tokens; omit for uncontrolled mode.
defaultSelectedValuesstring[][]Initial selection when uncontrolled. Default: `[]`.
sizeVuListSize"md"Default row density. Default: `"md"`.
toneVuListTone"normal"Neutral surface weight for the list shell. Default: `"normal"`.
densebooleanfalseCompact rows on the list and items. Default: `false`.
autofocusbooleanfalseFocuses the first row after first render. Default: `false`.
ariaLabelstring""Accessible name when there is no visible list label. Default: `""`.

Events

EventDetailDescription
vu-changeVuListChangeDetailWhen selection changes (`detail.selectedValues`).

Slots

SlotDescription
—- Default slot for `<vu-listitem>` children.

CSS parts

PartDescription
baseBordered list surface wrapping the default slot.

Methods

MethodDescription
focusListItem- Focuses a focusable item by index among non-subheader rows.
getItems- Returns slotted `<vu-listitem>` instances in document order.
handleRowKeydown- Keyboard handler invoked by each row (internal).

Types

NameDefinition
VuListChangeDetail
{
  selectedItems: VuListitem[];
  selectedValues: string[];
}
VuListSelectionMode
"none" | "single" | "multiple"
VuListSize
"sm" | "md" | "lg"
VuListTone
"subtle" | "normal" | "strong"

Related

Companions

  • Listitem`vu-listitem`

Data display

  • AvatarAn avatar component with image, initials, icon, or custom content.
  • Avatar GroupAn avatar group component that stacks overlapping avatars.
  • BadgeA badge component for counts, status dots, and overlay marks.
  • ChipA chip component for tags and filters with dismiss or toggle actions.
  • Data TableA data table component with sorting, filtering, and selection.
  • DividerA divider component for horizontal or vertical layout separation.

Guides

  • AppearanceShared visual props
  • EventsSelection and change events

Browse

  • Previous: KanbanEarlier in the sidebar
  • Next: Model ViewerLater in the sidebar
  • All componentsBrowse the full index