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

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

@@ -0,0 +1,533 @@
+declare namespace FomanticUI {
+    interface Progress {
+        settings: ProgressSettings;
+
+        /**
+         * Sets current percent of progress to value.
+         * If using a total will convert from percent to estimated value.
+         * 'percent' can be array of percent like '[20,30,50]', comma-separated string like '20,30,50' for `.ui.multiple.progress`.
+         */
+        (behavior: 'set percent', percent: number | [] | string): JQuery;
+
+        /**
+         * Sets progress to specified value.
+         * Will automatically calculate percent from total.
+         * value can be array of values like '[5,3,10]', comma-separated string like '5,3,10' for `.ui.multiple.progress`.
+         */
+        (behavior: 'set progress', value: number | [] | string): JQuery;
+
+        /**
+         * Increments progress by increment value, if not passed a value will use random amount specified in settings.
+         */
+        (behavior: 'increment', incrementValue: number): JQuery;
+
+        /**
+         * Decrements progress by decrement value, if not passed a value will use random amount specified in settings.
+         */
+        (behavior: 'decrement', decrementValue: number): JQuery;
+
+        /**
+         * Immediately updates progress to value, ignoring progress animation interval delays.
+         * 'value' can be array of values like '[5,3,10]', comma-separated string like '5,3,10' for `.ui.multiple.progress`.
+         */
+        (behavior: 'update progress', value: number | [] | string): JQuery;
+
+        /**
+         * Finishes progress and sets loaded to 100%.
+         * Set 'keepState' to 'true' (default 'false') to stop the active animation only without setting the progress to 100%.
+         */
+        (behavior: 'complete', keepState: boolean): JQuery;
+
+        /**
+         * Resets progress to zero.
+         */
+        (behavior: 'reset'): JQuery;
+
+        /**
+         * Set total to a new value.
+         */
+        (behavior: 'set total', total: number): JQuery;
+
+        /**
+         * Replaces templated string with value, total, percent left and percent.
+         */
+        (behavior: 'get text', text: string): JQuery;
+
+        /**
+         * Returns normalized value inside acceptable range specified by total.
+         */
+        (behavior: 'get normalized value', value: number): JQuery;
+
+        /**
+         * Returns percent as last specified.
+         */
+        (behavior: 'get percent'): number;
+
+        /**
+         * Returns current progress value.
+         */
+        (behavior: 'get value'): number;
+
+        /**
+         * Returns total.
+         */
+        (behavior: 'get total'): number;
+
+        /**
+         * Returns whether progress is completed.
+         */
+        (behavior: 'is complete'): boolean;
+
+        /**
+         * Returns whether progress was a success.
+         */
+        (behavior: 'is success'): boolean;
+
+        /**
+         * Returns whether progress is in warning state.
+         */
+        (behavior: 'is warning'): boolean;
+
+        /**
+         * Returns whether progress is in error state.
+         */
+        (behavior: 'is error'): boolean;
+
+        /**
+         * Returns whether progress is in active state.
+         */
+        (behavior: 'is active'): boolean;
+
+        /**
+         * Sets progress to active state.
+         */
+        (behavior: 'set active'): JQuery;
+
+        /**
+         * Sets progress to warning state. Set 'keepState' to 'true' (default 'false') to keep the progressbar state and the current percentage without raising it up to 100%.
+         */
+        (behavior: 'set warning', text: string, keepState: boolean): JQuery;
+
+        /**
+         * Sets progress to success state. Set 'keepState' to 'true' (default 'false') to keep the progressbar state and the current percentage without raising it up to 100%.
+         */
+        (behavior: 'set success', text: string, keepState: boolean): JQuery;
+
+        /**
+         * Sets progress to error state. Set 'keepState' to 'true' (default 'false') to keep the progressbar state and the current percentage without raising it up to 100%.
+         */
+        (behavior: 'set error', text: string, keepState: boolean): JQuery;
+
+        /**
+         * Changes progress animation speed.
+         */
+        (behavior: 'set duration', value: number): JQuery;
+
+        /**
+         * Sets progress exterior label to text.
+         */
+        (behavior: 'set label', text: string): JQuery;
+
+        /**
+         * Sets progress bar label to text.
+         */
+        (behavior: 'set bar label', text: string): JQuery;
+
+        /**
+         * Removes progress to active state.
+         */
+        (behavior: 'remove active'): JQuery;
+
+        /**
+         * Removes progress to warning state.
+         */
+        (behavior: 'remove warning'): JQuery;
+
+        /**
+         * Removes progress to success state.
+         */
+        (behavior: 'remove success'): JQuery;
+
+        /**
+         * Removes progress to error state.
+         */
+        (behavior: 'remove error'): JQuery;
+
+        /**
+         * Destroys instance and removes all events.
+         */
+        (behavior: 'destroy'): JQuery;
+
+        <K extends keyof ProgressSettings>(behavior: 'setting', name: K, value?: undefined): ProgressSettings._Impl[K];
+        <K extends keyof ProgressSettings>(behavior: 'setting', name: K, value: ProgressSettings._Impl[K]): JQuery;
+        (behavior: 'setting', value: ProgressSettings): JQuery;
+        (settings?: ProgressSettings): JQuery;
+    }
+
+    /**
+     * @see {@link https://fomantic-ui.com/modules/progress.html#/settings}
+     */
+    type ProgressSettings = ProgressSettings.Param;
+
+    namespace ProgressSettings {
+        type Param = (
+            | Pick<_Impl, 'autoSuccess'>
+            | Pick<_Impl, 'showActivity'>
+            | Pick<_Impl, 'limitValues'>
+            | Pick<_Impl, 'label'>
+            | Pick<_Impl, 'random'>
+            | Pick<_Impl, 'precision'>
+            | Pick<_Impl, 'total'>
+            | Pick<_Impl, 'value'>
+            | Pick<_Impl, 'onChange'>
+            | Pick<_Impl, 'onSuccess'>
+            | Pick<_Impl, 'onActive'>
+            | Pick<_Impl, 'onError'>
+            | Pick<_Impl, 'onWarning'>
+            | Pick<_Impl, 'selector'>
+            | Pick<_Impl, 'className'>
+            | 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 Progress Settings
+
+            /**
+             * Whether success state should automatically trigger when progress completes.
+             * @default true
+             */
+            autoSuccess: boolean;
+
+            /**
+             * Whether progress should automatically show activity when incremented.
+             * @default true
+             */
+            showActivity: boolean;
+
+            /**
+             * When set to 'true', values that calculate to above 100% or below 0% will be adjusted.
+             * When set to 'false', inappropriate values will produce an error.
+             * @default true
+             */
+            limitValues: boolean;
+
+            /**
+             * Can be set to either to display progress as 'percent' or 'ratio'.
+             * Matches up to corresponding text template with the same name.
+             * @default 'percent'
+             */
+            label: 'percent' | 'ratio';
+
+            /**
+             * When incrementing without value, sets range for random increment value.
+             * @default {}
+             */
+            random: object;
+
+            /**
+             * Decimal point precision for calculated progress.
+             * @default 0
+             */
+            precision: 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
+             */
+            total: false | number;
+
+            /**
+             * Sets current value, when total is specified, this is used to calculate a ratio of the total, with percent this should be the overall percent.
+             * @default false
+             */
+            value: false | number;
+
+            // endregion
+
+            // region Callbacks
+
+            /**
+             * Callback on percentage change.
+             */
+            onChange(this: JQuery, percent: number, value: number, total: number): void;
+
+            /**
+             * Callback on success state.
+             */
+            onSuccess(this: JQuery, total: number): void;
+
+            /**
+             * Callback on active state.
+             */
+            onActive(this: JQuery, value: number, total: number): void;
+
+            /**
+             * Callback on error state.
+             */
+            onError(this: JQuery, value: number, total: number): void;
+
+            /**
+             * Callback on warning state.
+             */
+            onWarning(this: JQuery, value: number, total: number): void;
+
+            // endregion
+
+            // region DOM Settings
+
+            /**
+             * DOM Selectors used internally.
+             * Selectors used to find parts of a module.
+             */
+            selector: Progress.SelectorSettings;
+
+            /**
+             * Class names used to determine element state.
+             */
+            className: Progress.ClassNameSettings;
+
+            /**
+             *
+             */
+            text: Progress.TextSettings;
+
+            /**
+             * Regular expressions used by module
+             */
+            regExp: Progress.RegExpSettings;
+
+            /**
+             * Regular expressions used by module
+             */
+            metadata: Progress.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;
+
+            /**
+             * Show console.table output with performance metrics
+             */
+            performance: boolean;
+
+            /**
+             * Debug output includes all internal behaviors
+             */
+            verbose: boolean;
+
+            error: Progress.ErrorSettings;
+
+            // endregion
+        }
+
+        namespace Progress {
+            type SelectorSettings = SelectorSettings.Param;
+
+            namespace SelectorSettings {
+                type Param = (Pick<_Impl, 'bar'> | Pick<_Impl, 'label'> | Pick<_Impl, 'progress'>) &
+                    Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default '> .bar'
+                     */
+                    bar: string;
+
+                    /**
+                     * @default '> .label'
+                     */
+                    label: string;
+
+                    /**
+                     * @default '.bar > .progress'
+                     */
+                    progress: string;
+                }
+            }
+
+            type ClassNameSettings = ClassNameSettings.Param;
+
+            namespace ClassNameSettings {
+                type Param = (
+                    | Pick<_Impl, 'active'>
+                    | Pick<_Impl, 'error'>
+                    | Pick<_Impl, 'success'>
+                    | Pick<_Impl, 'warning'>
+                ) &
+                    Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default 'active'
+                     */
+                    active: string;
+
+                    /**
+                     * @default 'error'
+                     */
+                    error: string;
+
+                    /**
+                     * @default 'success'
+                     */
+                    success: string;
+
+                    /**
+                     * @default 'warning'
+                     */
+                    warning: string;
+                }
+            }
+
+            type TextSettings = TextSettings.Param;
+
+            namespace TextSettings {
+                type Param = (
+                    | Pick<_Impl, 'active'>
+                    | Pick<_Impl, 'error'>
+                    | Pick<_Impl, 'success'>
+                    | Pick<_Impl, 'warning'>
+                    | Pick<_Impl, 'percent'>
+                    | Pick<_Impl, 'ratio'>
+                    | Pick<_Impl, 'bars'>
+                ) &
+                    Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default false
+                     */
+                    active: boolean | string;
+
+                    /**
+                     * @default false
+                     */
+                    error: boolean | string;
+
+                    /**
+                     * @default false
+                     */
+                    success: boolean | string;
+
+                    /**
+                     * @default false
+                     */
+                    warning: boolean | string;
+
+                    /**
+                     * @default '{percent}%''
+                     */
+                    percent: string;
+
+                    /**
+                     * @default '{value} of {total}'
+                     */
+                    ratio: string;
+
+                    /**
+                     * @default []
+                     */
+                    bars: string[];
+                }
+            }
+
+            type RegExpSettings = RegExpSettings.Param;
+
+            namespace RegExpSettings {
+                type Param = Pick<_Impl, 'variable'> & Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default /\{\$*[A-z0-9]+\}/g
+                     */
+                    variable: RegExp;
+                }
+            }
+
+            type MetadataSettings = MetadataSettings.Param;
+
+            namespace MetadataSettings {
+                type Param = (Pick<_Impl, 'percent'> | Pick<_Impl, 'total'> | Pick<_Impl, 'value'>) &
+                    Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default 'percent'
+                     */
+                    percent: string;
+
+                    /**
+                     * @default 'total'
+                     */
+                    total: string;
+
+                    /**
+                     * @default 'value'
+                     */
+                    value: string;
+                }
+            }
+
+            type ErrorSettings = ErrorSettings.Param;
+
+            namespace ErrorSettings {
+                type Param = (
+                    | Pick<_Impl, 'method'>
+                    | Pick<_Impl, 'nonNumeric'>
+                    | Pick<_Impl, 'tooHigh'>
+                    | Pick<_Impl, 'tooLow'>
+                ) &
+                    Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default 'The method you called is not defined.'
+                     */
+                    method: string;
+
+                    /**
+                     * @default 'Progress value is non numeric'
+                     */
+                    nonNumeric: string;
+
+                    /**
+                     * @default 'Value specified is above 100%'
+                     */
+                    tooHigh: string;
+
+                    /**
+                     * @default 'Value specified is below 0%'
+                     */
+                    tooLow: string;
+                }
+            }
+        }
+    }
+}