fomantic-ui 2.9.4-beta.6 → 2.9.4-beta.61

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

@@ -10,7 +10,7 @@ declare namespace FomanticUI {
         /**
          * 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.
@@ -107,7 +107,7 @@ declare namespace FomanticUI {
          */
         (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.
@@ -192,7 +192,7 @@ declare namespace FomanticUI {
          * 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 +228,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 +267,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 +377,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 +481,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;

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.
@@ -278,7 +278,7 @@ declare namespace FomanticUI {
                  */
                 determineTitle: Function;
             }
-        
+
             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
 

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

@@ -112,11 +112,39 @@ declare namespace FomanticUI {
          */
         (behavior: 'is supported'): boolean;
 
+        (behavior: 'scale', duration?: any, onComplete?: () => any): JQuery;
+
+        (behavior: 'zoom', duration?: any, onComplete?: () => any): JQuery;
+
+        (behavior: 'fade' | 'fade up' | 'fade down' | 'fade left' | 'fade right', duration?: any, onComplete?: () => any): JQuery;
+
+        (behavior: 'horizontal flip' | 'vertical flip', duration?: any, onComplete?: () => any): JQuery;
+
+        (behavior: 'drop', duration?: any, onComplete?: () => any): JQuery;
+
+        (behavior: 'fly up' | 'fly down' | 'fly left' | 'fly right', duration?: any, onComplete?: () => any): JQuery;
+
+        (behavior: 'swing up' | 'swing down' | 'swing left' | 'swing right', duration?: any, onComplete?: () => any): JQuery;
+
+        (behavior: 'browse' | 'browse up' | 'browse down' | 'browse left' | 'browse right', duration?: any, onComplete?: () => any): JQuery;
+
+        (behavior: 'slide up' | 'slide down' | 'slide left' | 'slide right', duration?: any, onComplete?: () => any): JQuery;
+
+        // Static animations
+        (behavior: 'pulsating', duration?: any, onComplete?: () => any): JQuery;
+        (behavior: 'jiggle', duration?: any, onComplete?: () => any): JQuery;
+        (behavior: 'flash', duration?: any, onComplete?: () => any): JQuery;
+        (behavior: 'shake', duration?: any, onComplete?: () => any): JQuery;
+        (behavior: 'pulse', duration?: any, onComplete?: () => any): JQuery;
+        (behavior: 'tada', duration?: any, onComplete?: () => any): JQuery;
+        (behavior: 'bounce', duration?: any, onComplete?: () => any): JQuery;
+        (behavior: 'glow', duration?: any, onComplete?: () => any): JQuery;
+
         /**
          * Destroys instance and removes all events.
          */
         (behavior: 'destroy'): JQuery;
-        <K extends keyof TransitionSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<TransitionSettings, keyof TransitionSettings>>;
+        <K extends keyof TransitionSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<TransitionSettings, keyof TransitionSettings>>;
         <K extends keyof TransitionSettings>(behavior: 'setting', name: K, value: TransitionSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<TransitionSettings, keyof TransitionSettings>>): JQuery;
         (settings?: Partial<Pick<TransitionSettings, keyof TransitionSettings>>): JQuery;

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

@@ -44,10 +44,10 @@ declare namespace FomanticUI {
         (behavior: 'get screen size'): object;
 
         (behavior: 'destroy'): JQuery;
-        <K extends keyof VisibilitySettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<VisibilitySettings, keyof VisibilitySettings>>;
+        <K extends keyof VisibilitySettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<VisibilitySettings, keyof VisibilitySettings>>;
         <K extends keyof VisibilitySettings>(behavior: 'setting', name: K, value: VisibilitySettings[K]): JQuery;
-        (behavior: 'setting', value: VisibilitySettings): JQuery;
-        (settings?: VisibilitySettings): JQuery;
+        (behavior: 'setting', value: Partial<Pick<VisibilitySettings, keyof VisibilitySettings>>): JQuery;
+        (settings?: Partial<Pick<VisibilitySettings, keyof VisibilitySettings>>): JQuery;
     }
 
     /**

package/types/index.d.ts

@@ -30,34 +30,34 @@
 /// <reference path="fomantic-ui-visibility.d.ts" />
 
 interface JQuery {
-    accordion:  FomanticUI.Accordion;
-    api:        FomanticUI.API;
-    calendar:   FomanticUI.Calendar;
-    checkbox:   FomanticUI.Checkbox;
-    dimmer:     FomanticUI.Dimmer;
-    dropdown:   FomanticUI.Dropdown;
-    embed:      FomanticUI.Embed;
-    flyout:     FomanticUI.Flyout;
-    form:       FomanticUI.Form;
-    modal:      FomanticUI.Modal;
-    nag:        FomanticUI.Nag;
-    popup:      FomanticUI.Popup;
-    progress:   FomanticUI.Progress;
-    rating:     FomanticUI.Rating;
-    search:     FomanticUI.Search;
-    shape:      FomanticUI.Shape;
-    sidebar:    FomanticUI.Sidebar;
-    slider:     FomanticUI.Slider;
-    sticky:     FomanticUI.Sticky;
-    tab:        FomanticUI.Tab;
-    toast:      FomanticUI.Toast;
+    accordion: FomanticUI.Accordion;
+    api: FomanticUI.API;
+    calendar: FomanticUI.Calendar;
+    checkbox: FomanticUI.Checkbox;
+    dimmer: FomanticUI.Dimmer;
+    dropdown: FomanticUI.Dropdown;
+    embed: FomanticUI.Embed;
+    flyout: FomanticUI.Flyout;
+    form: FomanticUI.Form;
+    modal: FomanticUI.Modal;
+    nag: FomanticUI.Nag;
+    popup: FomanticUI.Popup;
+    progress: FomanticUI.Progress;
+    rating: FomanticUI.Rating;
+    search: FomanticUI.Search;
+    shape: FomanticUI.Shape;
+    sidebar: FomanticUI.Sidebar;
+    slider: FomanticUI.Slider;
+    sticky: FomanticUI.Sticky;
+    tab: FomanticUI.Tab;
+    toast: FomanticUI.Toast;
     transition: FomanticUI.Transition;
     visibility: FomanticUI.Visibility;
 }
 
 interface JQueryStatic {
-    api:        FomanticUI.API;
-    flyout:     FomanticUI.Flyout;
-    modal:      FomanticUI.Modal;
-    toast:      FomanticUI.Toast;
+    api: FomanticUI.API;
+    flyout: FomanticUI.Flyout;
+    modal: FomanticUI.Modal;
+    toast: FomanticUI.Toast;
 }