fomantic-ui 2.9.3-beta.8 → 2.9.3

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

@@ -0,0 +1,316 @@
+declare namespace FomanticUI {
+    interface Slider {
+        settings: SliderSettings;
+
+        /**
+         * Get the current selected value.
+         */
+        (behavior: 'get value'): number;
+
+        /**
+         * Get the selected value of one of the range thumbs.
+         * Provide either 'first' or 'second' as a string parameter.
+         */
+        (behavior: 'get thumbValue', which: 'first' | 'second'): number;
+
+        /**
+         * Get the number of rendered label ticks.
+         */
+        (behavior: 'get numLabels'): number;
+
+        /**
+         * Set the current slider value.
+         * Pass 'false' to 'fireChange' to skip the 'onChange' and 'onMove' callbacks.
+         */
+        (behavior: 'set value', value: number, fireChange: boolean): void;
+
+        /**
+         * Set the current range slider values.
+         * Pass 'false' to 'fireChange' to skip the 'onChange' and 'onMove' callbacks.
+         */
+        (behavior: 'set rangeValue', fromValue: number, toValue: number, fireChange: boolean): JQuery;
+
+        /**
+         * Destroys instance and removes all events.
+         */
+        (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: SliderSettings[K]): JQuery;
+        (behavior: 'setting', value: Partial<Pick<SliderSettings, keyof SliderSettings>>): JQuery;
+        (settings?: Partial<Pick<SliderSettings, keyof SliderSettings>>): JQuery;
+    }
+
+    /**
+     * @see {@link https://fomantic-ui.com/modules/slider.html#/settings}
+     */
+    interface SliderSettings {
+        // region Slider Settings
+
+        /**
+         * The lowest value the slider can be.
+         * @default 0
+         */
+        min: number;
+
+        /**
+         * The max value the slider can be.
+         * @default 20
+         */
+        max: number;
+
+        /**
+         * The slider step.
+         * Set to '0' to disable step.
+         * @default 1
+         */
+        step: number;
+
+        /**
+         * The value the slider will start at.
+         * @default 0
+         */
+        start: number;
+
+        /**
+         * The second value to set in case of a range slider.
+         * @default 20
+         */
+        end: number;
+
+        /**
+         * The type of label to display for a labeled slider.
+         * Can be 'number' or 'letter'.
+         * @default 'number'
+         */
+        labelType: 'number' | 'letter';
+
+        /**
+         * 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;
+
+        /**
+         * Show ticks on a labeled slider.
+         * @default false
+         */
+        showLabelTicks: boolean;
+
+        /**
+         * Define smoothness when the slider is moving.
+         * @default false
+         */
+        smooth: boolean;
+
+        /**
+         * Whether labels should auto adjust on window resize.
+         * @default true
+         */
+        autoAdjustLabels: boolean;
+
+        /**
+         * The distance between labels.
+         * @default 100
+         */
+        labelDistance: number;
+
+        /**
+         * Number of decimals to use with an unstepped slider.
+         * @default 2
+         */
+        decimalPlaces: number;
+
+        /**
+         * Page up/down multiplier.
+         * Define how many more times the steps to take on page up/down press.
+         * @default 2
+         */
+        pageMultiplier: number;
+
+        /**
+         * Prevents the lower thumb to crossover the thumb handle.
+         * @default true
+         */
+        preventCrossover: boolean;
+
+        // endregion
+
+        // region Callbacks
+
+        /**
+         * Is called when the slider value is changed.
+         */
+        onChange(this: JQuery, value: number, thumbVal: number, secondThumbVal: number): void;
+
+        /**
+         * Is called when the slider is moving.
+         */
+        onMove(this: JQuery, value: number, thumbVal: number, secondThumbVal: number): void;
+
+        // endregion
+
+        // region DOM Settings
+
+        /**
+         * Class names used to determine element state.
+         */
+        className: Slider.ClassNameSettings;
+
+        /**
+         * DOM metadata used by module.
+         */
+        metadata: Slider.MetadataSettings;
+
+        /**
+         * Keys used by module.
+         */
+        keys: Slider.KeySettings;
+
+        // endregion
+
+        // region Debug Settings
+
+        /**
+         * Name used in log statements
+         * @default 'Slider'
+         */
+        name: string;
+
+        /**
+         * Event namespace. Makes sure module teardown does not effect other events attached to an element.
+         * @default 'slider'
+         */
+        namespace: string;
+
+        /**
+         * Silences all console output including error messages, regardless of other debug settings.
+         * @default false
+         */
+        silent: boolean;
+
+        /**
+         * 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: Slider.ErrorSettings;
+
+        // endregion
+    }
+
+    namespace Slider {
+        type ClassNameSettings = Partial<Pick<Settings.ClassNames, keyof Settings.ClassNames>>;
+        type MetadataSettings = Partial<Pick<Settings.Metadatas, keyof Settings.Metadatas>>;
+        type KeySettings = Partial<Pick<Settings.Keys, keyof Settings.Keys>>;
+        type ErrorSettings = Partial<Pick<Settings.Errors, keyof Settings.Errors>>;
+
+        namespace Settings {
+            interface ClassNames {
+                /**
+                 * @default 'reversed'
+                 */
+                reversed: string;
+
+                /**
+                 * @default 'disabled'
+                 */
+                disabled: string;
+
+                /**
+                 * @default 'labeled'
+                 */
+                labeled: string;
+
+                /**
+                 * @default 'ticked'
+                 */
+                ticked: string;
+
+                /**
+                 * @default 'vertical'
+                 */
+                vertical: string;
+
+                /**
+                 * @default 'range'
+                 */
+                range: string;
+
+                /**
+                 * @default 'smooth'
+                 */
+                smooth: string;
+            }
+
+            interface Metadatas {
+                /**
+                 * @default 'thumbVal'
+                 */
+                thumbVal: string;
+
+                /**
+                 * @default 'secondThumbVal'
+                 */
+                secondThumbVal: string;
+            }
+
+            interface Keys {
+                /**
+                 * @default 33
+                 */
+                pageUp: number;
+
+                /**
+                 * @default 34
+                 */
+                pageDown: number;
+
+                /**
+                 * @default 37
+                 */
+                leftArrow: number;
+
+                /**
+                 * @default 38
+                 */
+                upArrow: number;
+
+                /**
+                 * @default 39
+                 */
+                rightArrow: number;
+
+                /**
+                 * @default 40
+                 */
+                downArrow: number;
+            }
+
+            interface Errors {
+                /**
+                 * @default 'The method you called is not defined.'
+                 */
+                method: string;
+
+                /**
+                 * @default 'This slider is not a range slider.'
+                 */
+                notrange: string;
+            }
+        }
+    }
+}

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

@@ -0,0 +1,215 @@
+declare namespace FomanticUI {
+    interface Sticky {
+        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: StickySettings[K]): JQuery;
+        (behavior: 'setting', value: Partial<Pick<StickySettings, keyof StickySettings>>): JQuery;
+        (settings?: Partial<Pick<StickySettings, keyof StickySettings>>): JQuery;
+    }
+
+    /**
+     * @see {@link https://fomantic-ui.com/modules/sticky.html#/settings}
+     */
+    interface StickySettings {
+        // region Sticky Settings
+
+        /**
+         * Whether element should be "pushed" by the viewport, attaching to the bottom of the screen when scrolling up.
+         * @default false
+         */
+        pushing: boolean;
+
+        /**
+         * Sets size of fixed content to match its width before fixing to screen dynamically.
+         * This is used because fixed may display block or 100% width content differently than it appears before sticking.
+         * @default true
+         */
+        setSize: boolean;
+
+        /**
+         * Sticky container height will only be set if the difference between heights of container and context is larger than this jitter value.
+         * @default 5
+         */
+        jitter: number;
+
+        /**
+         * Whether any change in 'context' DOM should automatically refresh cached sticky positions.
+         * @default false
+         */
+        observeChanges: boolean;
+
+        /**
+         * Context which sticky element should stick to.
+         * @default false
+         */
+        context: boolean | string;
+
+        /**
+         * Context which sticky should attach 'onscroll' events.
+         * @default window
+         */
+        scrollContext: Window | string;
+
+        /**
+         * Offset in pixels from the top of the screen when fixing element to viewport.
+         * @default 0
+         */
+        offset: number;
+
+        /**
+         * Offset in pixels from the bottom of the screen when fixing element to viewport.
+         * @default 0
+         */
+        bottomOffset: number;
+
+        // endregion
+
+        // region Callbacks
+
+        /**
+         * Callback when element is repositioned from layout change.
+         */
+        onReposition(this: JQuery): void;
+
+        /**
+         * Callback when 'requestAnimationFrame' fires from scroll handler.
+         */
+        onScroll(this: JQuery): void;
+
+        /**
+         * Callback when element is fixed to page.
+         */
+        onStick(this: JQuery): void;
+
+        /**
+         * Callback when element is unfixed from page.
+         */
+        onUnstick(this: JQuery): void;
+
+        /**
+         * Callback when element is bound to top of parent container.
+         */
+        onTop(this: JQuery): void;
+
+        /**
+         * Callback when element is bound to bottom of parent container.
+         */
+        onBottom(this: JQuery): void;
+
+        // endregion
+
+        // region DOM Settings
+
+        /**
+         * Class names used to determine element state.
+         */
+        className: Sticky.ClassNameSettings;
+
+        // endregion
+
+        // region Debug Settings
+
+        /**
+         * Name used in log statements
+         * @default 'Sticky'
+         */
+        name: string;
+
+        /**
+         * Event namespace. Makes sure module teardown does not effect other events attached to an element.
+         * @default 'sticky'
+         */
+        namespace: string;
+
+        /**
+         * Silences all console output including error messages, regardless of other debug settings.
+         * @default false
+         */
+        silent: boolean;
+
+        /**
+         * 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: Sticky.ErrorSettings;
+
+        // endregion
+    }
+
+    namespace Sticky {
+        type ClassNameSettings = Partial<Pick<Settings.ClassNames, keyof Settings.ClassNames>>;
+        type ErrorSettings = Partial<Pick<Settings.Errors, keyof Settings.Errors>>;
+
+        namespace Settings {
+            interface ClassNames {
+                /**
+                 * @default 'bound'
+                 */
+                bound: string;
+
+                /**
+                 * @default 'fixed'
+                 */
+                fixed: string;
+
+                /**
+                 * @default 'native'
+                 */
+                supported: string;
+
+                /**
+                 * @default 'top'
+                 */
+                top: string;
+
+                /**
+                 * @default 'bottom'
+                 */
+                bottom: string;
+            }
+
+            interface Errors {
+                /**
+                 * @default 'Sticky element must be inside a relative container'
+                 */
+                container: string;
+
+                /**
+                 * @default 'Element is hidden, you must call refresh after element becomes visible'
+                 */
+                visible: string;
+
+                /**
+                 * @default 'The method you called is not defined.'
+                 */
+                method: string;
+
+                /**
+                 * @default 'Context specified does not exist'
+                 */
+                invalidContext: string;
+
+                /**
+                 * @default 'Sticky element is larger than its container, cannot create sticky.'
+                 */
+                elementSize: string;
+            }
+        }
+    }
+}