@ux-aspects/ux-aspects
Version:
Open source user interface framework for building modern, responsive, mobile big data applications
22 lines (21 loc) • 687 B
TypeScript
/**
* The API available to option templates.
*/
export interface TypeaheadOptionApi<T = unknown> {
/**
* Returns the unique key value of the given option.
*/
getKey(option: T): string;
/**
* Returns the display value of the given option.
*/
getDisplay(option: T): string;
/**
* Returns the display value of the given option with HTML markup added to highlight the part which matches the current filter value. Override the ux-filter-match class in CSS to modify the default appearance.
*/
getDisplayHtml(option: T): string;
/**
* Returns the disabled state of a given option.
*/
getDisabled(option: T): boolean;
}