fomantic-ui 2.9.4-beta.4 → 2.9.4-beta.41

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

@@ -6,7 +6,7 @@ declare namespace FomanticUI {
          * Recreates dropdown menu from passed values.
          * values should be an object with the following structure: { values: [ {value, text, name} ] }.
          */
-        (behavior: 'setup menu', values: object): void;
+        (behavior: 'setup menu', values: object): JQuery;
 
         /**
          * Changes dropdown to use new values.
@@ -17,7 +17,7 @@ declare namespace FomanticUI {
         /**
          * Refreshes all cached selectors and data
          */
-        (behavior: 'refresh'): void;
+        (behavior: 'refresh'): JQuery;
 
         /**
          * Toggles current visibility of dropdown
@@ -29,20 +29,20 @@ declare namespace FomanticUI {
          * If a function is provided to callback, it's called after the dropdown-menu is shown.
          * Set preventFocus to true if you don't want the dropdown field to focus after the menu is shown
          */
-        (behavior: 'show', callback: Function, preventFocus: boolean): void;
+        (behavior: 'show', callback?: Function, preventFocus?: boolean): void;
 
         /**
          * Hides dropdown.
          * If a function is provided to callback, it's called after the dropdown-menu is hidden.
          * Set preventBlur to true if you don't want the dropdown field to blur after the menu is hidden
          */
-        (behavior: 'hide', callback:Function, preventBlur: boolean): void;
+        (behavior: 'hide', callback?: Function, preventBlur?: boolean): void;
 
         /**
          * Clears dropdown of selection.
          * Set preventChangeTrigger to true to omit the change event (default: false).
          */
-        (behavior: 'clear', preventChangeTrigger: boolean): void;
+        (behavior: 'clear', preventChangeTrigger?: boolean): JQuery;
 
         /**
          * Hides all other dropdowns that is not current dropdown
@@ -53,7 +53,7 @@ declare namespace FomanticUI {
          * Restores dropdown text and value to its value on page load.
          * Set preventChangeTrigger to true to omit the change event (default: false).
          */
-        (behavior: 'restore defaults', preventChangeTrigger: boolean): void;
+        (behavior: 'restore defaults', preventChangeTrigger?: boolean): void;
 
         /**
          * Restores dropdown text to its value on page load
@@ -79,33 +79,28 @@ declare namespace FomanticUI {
          * Sets value as selected.
          * Set preventChangeTrigger to true to omit the change event (default: false).
          */
-        (behavior: 'set selected', value: string, preventChangeTrigger: boolean): void;
+        (behavior: 'set selected', value: string | string[], preventChangeTrigger?: boolean, keepSearchTerm?: boolean): JQuery;
 
         /**
          * Remove value from selected
          */
         (behavior: 'remove selected', value: string): void;
 
-        /**
-         * Adds a group of values as selected
-         */
-        (behavior: 'set selected', values: string[]): void;
-
         /**
          * Sets selected values to exactly specified values, removing current selection
          */
-        (behavior: 'set exactly', values: string[]): void;
+        (behavior: 'set exactly', values: string[]): JQuery;
 
         /**
          * Sets dropdown text to a value
          */
-        (behavior: 'text', text: string): void;
+        (behavior: 'set text', text: string): JQuery;
 
         /**
          * Sets dropdown input to value (does not update display state).
          * Set preventChangeTrigger to true to omit the change event (default: false).
          */
-        (behavior: 'set value', value: string, preventChangeTrigger: boolean): void;
+        (behavior: 'set value', value: string, preventChangeTrigger?: boolean): JQuery;
 
         /**
          * Returns current dropdown text
@@ -215,7 +210,7 @@ declare namespace FomanticUI {
         (behavior: 'get placeholder text'): string;
 
         (behavior: 'destroy'): JQuery;
-        <K extends keyof DropdownSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<DropdownSettings, keyof DropdownSettings>>;
+        <K extends keyof DropdownSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<DropdownSettings, keyof DropdownSettings>>;
         <K extends keyof DropdownSettings>(behavior: 'setting', name: K, value: DropdownSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<DropdownSettings, keyof DropdownSettings>>): JQuery;
         (settings?: Partial<Pick<DropdownSettings, keyof DropdownSettings>>): JQuery;
@@ -265,7 +260,7 @@ declare namespace FomanticUI {
          * @see {@link https://fomantic-ui.com/behaviors/api.html#/settings}
          * @default false
          */
-        apiSettings: false | APISettings | JQueryAjaxSettings;
+        apiSettings: false | Partial<Pick<APISettings, keyof APISettings>> | Partial<Pick<JQueryAjaxSettings, keyof JQueryAjaxSettings>>;
 
         /**
          * Whether dropdown should select new option when using keyboard shortcuts.
@@ -350,7 +345,7 @@ declare namespace FomanticUI {
          *
          * @default 'auto'
          */
-        placeholder: 'auto' | String | false;
+        placeholder: 'auto' | string | false;
 
         /**
          * Whether HTML included in dropdown values should be preserved.
@@ -390,6 +385,12 @@ declare namespace FomanticUI {
          */
         ignoreSearchCase: boolean;
 
+        /**
+         * Whether search result should highlight matching strings
+         * @default false
+         */
+        highlightMatches: boolean;
+
         /**
          * If disabled user additions will appear in the dropdown's menu using a specially formatted selection item formatted by 'templates.addition'.
          * @default true
@@ -506,7 +507,7 @@ declare namespace FomanticUI {
          * Is called after a dropdown value changes.
          * Receives the name and value of selection and the active menu element.
          */
-        onChange(value: string, text: string, $choice: JQuery): void;
+        onChange(value?: string, text?: string, $choice?: JQuery): void;
 
         /**
          * Is called after a dropdown selection is added using a multiple select dropdown, only receives the added value.
@@ -582,22 +583,22 @@ declare namespace FomanticUI {
         message: Dropdown.MessageSettings;
 
         /**
-         * 
+         *
          */
         regExp: Dropdown.RegExpSettings;
 
         /**
-         * 
+         *
          */
         metadata: Dropdown.MetadataSettings;
 
         /**
-         * 
+         *
          */
         fields: Dropdown.FieldsSettings;
 
         /**
-         * 
+         *
          */
         keys: Dropdown.KeysSettings;
 
@@ -743,7 +744,7 @@ declare namespace FomanticUI {
                  */
                 clearIcon: string;
             }
-        
+
             interface ClassNames {
                 /**
                  * @default 'active'
@@ -920,7 +921,7 @@ declare namespace FomanticUI {
                  */
                 actionable: string;
             }
-        
+
             interface Messages {
                 /**
                  * @default 'Add <b>{term}</b>'
@@ -952,9 +953,9 @@ declare namespace FomanticUI {
                 /**
                  * @default '/[-[\]{}()*+?.,\\^$|#\s]/g'
                  */
-                escape: string;  
+                escape: string;
             }
-        
+
             interface Metadatas {
                 /**
                  * @default 'defaultText'
@@ -964,24 +965,24 @@ declare namespace FomanticUI {
                 /**
                  * @default 'defaultValue'
                  */
-                defaultValue: string;  
+                defaultValue: string;
 
                 /**
                  * @default 'placeholderText'
                  */
-                placeholderText: string;  
+                placeholderText: string;
 
                 /**
                  * @default 'text'
                  */
-                text: string;  
+                text: string;
 
                 /**
                  * @default 'value'
                  */
-                value: string;  
+                value: string;
             }
-       
+
             interface Fields {
                 /**
                  * Grouping for api results
@@ -993,13 +994,13 @@ declare namespace FomanticUI {
                  * Grouping for all dropdown values
                  * @default 'values'
                  */
-                values: string;  
+                values: string;
 
                 /**
                  * Whether value should be disabled
                  * @default 'disabled'
                  */
-                disabled: string;  
+                disabled: string;
 
                 /**
                  * Displayed dropdown text
@@ -1079,7 +1080,7 @@ declare namespace FomanticUI {
                  */
                 actionable: string;
             }
-        
+
             interface Keys {
                 /**
                  * @default 8

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

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

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

@@ -48,8 +48,13 @@ declare namespace FomanticUI {
          */
         (behavior: 'get settings'): FlyoutSettings;
 
+        /**
+         * Templates handling
+         */
+        (behavior: keyof Flyout.TemplatesSettings, ...args: any): Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>;
+
         (behavior: 'destroy'): JQuery;
-        <K extends keyof FlyoutSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>;
+        <K extends keyof FlyoutSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>;
         <K extends keyof FlyoutSettings>(behavior: 'setting', name: K, value: FlyoutSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>): JQuery;
         (settings?: Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>): JQuery;
@@ -145,43 +150,43 @@ declare namespace FomanticUI {
          * Content of the flyout header.
          * @default ''
          */
-        title: boolean;
+        title: string;
 
         /**
          * Content of the flyout content.
          * @default ''
          */
-        content: boolean;
+        content: string;
 
         /**
          * Can hold a string to be added to the flyout class to control its appearance.
          * @default ''
          */
-        class: boolean;
+        class: string;
 
         /**
          * Can hold a string to be added to the title class to control its appearance.
          * @default ''
          */
-        classTitle: boolean;
+        classTitle: string;
 
         /**
          * Can hold a string to be added to the content class to control its appearance.
          * @default ''
          */
-        classContent: boolean;
+        classContent: string;
 
         /**
          * Can hold a string to be added to the actions class to control its appearance.
          * @default ''
          */
-        classActions: boolean;
+        classActions: string;
 
         /**
          * Can hold a string to be added to the actions class to control its appearance.
          * @default false
          */
-        closeIcon: boolean;
+        closeIcon: boolean | string;
 
         /**
          * An array of objects. Each object defines an action with properties `text`, `class`, `icon` and `click`.
@@ -261,6 +266,8 @@ declare namespace FomanticUI {
 
         // region Config Template Settings
 
+        templates: Flyout.TemplatesSettings;
+
         // endregion
 
         // region Debug Settings
@@ -311,6 +318,7 @@ declare namespace FomanticUI {
         type ClassNameSettings = Partial<Pick<Settings.ClassNames, keyof Settings.ClassNames>>;
         type RegExpSettings = Partial<Pick<Settings.RegExps, keyof Settings.RegExps>>;
         type ErrorSettings = Partial<Pick<Settings.Errors, keyof Settings.Errors>>;
+        type TemplatesSettings = Partial<Pick<Settings.Templates, keyof Settings.Templates>> & {[key: string]: (...args: any) => Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>};
 
         namespace Settings {
             interface Selectors {
@@ -364,7 +372,7 @@ declare namespace FomanticUI {
                  */
                 deny: string;
             }
-            
+
             interface ClassNames {
                 /**
                  * @default 'ui flyout'
@@ -481,7 +489,7 @@ declare namespace FomanticUI {
                  */
                 prompt: string;
             }
-        
+
             interface RegExps {
                 /**
                  * @default /(iPad|iPhone|iPod)/g
@@ -520,6 +528,12 @@ declare namespace FomanticUI {
                  */
                 notFound: string;
             }
+
+            interface Templates {
+                alert(): Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>;
+                confirm(): Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>;
+                prompt(): Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>;
+            }
         }
     }
 }

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

@@ -15,7 +15,12 @@ declare namespace FomanticUI {
         /**
          * Adds rule to existing rules for field, also aliased as 'add field'.
          */
-        (behavior: 'add rule', field: string, rules: object[]): void;
+        (behavior: 'add rule', field: string, rules: string | string[] | FormField[]): void;
+
+        /**
+         * Adds field object to existing fields.
+         */
+        (behavior: 'add field', name: string, rules: string | string[] | FormRule[]): void;
 
         /**
          * Adds fields object to existing fields.
@@ -25,13 +30,18 @@ declare namespace FomanticUI {
         /**
          * Removes specific rule from field leaving other rules.
          */
-        (behavior: 'remove rule', field: string, rules: object[]): void;
+        (behavior: 'remove rule', field: string, rules?: object[]): void;
 
         /**
          * Remove all validation for a field.
          */
         (behavior: 'remove field', field: string): void;
 
+        /**
+         * Remove all validation for an array of fields.
+         */
+        (behavior: 'remove fields', field: string[]): void;
+
         /**
          * Returns 'true'/'false' whether a field passes its validation rules.
          * If you add 'true' as the second parameter, any failed rule will update the UI.
@@ -41,7 +51,7 @@ declare namespace FomanticUI {
         /**
          * Validates form, updates UI, and calls 'onSuccess' or 'onFailure'.
          */
-        (behavior: 'validate form'): void;
+        (behavior: 'validate form'): boolean;
 
         /**
          * Validates field, updates UI, and calls 'onSuccess' or 'onFailure'.
@@ -62,7 +72,7 @@ declare namespace FomanticUI {
          * Returns object of element values that match array of identifiers.
          * If no IDS are passed will return all fields.
          */
-        (behavior: 'get values', identifiers?: string[]): object;
+        (behavior: 'get values', identifiers?: string[]): Record<string, string>;
 
         /**
          * Sets value of element with id.
@@ -97,23 +107,33 @@ declare namespace FomanticUI {
         /**
          * Adds a custom user prompt for a given element with identifier.
          */
-        (behavior: 'add prompt', identifier: string, errors: object[]): void;
+        (behavior: 'add prompt', identifier: string, errors: string | object[]): void;
 
         /**
          * Empty all fields and remove possible errors.
          */
-        (behavior: 'clear'): void;
+        (behavior: 'clear'): JQuery;
 
         /**
          * Set all fields to their initial value and remove possible errors.
          */
-        (behavior: 'reset'): void;
+        (behavior: 'reset'): JQuery;
 
         /**
          * Set fields actual values as default values.
          */
         (behavior: 'set defaults'): void;
 
+        /**
+         * Returns 'true'/'false' whether a form is dirty.
+         */
+        (behavior: 'is dirty'): boolean;
+
+        /**
+         * Returns 'true'/'false' whether a form is clean.
+         */
+        (behavior: 'is clean'): boolean;
+
         /**
          * Return elements which have been modified since form state was changed to 'dirty'.
          */
@@ -122,10 +142,10 @@ declare namespace FomanticUI {
         /**
          * Set the state of the form to 'clean' and set new values as default.
          */
-        (behavior: 'set as clean'): void;
+        (behavior: 'set as clean'): JQuery;
 
         /**
-         * Automatically adds the "empty" rule or automatically checks a checkbox for all fields with classname or attribute 'required'.
+         * Automatically adds the "notEmpty" rule or automatically checks a checkbox for all fields with classname or attribute 'required'.
          */
         (behavior: 'set auto check'): void;
 
@@ -138,18 +158,39 @@ declare namespace FomanticUI {
          * Destroys instance and removes all events.
          */
         (behavior: 'destroy'): JQuery;
-        <K extends keyof FormSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<FormSettings, keyof FormSettings>>;
+        <K extends keyof FormSettings>(behavior: 'setting', name: K, value?: undefined,): Partial<Pick<FormSettings, keyof FormSettings>>;
         <K extends keyof FormSettings>(behavior: 'setting', name: K, value: FormSettings[K]): JQuery;
         (behavior: 'setting', value: Partial<Pick<FormSettings, keyof FormSettings>>): JQuery;
         (settings?: Partial<Pick<FormSettings, keyof FormSettings>>): JQuery;
     }
 
+    type FormFields = Record<string, FormField | string[] | string | {}>;
+
+    interface FormRule {
+        type: string;
+        prompt?: string | ((value: string) => void);
+        value?: string | RegExp;
+    }
+
+    interface FormField {
+        identifier?: string;
+        depends?: string;
+        optional?: boolean;
+        rules: FormRule[];
+    }
+
     /**
      * @see {@link https://fomantic-ui.com/behaviors/form.html#/settings}
      */
     interface FormSettings {
         // region Form Settings
 
+        /**
+         * Adds keyboard shortcuts for enter and escape keys to submit form and blur fields respectively.
+         * @default false
+         */
+        fields: false | FormFields;
+
         /**
          * Adds keyboard shortcuts for enter and escape keys to submit form and blur fields respectively.
          * @default true
@@ -215,7 +256,7 @@ declare namespace FomanticUI {
         preventLeaving: boolean;
 
         /**
-         * Whether fields with classname or attribute 'required' should automatically add the "empty" rule or automatically checks checkbox fields.
+         * Whether fields with classname or attribute 'required' should automatically add the "notEmpty" rule or automatically checks checkbox fields.
          * @default false
          */
         autoCheckRequired: boolean;
@@ -232,6 +273,12 @@ declare namespace FomanticUI {
          */
         errorLimit: number;
 
+        /**
+         *
+         * @default false
+         */
+        noNativeValidation: boolean;
+
         // endregion
 
         // region Form Prompts
@@ -248,6 +295,12 @@ declare namespace FomanticUI {
 
         // endregion
 
+        // region Formatters
+
+        rules: Form.RulesSettings;
+
+        // endregion
+
         // region Callbacks
 
         /**
@@ -258,17 +311,17 @@ declare namespace FomanticUI {
         /**
          * Callback on each invalid field.
          */
-        onInvalid(this: JQuery): void;
+        onInvalid(this: JQuery, fieldErrors: string | string[]): void;
 
         /**
          * Callback if a form is all valid.
          */
-        onSuccess(this: JQuery, event: Event, fields: object[]): void;
+        onSuccess(this: JQuery, event: Event, fields: {[key: string]: any}): void;
 
         /**
          * Callback if any form field is invalid.
          */
-        onFailure(this: JQuery, formErrors: object[], fields: object[]): void;
+        onFailure(this: JQuery, formErrors: {[key: string]: any}, fields: {[key: string]: any}): void;
 
         /**
          * Callback if form state is modified to 'dirty'.
@@ -349,8 +402,9 @@ declare namespace FomanticUI {
 
     namespace Form {
         type TextSettings = Partial<Pick<Settings.Texts, keyof Settings.Texts>>;
-        type PromptSettings = Partial<Pick<Settings.Prompts, keyof Settings.Prompts>>;
+        type PromptSettings = Partial<Pick<Settings.Prompts, keyof Settings.Prompts>> & {[key: string]: string | undefined};
         type FormatterSettings = Partial<Pick<Settings.Formatters, keyof Settings.Formatters>>;
+        type RulesSettings = Partial<Pick<Settings.Rules, keyof Settings.Rules>> & {[key: string]: (value?: any, identifier?: string, module?: any) => boolean};
         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>>;
@@ -375,11 +429,32 @@ declare namespace FomanticUI {
             }
 
             interface Prompts {
+                /**
+                 * @default '{name} must be in a range from {min} to {max}'
+                 */
+                range: string;
+
+                /**
+                 * @default '{name} must have a maximum value of {ruleValue}'
+                 */
+                maxValue: string;
+
+                /**
+                 * @default '{name} must have a minimum value of {ruleValue}'
+                 */
+                minValue: string;
+
                 /**
                  * @default '{name} must have a value'
+                 * @deprecated Use notEmpty instead
                  */
                 empty: string;
 
+                /**
+                 * @default '{name} must have a value'
+                 */
+                notEmpty: string;
+
                 /**
                  * @default '{name} must be checked'
                  */
@@ -509,6 +584,39 @@ declare namespace FomanticUI {
                 year(date: string): string;
             }
 
+            interface Rules {
+                empty(value: unknown): boolean;
+                notEmpty(value: unknown): boolean;
+                checked(): boolean;
+                email(value: unknown): boolean;
+                url(value: unknown): boolean;
+                regExp(value: unknown, regExp: RegExp): boolean;
+                minValue(value: unknown, range: string): boolean;
+                maxValue(value: unknown, range: string): boolean;
+                integer(value: unknown, range: string): boolean;
+                range(value: unknown, range: string, regExp: RegExp, testLength: boolean): boolean;
+                decimal(value: unknown, range: string): boolean;
+                number(value: unknown, range: string): boolean;
+                is(value: unknown, text: string): boolean;
+                isExactly(value: unknown, text: string): boolean;
+                not(value: unknown, notValue: unknown): boolean;
+                notExactly(value: unknown, notValue: unknown): boolean;
+                contains(value: unknown, text: string): boolean;
+                containsExactly(value: unknown, text: string): boolean;
+                doesntContain(value: unknown, text: string): boolean;
+                doesntContainExactly(value: unknown, text: string): boolean;
+                minLength(value: unknown, minLength: number): boolean;
+                exactLength(value: unknown, requiredLength: number): boolean;
+                maxLength(value: unknown, maxLength: number): boolean;
+                size(value: unknown, range: string): boolean;
+                match(value: unknown, identifier: string, module: unknown): boolean;
+                different(value: unknown, identifier: string, module: unknown): boolean;
+                creditCard(cardNumber: unknown, cardTypes: string): boolean;
+                minCount(value: unknown, minCount: number): boolean;
+                exactCount(value: unknown, exactCount: number): boolean;
+                maxCount(value: unknown, maxCount: number): boolean;
+            }
+
             interface Selectors {
                 /**
                  * @default 'input[type="checkbox"], input[type="radio"]'