Skip to content
Theme:

Ui3nList

List component for displaying a collection of items with optional title and custom item rendering.

Props

NameTypeDefaultDescription
idstring | undefined

Root element id

titlestring | undefined""

List title

stickyboolean | undefinedtrue

Whether to stick to top

items*T[]

List items

keyFieldkeyof T | undefined"id" as keyof T

Key field for items

disabledboolean | undefinedfalse

Whether list is disabled

Events

Event NameArguments / Value TypeDescription
select{ value: T; index: number; }

Emitted when item is selected

Slots

Slot NameScope Props (v-slot)Description
#title

Title slot

#item{ item: T; index: number; }

Item slot

Usage Examples

Simple list

Simple list

Basic list with string items

{ "id": 1, "text": "Item 1" }
{ "id": 2, "text": "Item 2" }
{ "id": 3, "text": "Item 3" }
{ "id": 4, "text": "Item 4" }
{ "id": 5, "text": "Item 5" }

List with title

List with title

List with a sticky title

Fruits Collection (Scroll Me)
{ "code": "ap", "name": "Apple" }
{ "code": "ba", "name": "Banana" }
{ "code": "ch", "name": "Cherry" }
{ "code": "dt", "name": "Date" }
{ "code": "eb", "name": "Elderberry" }
{ "code": "fg", "name": "Fig" }
{ "code": "gr", "name": "Grape" }
{ "code": "ki", "name": "Kiwi" }
{ "code": "lm", "name": "Lemon" }
{ "code": "mn", "name": "Mango" }

Custom item slot

Custom item slot

List with custom item rendering using the item slot

System Users
#1
#2
#3