jspreadsheet 12.4.5 → 12.5.0

package/dist/index.d.ts

@@ -570,8 +570,6 @@ declare namespace jspreadsheet {
     }
 
     interface Dropdown {
-        /** Endpoint to fetch data from a remote server */
-        url?: string;
         /** Preloaded data items for the dropdown */
         data?: DropdownItem[];
         /** Format type of the data, typically { id: name } or { value: text } */
@@ -580,73 +578,72 @@ declare namespace jspreadsheet {
         multiple?: boolean;
         /** Enables the autocomplete feature for user input */
         autocomplete?: boolean;
-        /** Allows remote search for options */
-        remoteSearch?: boolean;
-        /** Enables the lazy loading feature for handling a large number of options */
-        lazyLoading?: boolean;
-        /** Rendering style of the dropdown: 'default', 'picker', or 'searchbar' */
-        type?: 'default' | 'picker' | 'searchbar',
-        /** Defines the dropdown's width */
+        /** Rendering style of the dropdown: 'default', 'picker', 'searchbar' or inline. auto will render picker or searchbar based on screensize */
+        type?: 'default' | 'auto' | 'picker' | 'searchbar' | 'inline',
+        /** Defines the dropdown width */
         width?: number;
-        /** Sets the maximum width of the dropdown */
-        maxWidth?: number;
-        /** Determines if the dropdown is opened when initialized */
-        opened?: boolean;
         /** The initial value of the dropdown */
-        value?: string;
+        value?: string | string[] | number | number[];
         /** Placeholder text for the dropdown */
         placeholder?: string;
-        /** Allows the user to add new options */
-        newOptions?: boolean;
-        /** Internal controller for the dropdown's position */
-        position?: boolean;
+        /** Allow insert new items */
+        insert?: boolean;
+        /** Specifies the URL for fetching the data */
+        url?: string;
+        /** Item is disabled */
+        disabled?: boolean;
+        /** Enables another ways to option insert */
+        prompt?: boolean | string | (() => string);
+        /** Remote search */
+        remote?: boolean;
+        /** Allow empty in single dropdown options. Default: true */
+        allowEmpty?: boolean;
         /** Event handler for value changes */
-        onchange?: (el: HTMLElement, obj: object, oldValue: string, newValue: string) => void;
+        onchange?: (self: object, newValue: string|number) => void;
         /** Event handler for when the dropdown is ready */
-        onload?: (el: HTMLElement, obj: object, data: any, val: any) => void;
+        onload?: (self: object) => void;
         /** Event handler for when the dropdown opens */
-        onopen?: (el: HTMLElement) => void;
+        onopen?: (self: object) => void;
         /** Event handler for when the dropdown closes */
-        onclose?: (el: HTMLElement) => void;
-        /** Event handler for when the dropdown receives focus */
-        onfocus?: (el: HTMLElement) => void;
-        /** Event handler for when the dropdown loses focus */
-        onblur?: (el: HTMLElement) => void;
+        onclose?: (self: object) => void;
+        /**
+         * Event handler for just before a new option is added to the dropdown. This is an async function to handle ajax requests.
+         *     Example:
+         *     self.beforeInsert = async function(s, element) {
+         *         let newId = await getTheNewItemIdFromDatabase(element.text);
+         *         return {
+         *             text: element.text,
+         *             value: newId,
+         *         };
+         *     }
+         *
+         * */
+        onbeforeinsert?: (self: object, item: DropdownItem) => boolean | void;
         /** Event handler for when a new option is added to the dropdown */
-        oninsert?: (obj: object, item: DropdownItem, newItem: DropdownItem) => void;
-        /** Event handler for just before a new option is added to the dropdown */
-        onbeforeinsert?: (obj: object, item: DropdownItem) => DropdownItem | false | undefined;
-        /** Event handler for before a search on autocomplete is performed */
-        onbeforesearch?: (obj: object, ajaxRequest: object) => object | false | undefined;
+        oninsert?: (self: object, item: DropdownItem) => void;
+        /** Before the search happens */
+        onbeforesearch?: (self: object, query: string, result: object[]) => boolean | null;
         /** Event handler for processing search results */
-        onsearch?: (obj: object, result: object) => void;
-        /** Toggles the sorting of dropdown elements */
-        sortResults?: boolean;
-        /** Indicates if the dropdown should automatically receive focus upon creation */
-        autofocus?: boolean;
+        onsearch?: (self: object, query: string, result: object[]) => void;
     }
 
     interface DropdownItem {
         /** Value of the selected item. */
         value?: string | number;
-        /** Label for the selected item. */
-        text?: string;
         /** Description of the item */
-        title?: string;
+        text?: string;
         /** Icon of the item */
         image?: string;
         /** Name of the group where the item belongs to */
         group?: string;
         /** Keywords to help finding one item */
-        synonym?: string[];
+        synonym?: string | string[];
         /** Item is disabled */
         disabled?: boolean;
         /** Color for the item */
         color?: string;
-        /** Deprecated */
-        id?: string | number;
-        /** Deprecated */
-        name?: string;
+        // Keywords
+        keywords?: string | string[];
     }
 
     interface ContextmenuItem {