fomantic-ui 2.9.4-beta.8 → 2.9.4-beta.80

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

@@ -67,7 +67,7 @@ declare namespace FomanticUI {
          */
         (behavior: 'destroy'): JQuery;
 
-        <K extends keyof PopupSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<PopupSettings, keyof PopupSettings>>;
+        <K extends keyof PopupSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<PopupSettings, keyof PopupSettings>>;
         <K extends keyof PopupSettings>(behavior: 'setting', name: K, value: PopupSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<PopupSettings, keyof PopupSettings>>): JQuery;
         (settings?: Partial<Pick<PopupSettings, keyof PopupSettings>>): JQuery;
@@ -84,7 +84,7 @@ declare namespace FomanticUI {
          * This is useful for including a pre-formatted popup.
          * @default false
          */
-        popup: false | string;
+        popup: false | string | JQuery;
 
         /**
          * Whether all other popups should be hidden when this popup is opened.
@@ -189,7 +189,7 @@ declare namespace FomanticUI {
          * Alternatively you can provide an object to set individual values for hide/show transitions as well as hide/show duration.
          * @default 'scale'
          */
-        transition: string | object;
+        transition: string | Popup.TransitionSettings;
 
         /**
          * Duration of animation events.
@@ -266,39 +266,39 @@ declare namespace FomanticUI {
         /**
          * Callback on popup element creation, with created popup.
          */
-        onCreate(this: JQuery): void;
+        onCreate(this: JQuery, element?: JQuery<HTMLElement>): void;
 
         /**
          * Callback immediately before Popup is removed from DOM.
          */
-        onRemove(this: JQuery): void;
+        onRemove(this: JQuery, element?: JQuery<HTMLElement>): void;
 
         /**
          * Callback before popup is shown.
          * Returning 'false' from this callback will cancel the popup from showing.
          */
-        onShow(this: JQuery): boolean;
+        onShow(this: JQuery, element?: JQuery<HTMLElement>): any;
 
         /**
          * Callback after popup is shown.
          */
-        onVisible(this: JQuery): void;
+        onVisible(this: JQuery, element?: JQuery<HTMLElement>): void;
 
         /**
          * Callback before popup is hidden.
          * Returning 'false' from this callback will cancel the popup from hiding.
          */
-        onHide(this: JQuery): boolean;
+        onHide(this: JQuery, element?: JQuery<HTMLElement>): any;
 
         /**
          * Callback after popup is hidden.
          */
-        onHidden(this: JQuery): void;
+        onHidden(this: JQuery, element?: JQuery<HTMLElement>): void;
 
         /**
          * Callback after popup cannot be placed on screen.
          */
-        onUnplaceable(this: JQuery): void;
+        onUnplaceable(this: JQuery, element?: JQuery<HTMLElement>): void;
 
         // endregion
 
@@ -390,19 +390,45 @@ declare namespace FomanticUI {
     }
 
     namespace Popup {
+        type TransitionSettings = Partial<Pick<Settings.Transition, keyof Settings.Transition>>;
         type SelectorSettings = Partial<Pick<Settings.Selectors, keyof Settings.Selectors>>;
         type MetadataSettings = Partial<Pick<Settings.Metadatas, keyof Settings.Metadatas>>;
         type ClassNameSettings = Partial<Pick<Settings.ClassNames, keyof Settings.ClassNames>>;
         type ErrorSettings = Partial<Pick<Settings.Errors, keyof Settings.Errors>>;
 
         namespace Settings {
+            interface Transition {
+
+                /**
+                 * Named animation show event to used.
+                 * Must be defined in CSS.
+                 */
+                showMethod: string;
+
+                /**
+                 * Duration of the CSS show transition animation
+                 */
+                showDuration: number;
+
+                /**
+                 * Named animation hide event to used.
+                 * Must be defined in CSS.
+                 */
+                hideMethod: string;
+
+                /**
+                 * Duration of the CSS hide transition animation
+                 */
+                hideDuration: number;
+            }
+
             interface Selectors {
                 /**
                  * @default '.ui.popup'
                  */
                 popup: string;
             }
-        
+
             interface Metadatas {
                 /**
                  * @default 'activator'
@@ -439,7 +465,7 @@ declare namespace FomanticUI {
                  */
                 variation: string;
             }
-        
+
             interface ClassNames {
                 /**
                  * @default 'active'

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

@@ -158,7 +158,7 @@ declare namespace FomanticUI {
          */
         (behavior: 'destroy'): JQuery;
 
-        <K extends keyof ProgressSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<ProgressSettings, keyof ProgressSettings>>;
+        <K extends keyof ProgressSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<ProgressSettings, keyof ProgressSettings>>;
         <K extends keyof ProgressSettings>(behavior: 'setting', name: K, value: ProgressSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<ProgressSettings, keyof ProgressSettings>>): JQuery;
         (settings?: Partial<Pick<ProgressSettings, keyof ProgressSettings>>): JQuery;
@@ -208,6 +208,12 @@ declare namespace FomanticUI {
          */
         precision: number;
 
+        /**
+         * Sets current overall percent.
+         * @default false
+         */
+        percent: false | number;
+
         /**
          * Setting a total value will make each call to increment get closer to this total (i.e. 1/20, 2/20 etc).
          * @default false
@@ -349,7 +355,7 @@ declare namespace FomanticUI {
                  */
                 progress: string;
             }
-        
+
             interface ClassNames {
                 /**
                  * @default 'active'
@@ -371,7 +377,7 @@ declare namespace FomanticUI {
                  */
                 warning: string;
             }
-        
+
             interface Texts {
                 /**
                  * @default false
@@ -408,14 +414,14 @@ declare namespace FomanticUI {
                  */
                 bars: string[];
             }
-        
+
             interface RegExps {
                 /**
                  * @default /\{\$*[A-z0-9]+\}/g
                  */
                 variable: RegExp;
             }
-        
+
             interface Metadatas {
                 /**
                  * @default 'percent'
@@ -432,7 +438,7 @@ declare namespace FomanticUI {
                  */
                 value: string;
             }
-        
+
             interface Errors {
                 /**
                  * @default 'The method you called is not defined.'

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

@@ -28,7 +28,7 @@ declare namespace FomanticUI {
         (behavior: 'clear rating'): JQuery;
 
         (behavior: 'destroy'): JQuery;
-        <K extends keyof RatingSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<RatingSettings, keyof RatingSettings>>;
+        <K extends keyof RatingSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<RatingSettings, keyof RatingSettings>>;
         <K extends keyof RatingSettings>(behavior: 'setting', name: K, value: RatingSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<RatingSettings, keyof RatingSettings>>): JQuery;
         (settings?: Partial<Pick<RatingSettings, keyof RatingSettings>>): JQuery;

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

@@ -5,12 +5,12 @@ declare namespace FomanticUI {
         /**
          * Search for value currently set in search input.
          */
-        (behavior: 'query', callback: Function): JQuery;
+        (behavior: 'query', callback?: () => void): JQuery;
 
         /**
          * Displays message in search results with text, using template matching type.
          */
-        (behavior: 'display message', text: string, type: string): JQuery;
+        (behavior: 'display message', text: string, type?: string): JQuery;
 
         /**
          * Cancels current remote search query.
@@ -30,7 +30,7 @@ declare namespace FomanticUI {
         /**
          * Search remote endpoint for specified query and display results.
          */
-        (behavior: 'search remote', query: string, callback: Function): JQuery;
+        (behavior: 'search remote', query: string, callback?: () => void): JQuery;
 
         /**
          * Search object for specified query and return results.
@@ -75,7 +75,7 @@ declare namespace FomanticUI {
         /**
          * Clears value from cache, if no parameter passed clears all cache.
          */
-        (behavior: 'clear cache', query: string): JQuery;
+        (behavior: 'clear cache', query?: string): JQuery;
 
         /**
          * Writes cached results for query.
@@ -90,24 +90,24 @@ declare namespace FomanticUI {
         /**
          * Shows results container.
          */
-        (behavior: 'show results', callback: Function): JQuery;
+        (behavior: 'show results', callback?: () => void): JQuery;
 
         /**
          * Hide results container.
          */
-        (behavior: 'hide results', callback: Function): JQuery;
+        (behavior: 'hide results', callback?: () => void): JQuery;
 
         /**
          * Generates results using parser specified by 'settings.template'.
          */
-        (behavior: 'generate results', response: Function): JQuery;
+        (behavior: 'generate results', response: object): JQuery;
 
         /**
          * Removes all events.
          */
         (behavior: 'destroy'): 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?: 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;
@@ -124,7 +124,7 @@ declare namespace FomanticUI {
          * @see {@link https://fomantic-ui.com/behaviors/api.html#/settings}
          * @default {}
          */
-        apiSettings: APISettings | JQueryAjaxSettings;
+        apiSettings: Partial<Pick<APISettings, keyof APISettings>> | JQueryAjaxSettings;
 
         /**
          * Minimum characters to query for results.
@@ -183,16 +183,21 @@ declare namespace FomanticUI {
         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.
+         * Possible values
+         * * `exact` will force the exact search to be matched somewhere in the string.
+         * * `some` Will do the same as exact but supports multiple search values separated by whitespace. At least one word must match. (New in v2.9.1)
+         * * `all` is same as some but all words have to match in all given search fields of each record altogether. (New in v2.9.1)
+         * * `true` will use a fuzzy full text search.
+         * * `false` will only match to start of string.
          * @default 'exact'
          */
-        fullTextSearch: 'exact' | boolean;
+        fullTextSearch: 'exact' | 'some' | 'all' | boolean;
 
         /**
          * List mapping display content to JSON property, either with API or 'source'.
          * @default {}
          */
-        fields: object;
+        fields: Search.FieldsSettings;
 
         /**
          * Specify object properties inside local source object which will be searched.
@@ -228,6 +233,36 @@ declare namespace FomanticUI {
          */
         ignoreDiacritics: boolean;
 
+        /**
+         * Whether to consider case sensitivity on local searching
+         * @default true
+         */
+        ignoreSearchCase: boolean;
+
+        /**
+         * Whether search result should highlight matching strings
+         * @default false
+         */
+        highlightMatches: boolean;
+
+        /**
+         * Template to use (specified in settings.templates)
+         * @default 'standard'
+         */
+        type: 'escape' | 'message' | 'category' | 'standard';
+
+        /**
+         * Field to display in standard results template
+         * @default ''
+         */
+        displayField: string;
+
+        /**
+         * Whether to add events to prompt automatically
+         * @default true
+         */
+        automatic: boolean;
+
         // endregion
 
         // region Callbacks
@@ -237,13 +272,13 @@ declare namespace FomanticUI {
          * 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;
+        onSelect(this: JQuery, result: object, response: object): any;
 
         /**
          * Callback after processing element template to add HTML to results.
          * Function should return 'false' to prevent default actions.
          */
-        onResultsAdd(this: JQuery, html: string): boolean;
+        onResultsAdd(this: JQuery, html: string): void | boolean;
 
         /**
          * Callback on search query.
@@ -347,29 +382,30 @@ declare namespace FomanticUI {
         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 FieldsSettings = Partial<Pick<Settings.Fields, keyof Settings.Fields>>;
         type ErrorSettings = Partial<Pick<Settings.Errors, keyof Settings.Errors>>;
 
         namespace Settings {
             interface Templates {
                 /**
-                 * @default function(string)
+                 * @default function(string, preserveHTML)
                  */
-                escape: Function;
+                escape: (string: string, preserveHTML?: boolean) => string;
 
                 /**
-                 * @default function(message, type)
+                 * @default function(message, type, header)
                  */
-                message: Function;
+                message: (message: string, type?: string, header?: string) => string;
 
                 /**
-                 * @default function(response)
+                 * @default function(response, fields, preserveHTML)
                  */
-                category: Function;
+                category: (response: unknown, fields: {[key: string]: string}, preserveHTML?: boolean) => string;
 
                 /**
-                 * @default function(response)
+                 * @default function(response, fields, preserveHTML)
                  */
-                standard: Function;
+                standard: (response: unknown, fields: {[key: string]: string}, preserveHTML?: boolean) => string;
             }
 
             interface Selectors {
@@ -450,6 +486,86 @@ declare namespace FomanticUI {
                 results: string;
             }
 
+            interface Fields {
+                /**
+                 * Array of categories (category view)
+                 * @default 'results'
+                 */
+                categories: string;
+
+                /**
+                 * Name of category (category view)
+                 * @default 'name'
+                 */
+                categoryName: string;
+
+                /**
+                 * Array of results (category view)
+                 * @default 'results'
+                 */
+                categoryResults: string;
+
+                /**
+                 * Sesult description
+                 * @default ' description'
+                 */
+                description: string;
+
+                /**
+                 * Result image
+                 * @default 'image'
+                 */
+                image: string;
+
+                /**
+                 * Result alt text for image
+                 * @default 'alt'
+                 */
+                alt: string;
+
+                /**
+                 * Result price
+                 * @default 'price'
+                 */
+                price: string;
+
+                /**
+                 * Array of results (standard)
+                 * @default 'results'
+                 */
+                results: string;
+
+                /**
+                 * Result title
+                 * @default 'title'
+                 */
+                title: string;
+
+                /**
+                 * Result url
+                 * @default 'url'
+                 */
+                url: string;
+
+                /**
+                 * "view more" object name
+                 * @default 'action'
+                 */
+                action: string;
+
+                /**
+                 * "view more" text
+                 * @default 'text'
+                 */
+                actionText: string;
+
+                /**
+                 * "view more" url
+                 * @default 'url'
+                 */
+                actionURL: string;
+            }
+
             interface Errors {
                 /**
                  * @default 'Cannot search. No source used, and Fomantic API module was not included'

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

@@ -102,7 +102,7 @@ declare namespace FomanticUI {
          */
         (behavior: 'destroy'): JQuery;
 
-        <K extends keyof ShapeSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<ShapeSettings, keyof ShapeSettings>>;
+        <K extends keyof ShapeSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<ShapeSettings, keyof ShapeSettings>>;
         <K extends keyof ShapeSettings>(behavior: 'setting', name: K, value: ShapeSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<ShapeSettings, keyof ShapeSettings>>): JQuery;
         (settings?: Partial<Pick<ShapeSettings, keyof ShapeSettings>>): JQuery;
@@ -257,7 +257,7 @@ declare namespace FomanticUI {
                  */
                 active: string;
             }
-        
+
             interface Errors {
                 /**
                  * @default 'You tried to switch to a side that does not exist.'

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

@@ -68,7 +68,7 @@ declare namespace FomanticUI {
          */
         (behavior: 'destroy'): JQuery;
 
-        <K extends keyof SidebarSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<SidebarSettings, keyof SidebarSettings>>;
+        <K extends keyof SidebarSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<SidebarSettings, keyof SidebarSettings>>;
         <K extends keyof SidebarSettings>(behavior: 'setting', name: K, value: SidebarSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<SidebarSettings, keyof SidebarSettings>>): JQuery;
         (settings?: Partial<Pick<SidebarSettings, keyof SidebarSettings>>): JQuery;
@@ -281,7 +281,7 @@ declare namespace FomanticUI {
                  */
                 sidebar: string;
             }
-        
+
             interface RegExps {
                 /**
                  * @default /(iPad|iPhone|iPod)/g
@@ -298,7 +298,7 @@ declare namespace FomanticUI {
                  */
                 mobile: RegExp;
             }
-        
+
             interface ClassNames {
                 /**
                  * @default 'active'
@@ -370,7 +370,7 @@ declare namespace FomanticUI {
                  */
                 visible: string;
             }
-        
+
             interface Errors {
                 /**
                  * @default 'The method you called is not defined.'

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

@@ -35,7 +35,7 @@ declare namespace FomanticUI {
          */
         (behavior: 'destroy'): JQuery;
 
-        <K extends keyof SliderSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<SliderSettings, keyof SliderSettings>>;
+        <K extends keyof SliderSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<SliderSettings, keyof SliderSettings>>;
         <K extends keyof SliderSettings>(behavior: 'setting', name: K, value: SliderSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<SliderSettings, keyof SliderSettings>>): JQuery;
         (settings?: Partial<Pick<SliderSettings, keyof SliderSettings>>): JQuery;
@@ -89,7 +89,7 @@ declare namespace FomanticUI {
          * You can specify a function here which consumes the current label value as parameter and should return a custom label text according to the given value.
          * @default false
          */
-        interpretLabel: false | Function;
+        interpretLabel: false | ((value: any) => string);
 
         /**
          * Show ticks on a labeled slider.

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

@@ -3,7 +3,7 @@ declare namespace FomanticUI {
         settings: StickySettings;
 
         (behavior: 'destroy'): JQuery;
-        <K extends keyof StickySettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<StickySettings, keyof StickySettings>>;
+        <K extends keyof StickySettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<StickySettings, keyof StickySettings>>;
         <K extends keyof StickySettings>(behavior: 'setting', name: K, value: StickySettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<StickySettings, keyof StickySettings>>): JQuery;
         (settings?: Partial<Pick<StickySettings, keyof StickySettings>>): JQuery;

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

@@ -48,7 +48,7 @@ declare namespace FomanticUI {
          */
         (behavior: 'destroy'): JQuery;
 
-        <K extends keyof TabSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<TabSettings, keyof TabSettings>>;
+        <K extends keyof TabSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<TabSettings, keyof TabSettings>>;
         <K extends keyof TabSettings>(behavior: 'setting', name: K, value: TabSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<TabSettings, keyof TabSettings>>): JQuery;
         (settings?: Partial<Pick<TabSettings, keyof TabSettings>>): JQuery;
@@ -149,7 +149,7 @@ declare namespace FomanticUI {
          * Tabs are limited to those found inside this context.
          * @default false
          */
-        context: false | string;
+        context: JQuery | string | false;
 
         /**
          * If enabled limits tabs to children of passed context.
@@ -276,9 +276,9 @@ declare namespace FomanticUI {
                  * Returns page title
                  * @default Function
                  */
-                determineTitle: Function;
+                determineTitle: (tabPath: string) => string | void;
             }
-        
+
             interface Selectors {
                 /**
                  * @default '.ui.tab'
@@ -290,7 +290,7 @@ declare namespace FomanticUI {
                  */
                 parent: string;
             }
-        
+
             interface Metadatas {
                 /**
                  * @default 'tab'
@@ -319,7 +319,7 @@ declare namespace FomanticUI {
                  */
                 active: string;
             }
-            
+
             interface Errors {
                 /**
                  * @default 'You attempted to load content without API module'

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

@@ -12,6 +12,11 @@ declare namespace FomanticUI {
          */
         (behavior: 'animate continue'): JQuery;
 
+        /**
+         * Show the toast
+         */
+        (behavior: 'show'): JQuery;
+
         /**
          * Closes the toast
          */
@@ -28,7 +33,7 @@ declare namespace FomanticUI {
         (behavior: 'get remainingTime'): number;
 
         (behavior: 'refresh' | 'destroy'): JQuery;
-        <K extends keyof ToastSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<ToastSettings, keyof ToastSettings>>;
+        <K extends keyof ToastSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<ToastSettings, keyof ToastSettings>>;
         <K extends keyof ToastSettings>(behavior: 'setting', name: K, value: ToastSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<ToastSettings, keyof ToastSettings>>): JQuery;
         (settings?: Partial<Pick<ToastSettings, keyof ToastSettings>>): JQuery;
@@ -120,6 +125,13 @@ declare namespace FomanticUI {
          */
         showImage: false | string;
 
+        /**
+         * Alt text for a given showImage.
+         *
+         * @default false
+         */
+        alt: false | string;
+
         /**
          * Define if the toast should display an icon which matches to a given class.
          * If a string is given, this will be used as icon classname.
@@ -273,7 +285,7 @@ declare namespace FomanticUI {
         /**
          * An array of objects. Each object defines an action with 'properties' 'text', 'class', 'icon' and 'click'.
          */
-        actions: Toast.ActionsSettings;
+        actions: Toast.ActionsSettings[];
 
         // endregion