45 lines
1.9 KiB
TypeScript
45 lines
1.9 KiB
TypeScript
declare function getFirstItem<T>(array: T[]): T | undefined;
|
|
declare function getLastItem<T>(array: T[]): T | undefined;
|
|
declare function getPrevItem<T>(index: number, array: T[], loop?: boolean): T;
|
|
declare function getNextItem<T>(index: number, array: T[], loop?: boolean): T;
|
|
declare function removeIndex<T>(array: T[], index: number): T[];
|
|
declare function addItem<T>(array: T[], item: T): T[];
|
|
declare function removeItem<T>(array: T[], item: T): T[];
|
|
/**
|
|
* Get the next index based on the current index and step.
|
|
*
|
|
* @param currentIndex the current index
|
|
* @param length the total length or count of items
|
|
* @param step the number of steps
|
|
* @param loop whether to circle back once `currentIndex` is at the start/end
|
|
*/
|
|
declare function getNextIndex(currentIndex: number, length: number, step?: number, loop?: boolean): number;
|
|
/**
|
|
* Gets the previous index based on the current index.
|
|
* Mostly used for keyboard navigation.
|
|
*
|
|
* @param index - the current index
|
|
* @param count - the length or total count of items in the array
|
|
* @param loop - whether we should circle back to the
|
|
* first/last once `currentIndex` is at the start/end
|
|
*/
|
|
declare function getPrevIndex(index: number, count: number, loop?: boolean): number;
|
|
/**
|
|
* Converts an array into smaller chunks or groups.
|
|
*
|
|
* @param array the array to chunk into group
|
|
* @param size the length of each chunk
|
|
*/
|
|
declare function chunk<T>(array: T[], size: number): T[][];
|
|
/**
|
|
* Gets the next item based on a search string
|
|
*
|
|
* @param items array of items
|
|
* @param searchString the search string
|
|
* @param itemToString resolves an item to string
|
|
* @param currentItem the current selected item
|
|
*/
|
|
declare function getNextItemFromSearch<T>(items: T[], searchString: string, itemToString: (item: T) => string, currentItem: T): T | undefined;
|
|
|
|
export { addItem, chunk, getFirstItem, getLastItem, getNextIndex, getNextItem, getNextItemFromSearch, getPrevIndex, getPrevItem, removeIndex, removeItem };
|