fomantic-ui 2.9.3-beta.45 → 2.9.3-beta.47

package/types/fomantic-ui-search.d.ts

@@ -107,483 +107,389 @@ declare namespace FomanticUI {
          */
         (behavior: 'destroy'): JQuery;
 
-        <K extends keyof SearchSettings>(behavior: 'setting', name: K, value?: undefined): SearchSettings._Impl[K];
-        <K extends keyof SearchSettings>(behavior: 'setting', name: K, value: SearchSettings._Impl[K]): JQuery;
-        (behavior: 'setting', value: SearchSettings): JQuery;
-        (settings?: SearchSettings): JQuery;
+        <K extends keyof SearchSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<SearchSettings, keyof SearchSettings>>;
+        <K extends keyof SearchSettings>(behavior: 'setting', name: K, value: SearchSettings[K]): JQuery;
+        (behavior: 'setting', value: Partial<Pick<SearchSettings, keyof SearchSettings>>): JQuery;
+        (settings?: Partial<Pick<SearchSettings, keyof SearchSettings>>): JQuery;
     }
 
     /**
      * @see {@link https://fomantic-ui.com/modules/search.html#/settings}
      */
-    type SearchSettings = SearchSettings.Param;
-
-    namespace SearchSettings {
-        type Param = (
-            | Pick<_Impl, 'apiSettings'>
-            | Pick<_Impl, 'minCharacters'>
-            | Pick<_Impl, 'searchOnFocus'>
-            | Pick<_Impl, 'transition'>
-            | Pick<_Impl, 'duration'>
-            | Pick<_Impl, 'maxResults'>
-            | Pick<_Impl, 'cache'>
-            | Pick<_Impl, 'source'>
-            | Pick<_Impl, 'selectFirstResult'>
-            | Pick<_Impl, 'showNoResults'>
-            | Pick<_Impl, 'fullTextSearch'>
-            | Pick<_Impl, 'fields'>
-            | Pick<_Impl, 'searchFields'>
-            | Pick<_Impl, 'hideDelay'>
-            | Pick<_Impl, 'searchDelay'>
-            | Pick<_Impl, 'easing'>
-            | Pick<_Impl, 'ignoreDiacritics'>
-            | Pick<_Impl, 'onSelect'>
-            | Pick<_Impl, 'onResultsAdd'>
-            | Pick<_Impl, 'onSearchQuery'>
-            | Pick<_Impl, 'onResults'>
-            | Pick<_Impl, 'onResultsOpen'>
-            | Pick<_Impl, 'onResultsClose'>
-            | Pick<_Impl, 'templates'>
-            | Pick<_Impl, 'selector'>
-            | Pick<_Impl, 'regExp'>
-            | Pick<_Impl, 'className'>
-            | Pick<_Impl, 'metadata'>
-            | Pick<_Impl, 'name'>
-            | Pick<_Impl, 'namespace'>
-            | Pick<_Impl, 'silent'>
-            | Pick<_Impl, 'debug'>
-            | Pick<_Impl, 'performance'>
-            | Pick<_Impl, 'verbose'>
-            | Pick<_Impl, 'error'>
-        ) &
-            Partial<Pick<_Impl, keyof _Impl>>;
-
-        interface _Impl {
-            // region Search Settings
-
-            /**
-             * Settings for API call.
-             * @see {@link https://fomantic-ui.com/behaviors/api.html#/settings}
-             * @default {}
-             */
-            apiSettings: APISettings;
-
-            /**
-             * Minimum characters to query for results.
-             * @default 1
-             */
-            minCharacters: number;
-
-            /**
-             * Whether search should show results on focus (must also match min character length).
-             * @default true
-             */
-            searchOnFocus: boolean;
-
-            /**
-             * Named transition to use when animating menu in and out.
-             * Fade and slide down are available without including ui transitions.
-             * @see {@link https://fomantic-ui.com/modules/transition.html}
-             * @default 'fade'
-             */
-            transition: string;
-
-            /**
-             * Duration of animation events.
-             * @default 300
-             */
-            duration: number;
-
-            /**
-             * Maximum results to display when using local and simple search, maximum category count for category search.
-             * @default 7
-             */
-            maxResults: number;
-
-            /**
-             * Caches results locally to avoid requerying server.
-             * @default true
-             */
-            cache: boolean;
-
-            /**
-             * Specify a Javascript object which will be searched locally.
-             * @default false
-             */
-            source: boolean | object;
-
-            /**
-             * Whether the search should automatically select the first search result after searching.
-             * @default false
-             */
-            selectFirstResult: boolean;
-
-            /**
-             * Whether a "no results" message should be shown if no results are found.
-             * @default false
-             */
-            showNoResults: boolean;
-
-            /**
-             * Specifying to "true" will use a fuzzy full text search, setting to "exact" will force the exact search to be matched somewhere in the string, setting to false will only match to start of string.
-             * @default 'exact'
-             */
-            fullTextSearch: 'exact' | boolean;
-
-            /**
-             * List mapping display content to JSON property, either with API or 'source'.
-             * @default {}
-             */
-            fields: object;
-
-            /**
-             * Specify object properties inside local source object which will be searched.
-             * @default ['title', 'description']
-             */
-            searchFields: string[];
-
-            /**
-             * Delay before hiding results after search blur.
-             * @default 0
-             */
-            hideDelay: number;
-
-            /**
-             * Delay before querying results on inputchange.
-             * @default 100
-             */
-            searchDelay: number;
-
-            /**
-             * Easing equation when using fallback Javascript animation.
-             * EaseOutExpo is included with search, for additional options you must include `easing equations`.
-             * @see {@link https://gsgd.co.uk/sandbox/jquery/easing/}
-             * @default 'easeOutExpo'
-             */
-            easing: string;
-
-            /**
-             * When activated, searches will also match results for base diacritic letters.
-             * For example when searching for 'a', it will also match 'á' or 'â' or 'å' and so on...
-             * It will also ignore diacritics for the searchterm, so if searching for 'ó', it will match 'ó', but also 'o', 'ô' or 'õ' and so on...
-             * @default false
-             */
-            ignoreDiacritics: boolean;
-
-            // endregion
-
-            // region Callbacks
-
-            /**
-             * Callback on element selection by user.
-             * The first parameter includes the filtered response results for that element.
-             * The function should return 'false' to prevent default action (closing search results and selecting value).
-             */
-            onSelect(this: JQuery, result: object, response: object): boolean;
-
-            /**
-             * Callback after processing element template to add HTML to results.
-             * Function should return 'false' to prevent default actions.
-             */
-            onResultsAdd(this: JQuery, html: string): boolean;
-
-            /**
-             * Callback on search query.
-             */
-            onSearchQuery(this: JQuery, query: string): void;
-
-            /**
-             * Callback on server response.
-             */
-            onResults(this: JQuery, response: object): void;
-
-            /**
-             * Callback when results are opened.
-             */
-            onResultsOpen(this: JQuery): void;
-
-            /**
-             * Callback when results are closed.
-             */
-            onResultsClose(this: JQuery): void;
-
-            // endregion
-
-            // region Template Settings
-
-            templates: Search.TemplateSettings;
-
-            // endregion
-
-            // region DOM Settings
-
-            /**
-             * DOM Selectors used internally.
-             * Selectors used to find parts of a module.
-             */
-            selector: Search.SelectorSettings;
-
-            /**
-             * Regular expressions used for matching.
-             */
-            regExp: Search.RegExpSettings;
-
-            /**
-             * Class names used to determine element state.
-             */
-            className: Search.ClassNameSettings;
-
-            /**
-             * HTML5 metadata attributes used internally.
-             */
-            metadata: Search.MetadataSettings;
-
-            // endregion
-
-            // region Debug Settings
-
-            /**
-             * Name used in log statements
-             */
-            name: string;
-
-            /**
-             * Event namespace. Makes sure module teardown does not effect other events attached to an element.
-             */
-            namespace: string;
-
-            /**
-             * Silences all console output including error messages, regardless of other debug settings.
-             */
-            silent: boolean;
-
-            /**
-             * Debug output to console
-             */
-            debug: boolean;
+    interface SearchSettings {
+        // region Search Settings
 
-            /**
-             * Show console.table output with performance metrics
-             */
-            performance: boolean;
+        /**
+         * Settings for API call.
+         * @see {@link https://fomantic-ui.com/behaviors/api.html#/settings}
+         * @default {}
+         */
+        apiSettings: APISettings;
 
-            /**
-             * Debug output includes all internal behaviors
-             */
-            verbose: boolean;
+        /**
+         * Minimum characters to query for results.
+         * @default 1
+         */
+        minCharacters: number;
 
-            error: Search.ErrorSettings;
+        /**
+         * Whether search should show results on focus (must also match min character length).
+         * @default true
+         */
+        searchOnFocus: boolean;
 
-            // endregion
-        }
+        /**
+         * Named transition to use when animating menu in and out.
+         * Fade and slide down are available without including ui transitions.
+         * @see {@link https://fomantic-ui.com/modules/transition.html}
+         * @default 'fade'
+         */
+        transition: string;
 
-        namespace Search {
-            type TemplateSettings = TemplateSettings.Param;
-
-            namespace TemplateSettings {
-                type Param = (
-                    | Pick<_Impl, 'escape'>
-                    | Pick<_Impl, 'message'>
-                    | Pick<_Impl, 'category'>
-                    | Pick<_Impl, 'standard'>
-                ) &
-                    Partial<Pick<_Impl, keyof _Impl>>;
-
-                interface _Impl {
-                    /**
-                     * @default function(string)
-                     */
-                    escape: Function;
-
-                    /**
-                     * @default function(message, type)
-                     */
-                    message: Function;
-
-                    /**
-                     * @default function(response)
-                     */
-                    category: Function;
-
-                    /**
-                     * @default function(response)
-                     */
-                    standard: Function;
-                }
-            }
+        /**
+         * Duration of animation events.
+         * @default 300
+         */
+        duration: number;
 
-            type SelectorSettings = SelectorSettings.Param;
-
-            namespace SelectorSettings {
-                type Param = (
-                    | Pick<_Impl, 'prompt'>
-                    | Pick<_Impl, 'searchButton'>
-                    | Pick<_Impl, 'results'>
-                    | Pick<_Impl, 'category'>
-                    | Pick<_Impl, 'result'>
-                ) &
-                    Partial<Pick<_Impl, keyof _Impl>>;
-
-                interface _Impl {
-                    /**
-                     * @default '.prompt'
-                     */
-                    prompt: string;
-
-                    /**
-                     * @default '.search.button'
-                     */
-                    searchButton: string;
-
-                    /**
-                     * @default '.results'
-                     */
-                    results: string;
-
-                    /**
-                     * @default '.category'
-                     */
-                    category: string;
-
-                    /**
-                     * @default '.result'
-                     */
-                    result: string;
-                }
-            }
+        /**
+         * Maximum results to display when using local and simple search, maximum category count for category search.
+         * @default 7
+         */
+        maxResults: number;
+
+        /**
+         * Caches results locally to avoid requerying server.
+         * @default true
+         */
+        cache: boolean;
+
+        /**
+         * Specify a Javascript object which will be searched locally.
+         * @default false
+         */
+        source: boolean | object;
+
+        /**
+         * Whether the search should automatically select the first search result after searching.
+         * @default false
+         */
+        selectFirstResult: boolean;
+
+        /**
+         * Whether a "no results" message should be shown if no results are found.
+         * @default false
+         */
+        showNoResults: boolean;
+
+        /**
+         * Specifying to "true" will use a fuzzy full text search, setting to "exact" will force the exact search to be matched somewhere in the string, setting to false will only match to start of string.
+         * @default 'exact'
+         */
+        fullTextSearch: 'exact' | boolean;
+
+        /**
+         * List mapping display content to JSON property, either with API or 'source'.
+         * @default {}
+         */
+        fields: object;
+
+        /**
+         * Specify object properties inside local source object which will be searched.
+         * @default ['title', 'description']
+         */
+        searchFields: string[];
+
+        /**
+         * Delay before hiding results after search blur.
+         * @default 0
+         */
+        hideDelay: number;
+
+        /**
+         * Delay before querying results on inputchange.
+         * @default 100
+         */
+        searchDelay: number;
+
+        /**
+         * Easing equation when using fallback Javascript animation.
+         * EaseOutExpo is included with search, for additional options you must include `easing equations`.
+         * @see {@link https://gsgd.co.uk/sandbox/jquery/easing/}
+         * @default 'easeOutExpo'
+         */
+        easing: string;
+
+        /**
+         * When activated, searches will also match results for base diacritic letters.
+         * For example when searching for 'a', it will also match 'á' or 'â' or 'å' and so on...
+         * It will also ignore diacritics for the searchterm, so if searching for 'ó', it will match 'ó', but also 'o', 'ô' or 'õ' and so on...
+         * @default false
+         */
+        ignoreDiacritics: boolean;
+
+        // endregion
+
+        // region Callbacks
+
+        /**
+         * Callback on element selection by user.
+         * The first parameter includes the filtered response results for that element.
+         * The function should return 'false' to prevent default action (closing search results and selecting value).
+         */
+        onSelect(this: JQuery, result: object, response: object): boolean;
+
+        /**
+         * Callback after processing element template to add HTML to results.
+         * Function should return 'false' to prevent default actions.
+         */
+        onResultsAdd(this: JQuery, html: string): boolean;
+
+        /**
+         * Callback on search query.
+         */
+        onSearchQuery(this: JQuery, query: string): void;
+
+        /**
+         * Callback on server response.
+         */
+        onResults(this: JQuery, response: object): void;
+
+        /**
+         * Callback when results are opened.
+         */
+        onResultsOpen(this: JQuery): void;
+
+        /**
+         * Callback when results are closed.
+         */
+        onResultsClose(this: JQuery): void;
+
+        // endregion
+
+        // region Template Settings
+
+        templates: Search.TemplateSettings;
+
+        // endregion
+
+        // region DOM Settings
+
+        /**
+         * DOM Selectors used internally.
+         * Selectors used to find parts of a module.
+         */
+        selector: Search.SelectorSettings;
+
+        /**
+         * Regular expressions used for matching.
+         */
+        regExp: Search.RegExpSettings;
+
+        /**
+         * Class names used to determine element state.
+         */
+        className: Search.ClassNameSettings;
+
+        /**
+         * HTML5 metadata attributes used internally.
+         */
+        metadata: Search.MetadataSettings;
 
-            type RegExpSettings = RegExpSettings.Param;
+        // endregion
+
+        // region Debug Settings
+
+        /**
+         * Name used in log statements
+         * @default 'Search'
+         */
+        name: string;
 
-            namespace RegExpSettings {
-                type Param = (Pick<_Impl, 'escape'> | Pick<_Impl, 'beginsWith'>) & Partial<Pick<_Impl, keyof _Impl>>;
+        /**
+         * Event namespace. Makes sure module teardown does not effect other events attached to an element.
+         * @default 'search'
+         */
+        namespace: string;
 
-                interface _Impl {
-                    /**
-                     * @default /[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g
-                     */
-                    escape: RegExp;
+        /**
+         * Silences all console output including error messages, regardless of other debug settings.
+         * @default false
+         */
+        silent: boolean;
 
-                    /**
-                     * @default '(?:\s|^)'
-                     */
-                    beginsWith: RegExp;
-                }
+        /**
+         * Debug output to console
+         * @default false
+         */
+        debug: boolean;
+
+        /**
+         * Show console.table output with performance metrics
+         * @default true
+         */
+        performance: boolean;
+
+        /**
+         * Debug output includes all internal behaviors
+         * @default false
+         */
+        verbose: boolean;
+
+        error: Search.ErrorSettings;
+
+        // endregion
+    }
+
+    namespace Search {
+        type TemplateSettings = Partial<Pick<Settings.Templates, keyof Settings.Templates>>;
+        type SelectorSettings = Partial<Pick<Settings.Selectors, keyof Settings.Selectors>>;
+        type RegExpSettings = Partial<Pick<Settings.RegExps, keyof Settings.RegExps>>;
+        type ClassNameSettings = Partial<Pick<Settings.ClassNames, keyof Settings.ClassNames>>;
+        type MetadataSettings = Partial<Pick<Settings.Metadatas, keyof Settings.Metadatas>>;
+        type ErrorSettings = Partial<Pick<Settings.Errors, keyof Settings.Errors>>;
+
+        namespace Settings {
+            interface Templates {
+                /**
+                 * @default function(string)
+                 */
+                escape: Function;
+
+                /**
+                 * @default function(message, type)
+                 */
+                message: Function;
+
+                /**
+                 * @default function(response)
+                 */
+                category: Function;
+
+                /**
+                 * @default function(response)
+                 */
+                standard: Function;
             }
 
-            type ClassNameSettings = ClassNameSettings.Param;
-
-            namespace ClassNameSettings {
-                type Param = (
-                    | Pick<_Impl, 'active'>
-                    | Pick<_Impl, 'empty'>
-                    | Pick<_Impl, 'focus'>
-                    | Pick<_Impl, 'loading'>
-                    | Pick<_Impl, 'pressed'>
-                ) &
-                    Partial<Pick<_Impl, keyof _Impl>>;
-
-                interface _Impl {
-                    /**
-                     * @default 'active'
-                     */
-                    active: string;
-
-                    /**
-                     * @default 'empty'
-                     */
-                    empty: string;
-
-                    /**
-                     * @default 'focus'
-                     */
-                    focus: string;
-
-                    /**
-                     * @default 'loading'
-                     */
-                    loading: string;
-
-                    /**
-                     * @default 'down'
-                     */
-                    pressed: string;
-                }
+            interface Selectors {
+                /**
+                 * @default '.prompt'
+                 */
+                prompt: string;
+
+                /**
+                 * @default '.search.button'
+                 */
+                searchButton: string;
+
+                /**
+                 * @default '.results'
+                 */
+                results: string;
+
+                /**
+                 * @default '.category'
+                 */
+                category: string;
+
+                /**
+                 * @default '.result'
+                 */
+                result: string;
             }
 
-            type MetadataSettings = MetadataSettings.Param;
+            interface RegExps {
+                /**
+                 * @default /[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g
+                 */
+                escape: RegExp;
 
-            namespace MetadataSettings {
-                type Param = (Pick<_Impl, 'cache'> | Pick<_Impl, 'results'>) & Partial<Pick<_Impl, keyof _Impl>>;
+                /**
+                 * @default '(?:\s|^)'
+                 */
+                beginsWith: RegExp;
+            }
+
+            interface ClassNames {
+                /**
+                 * @default 'active'
+                 */
+                active: string;
+
+                /**
+                 * @default 'empty'
+                 */
+                empty: string;
+
+                /**
+                 * @default 'focus'
+                 */
+                focus: string;
+
+                /**
+                 * @default 'loading'
+                 */
+                loading: string;
+
+                /**
+                 * @default 'down'
+                 */
+                pressed: string;
+            }
 
-                interface _Impl {
-                    /**
-                     * @default 'cache'
-                     */
-                    cache: string;
+            interface Metadatas {
+                /**
+                 * @default 'cache'
+                 */
+                cache: string;
 
-                    /**
-                     * @default 'results'
-                     */
-                    results: string;
-                }
+                /**
+                 * @default 'results'
+                 */
+                results: string;
             }
 
-            type ErrorSettings = ErrorSettings.Param;
-
-            namespace ErrorSettings {
-                type Param = (
-                    | Pick<_Impl, 'source'>
-                    | Pick<_Impl, 'noResultsHeader'>
-                    | Pick<_Impl, 'noResults'>
-                    | Pick<_Impl, 'logging'>
-                    | Pick<_Impl, 'noTemplate'>
-                    | Pick<_Impl, 'serverError'>
-                    | Pick<_Impl, 'maxResults'>
-                    | Pick<_Impl, 'method'>
-                ) &
-                    Partial<Pick<_Impl, keyof _Impl>>;
-
-                interface _Impl {
-                    /**
-                     * @default 'Cannot search. No source used, and Fomantic API module was not included'
-                     */
-                    source: string;
-
-                    /**
-                     * @default 'No Results'
-                     */
-                    noResultsHeader: string;
-
-                    /**
-                     * @default 'Your search returned no results'
-                     */
-                    noResults: string;
-
-                    /**
-                     * @default 'Error in debug logging, exiting.'
-                     */
-                    logging: string;
-
-                    /**
-                     * @default 'A valid template name was not specified.'
-                     */
-                    noTemplate: string;
-
-                    /**
-                     * @default 'There was an issue with querying the server.'
-                     */
-                    serverError: string;
-
-                    /**
-                     * @default 'Results must be an array to use maxResults setting'
-                     */
-                    maxResults: string;
-
-                    /**
-                     * @default 'The method you called is not defined.'
-                     */
-                    method: string;
-                }
+            interface Errors {
+                /**
+                 * @default 'Cannot search. No source used, and Fomantic API module was not included'
+                 */
+                source: string;
+
+                /**
+                 * @default 'No Results'
+                 */
+                noResultsHeader: string;
+
+                /**
+                 * @default 'Your search returned no results'
+                 */
+                noResults: string;
+
+                /**
+                 * @default 'Error in debug logging, exiting.'
+                 */
+                logging: string;
+
+                /**
+                 * @default 'A valid template name was not specified.'
+                 */
+                noTemplate: string;
+
+                /**
+                 * @default 'There was an issue with querying the server.'
+                 */
+                serverError: string;
+
+                /**
+                 * @default 'Results must be an array to use maxResults setting'
+                 */
+                maxResults: string;
+
+                /**
+                 * @default 'The method you called is not defined.'
+                 */
+                method: string;
             }
         }
     }