Interface CollectionModel<TItem>

Read-only ordered collection used by selection and focus primitives.

interface CollectionModel<TItem extends CollectionItem> {
    enabledItems(): TItem[];
    first(): TItem | undefined;
    get(id: string): TItem | undefined;
    items(): TItem[];
    last(): TItem | undefined;
    next(id?: string, options?: CollectionNavigationOptions): TItem | undefined;
    previous(
        id?: string,
        options?: CollectionNavigationOptions,
    ): TItem | undefined;
    size: number;
}

Type Parameters

TItem extends CollectionItem
Public item shape retained by the collection.

Index

Properties

Methods

enabledItems first get items last next previous

Properties

`Readonly`size

size: number

Number of items, including disabled items.

Methods

enabledItems

enabledItems(): TItem[]
Returns all enabled items in input order.

Returns TItem[]
- Defined in primitives/collection/index.ts:31

first

first(): TItem | undefined
Returns the first enabled item.

Returns TItem | undefined
- Defined in primitives/collection/index.ts:34

get

get(id: string): TItem | undefined
Finds an item by its stable identifier.
Parameters
- id: string
Returns TItem | undefined
- Defined in primitives/collection/index.ts:37

items

items(): TItem[]
Returns a defensive copy of all items in input order.

Returns TItem[]
- Defined in primitives/collection/index.ts:40

last

last(): TItem | undefined
Returns the last enabled item.

Returns TItem | undefined
- Defined in primitives/collection/index.ts:43

next

next(id?: string, options?: CollectionNavigationOptions): TItem | undefined
Returns the next enabled item relative to id.
Parameters
- Optionalid: string
- Optionaloptions: CollectionNavigationOptions
Returns TItem | undefined
- Defined in primitives/collection/index.ts:46

previous

previous(id?: string, options?: CollectionNavigationOptions): TItem | undefined
Returns the previous enabled item relative to id.
Parameters
- Optionalid: string
- Optionaloptions: CollectionNavigationOptions
Returns TItem | undefined
- Defined in primitives/collection/index.ts:49