@aria-ui/collection

Collection #

constructor

new Collection(items: Iterable<HTMLElement, any, any>, loop?: boolean): Collection

loop

Type: boolean

first

const first: () => null | string;

getElement

const getElement: (value: string) => null | HTMLElement;

getValues

const getValues: () => string[];

last

const last: () => null | string;

next

const next: (value: null | string) => null | string;

prev

const prev: (value: null | string) => null | string;

size

const size: () => number;

ItemFilter #

The filter function to determine if an item should be shown in the collection.

Type: (options: { query: string; value: string }) => boolean

defaultItemFilter #

A simple case-insensitive substring match filter.

function defaultItemFilter(options: { query: string; value: string }): boolean;