@types/awesomplete

Installation

npm install --save @types/awesomplete

Summary

This package contains type definitions for awesomplete (https://leaverou.github.io/awesomplete/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/awesomplete.

index.d.ts

declare class Awesomplete {
    constructor(input: Element | HTMLElement | string, o?: Awesomplete.Options);
    static all: any[];
    static $$(expr: string | ParentNode, con?: any): NodeList;
    static ITEM: (text: string, input: string) => HTMLElement;
    static $: {
        (expr: string | Element, con?: ParentNode): string | Element;
        regExpEscape(s: { replace(arg0: RegExp, arg1: string): void }): any;
        create(tag: string, o: any): HTMLElement;
        fire(target: EventTarget, type: string, properties: any): any;
        siblingIndex(el: Element): number;
    };
    static FILTER_STARTSWITH: (text: string, input: string) => boolean;
    static FILTER_CONTAINS: (text: string, input: string) => boolean;
    static SORT_BYLENGTH: (left: number | any[], right: number | any[]) => number;
    static REPLACE: (text: string) => void;
    static DATA: (item: Awesomplete.Suggestion) => Awesomplete.Suggestion;
    next: () => void;
    container: HTMLElement;
    select: (selected?: HTMLElement, originalTarget?: HTMLElement) => void;
    previous: () => void;
    index: number;
    opened: number;
    list: string | Element | Awesomplete.Suggestion[];
    input: HTMLElement | string;
    goto: (i: number) => void;
    ul: HTMLElement;
    close: () => void;
    evaluate: () => void;
    selected: boolean;
    open: () => void;
    status: HTMLElement;
    destroy: () => void;
}

declare namespace Awesomplete {
    type Suggestion = string | { label: string | any; value: string | any } | [string, string];
    type SortFunction = (left: number | any[], right: number | any[]) => number;

    interface Options {
        list?: string | string[] | Element | Array<{ label: string; value: any }> | Array<[string, string]> | undefined;
        minChars?: number | undefined;
        maxItems?: number | undefined;
        autoFirst?: boolean | undefined;
        data?(item: Suggestion, input: string): string;
        filter?(text: string, input: string): boolean;
        sort?: boolean | SortFunction | undefined;
        item?(text: string, input: string, item_id: number): HTMLElement;
        replace?(suggestion: string | Suggestion): void;
        container?(input: HTMLElement): HTMLElement;
    }
}

export = Awesomplete;
export as namespace Awesomplete;

Additional Details

• Last updated: Thu, 15 Aug 2024 11:07:04 GMT
• Dependencies: none

Credits

These definitions were written by webbiesdk, Ben Dixon, Trevor Bekolay, and Chris LoPresto.