fomantic-ui 2.9.3-beta.9 → 2.9.4-beta.0

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

@@ -0,0 +1,355 @@
+declare namespace FomanticUI {
+    interface Transition {
+        settings: TransitionSettings;
+
+        /**
+         * Stop current animation and preserve queue.
+         */
+        (behavior: 'stop'): JQuery;
+
+        /**
+         * Stop current animation and queued animations.
+         */
+        (behavior: 'stop all'): JQuery;
+
+        /**
+         * Clears all queued animations.
+         */
+        (behavior: 'clear queue'): JQuery;
+
+        /**
+         * Stop current animation and show element.
+         */
+        (behavior: 'show'): JQuery;
+
+        /**
+         * Stop current animation and hide element.
+         */
+        (behavior: 'hide'): JQuery;
+
+        /**
+         * Toggles between hide and show.
+         */
+        (behavior: 'toggle'): JQuery;
+
+        /**
+         * Forces reflow using a more expensive but stable method.
+         */
+        (behavior: 'force repaint'): JQuery;
+
+        /**
+         * Triggers reflow on element.
+         */
+        (behavior: 'repaint'): JQuery;
+
+        /**
+         * Resets all conditions changes during transition.
+         */
+        (behavior: 'reset'): JQuery;
+
+        /**
+         * Enables animation looping.
+         */
+        (behavior: 'looping'): JQuery;
+
+        /**
+         * Removes looping state from element.
+         */
+        (behavior: 'remove looping'): JQuery;
+
+        /**
+         * Adds disabled state (stops ability to animate).
+         */
+        (behavior: 'disable'): JQuery;
+
+        /**
+         * Removes disabled state.
+         */
+        (behavior: 'enable'): JQuery;
+
+        /**
+         * Modifies element animation duration.
+         */
+        (behavior: 'set duration', duration: number): JQuery;
+
+        /**
+         * Saves all class names and styles to cache to be retrieved after animation.
+         */
+        (behavior: 'save conditions'): JQuery;
+
+        /**
+         * Adds back cached names and styles to element.
+         */
+        (behavior: 'restore conditions'): JQuery;
+
+        /**
+         * Returns vendor prefixed animation property for animationname.
+         */
+        (behavior: 'get animation name'): string;
+
+        /**
+         * Returns vendor prefixed animation property for animationend.
+         */
+        (behavior: 'get animation event'): string;
+
+        /**
+         * Returns whether element is currently visible.
+         */
+        (behavior: 'is visible'): boolean;
+
+        /**
+         * Returns whether transition is currently occurring.
+         */
+        (behavior: 'is animating'): boolean;
+
+        /**
+         * Returns whether animation looping is set.
+         */
+        (behavior: 'is looping'): boolean;
+
+        /**
+         * Returns whether animations are supported.
+         */
+        (behavior: 'is supported'): boolean;
+
+        /**
+         * 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: TransitionSettings[K]): JQuery;
+        (behavior: 'setting', value: Partial<Pick<TransitionSettings, keyof TransitionSettings>>): JQuery;
+        (settings?: Partial<Pick<TransitionSettings, keyof TransitionSettings>>): JQuery;
+    }
+
+    /**
+     * @see {@link https://fomantic-ui.com/modules/transition.html#/settings}
+     */
+    interface TransitionSettings {
+        // region Transition Settings
+
+        /**
+         * Named animation event to used.
+         * Must be defined in CSS.
+         * @default 'fade'
+         */
+        animation: string;
+
+        /**
+         * Interval in MS between each elements transition.
+         * @default 0
+         */
+        interval: number;
+
+        /**
+         * When an interval is specified, sets order of animations. 'auto' reverses only animations that are hiding.
+         * @default 'auto'
+         */
+        reverse: string | boolean;
+
+        /**
+         * Specify the final display type (block, inline-block etc) so that it doesn't have to be calculated.
+         * @default false
+         */
+        displayType: false | string;
+
+        /**
+         * Specify the final display type (block, inline-block etc) so that it doesn't have to be calculated.
+         * @default '500ms'
+         */
+        duration: string;
+
+        /**
+         * If enabled a 'timeout' will be added to ensure 'animationend' callback occurs even if element is hidden.
+         * @default true
+         */
+        useFailSafe: boolean;
+
+        /**
+         * If enabled will allow same animation to be queued while it is already occurring.
+         * @default false
+         */
+        allowRepeats: boolean;
+
+        /**
+         * Whether to automatically queue animation if another is occurring.
+         * @default true
+         */
+        queue: boolean;
+
+        /**
+         * Whether initially inline hidden objects should be skipped for transition.
+         * Useful, if you do the transition for child objects also, but want to have inline hidden children (defined by style="display:none;") still kept hidden while the parent gets animated.
+         * Accordion uses this.
+         * @default false
+         */
+        skipInlineHidden: boolean;
+
+        // endregion
+
+        // region Callbacks
+
+        /**
+         * Callback on each transition that changes visibility to shown.
+         * Returning 'false' from this callback will cancel the transition from showing.
+         */
+        onShow(this: JQuery): boolean;
+
+        /**
+         * Callback right before the show transition should start.
+         * The 'showFunction' parameter has to be called inside the callback to trigger the transition show
+         */
+        onBeforeShow(this: JQuery, showFunction: Function): void;
+
+        /**
+         * Callback once the show transition has finished.
+         */
+        onVisible(this: JQuery): void;
+
+        /**
+         * Callback on each transition that changes visibility to hidden.
+         * Returning 'false' from this callback will cancel the transition from hiding.
+         */
+        onHide(this: JQuery): boolean;
+
+        /**
+         * Callback right before the hide transition should start.
+         * The 'hideFunction' parameter has to be called inside the callback to trigger the transition hide.
+         */
+        onBeforeHide(this: JQuery, hideFunction: Function): void;
+
+        /**
+         * Callback once the transition hide has finished.
+         */
+        onHidden(this: JQuery): void;
+
+        /**
+         * Callback on animation start, useful for queued animations.
+         */
+        onStart(this: JQuery): void;
+
+        /**
+         * Callback on each transition complete.
+         */
+        onComplete(this: JQuery): void;
+
+        // endregion
+
+        // region DOM Settings
+
+        /**
+         * Class names used to determine element state.
+         */
+        className: Transition.ClassNameSettings;
+
+        // endregion
+
+        // region Debug Settings
+
+        /**
+         * Name used in log statements
+         * @default 'Transition'
+         */
+        name: string;
+
+        /**
+         * Event namespace. Makes sure module teardown does not effect other events attached to an element.
+         * @default 'transition'
+         */
+        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;
+
+        errors: Transition.ErrorSettings;
+
+        // endregion
+    }
+
+    namespace Transition {
+        type ClassNameSettings = Partial<Pick<Settings.ClassNames, keyof Settings.ClassNames>>;
+        type ErrorSettings = Partial<Pick<Settings.Errors, keyof Settings.Errors>>;
+
+        namespace Settings {
+            interface ClassNames {
+                /**
+                 * @default 'animating'
+                 */
+                animating: string;
+
+                /**
+                 * @default 'disabled'
+                 */
+                disabled: string;
+
+                /**
+                 * @default 'hidden'
+                 */
+                hidden: string;
+
+                /**
+                 * @default 'in'
+                 */
+                inward: string;
+
+                /**
+                 * @default 'loading'
+                 */
+                loading: string;
+
+                /**
+                 * @default 'looping'
+                 */
+                looping: string;
+
+                /**
+                 * @default 'out'
+                 */
+                outward: string;
+
+                /**
+                 * @default 'transition'
+                 */
+                transition: string;
+
+                /**
+                 * @default 'visible'
+                 */
+                visible: string;
+            }
+
+            interface Errors {
+                /**
+                 * @default 'You called a rating action that was not defined'
+                 */
+                noAnimation: string;
+
+                /**
+                 * @default 'The method you called is not defined'
+                 */
+                method: string;
+            }
+        }
+    }
+}

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

@@ -0,0 +1,355 @@
+declare namespace FomanticUI {
+    interface Visibility {
+        settings: VisibilitySettings;
+
+        /**
+         * Disable callbacks temporarily.
+         * This is useful if you need to adjust scroll position and do not want to trigger callbacks during the position change.
+         */
+        (behavior: 'disable callbacks'): JQuery;
+
+        /**
+         * Re-enable callbacks.
+         */
+        (behavior: 'enable callbacks'): JQuery;
+
+        /**
+         * Returns whether element is on screen.
+         */
+        (behavior: 'is on screen'): boolean;
+
+        /**
+         * Returns whether element is off screen.
+         */
+        (behavior: 'is off screen'): boolean;
+
+        /**
+         * Returns number of pixels passed in current element from top of element.
+         */
+        (behavior: 'get pixels passed'): number;
+
+        /**
+         * Returns element calculations as object.
+         */
+        (behavior: 'get element calculations'): object;
+
+        /**
+         * Returns screen calculations as object.
+         */
+        (behavior: 'get screen calculations'): object;
+
+        /**
+         * Returns screen size as object.
+         */
+        (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: VisibilitySettings[K]): JQuery;
+        (behavior: 'setting', value: VisibilitySettings): JQuery;
+        (settings?: VisibilitySettings): JQuery;
+    }
+
+    /**
+     * @see {@link https://fomantic-ui.com/behaviors/visibility.html#/settings}
+     */
+    interface VisibilitySettings {
+        // region Visibility Settings
+
+        /**
+         * When set to 'false' a callback will occur each time an element passes the threshold for a condition.
+         * @default true
+         */
+        once: boolean;
+
+        /**
+         * When set to 'true' a callback will occur anytime an element passes a condition not just immediately after the threshold is met.
+         * @default false
+         */
+        continuous: boolean;
+
+        /**
+         * Set to 'image' to load images when on screen. Set to 'fixed' to add class name 'fixed' when passed.
+         * @default false
+         */
+        type: false | 'image' | 'fixed';
+
+        /**
+         * Whether visibility conditions should be checked immediately on init.
+         * @default true
+         */
+        initialCheck: boolean;
+
+        /**
+         * The scroll context visibility should use.
+         * @default window
+         */
+        context: Window | string | JQuery;
+
+        /**
+         * Whether visibility conditions should be checked on window load.
+         * This ensures that after images load content positions will be updated correctly.
+         * @default true
+         */
+        refreshOnLoad: boolean;
+
+        /**
+         * Whether visibility conditions should be checked on window resize.
+         * Useful when content resizes causes continuous changes in position.
+         * @default true
+         */
+        refreshOnResize: boolean;
+
+        /**
+         * Whether visibility conditions should be checked on calls to refresh.
+         * These calls can be triggered from either resize, load or manually calling.
+         * @default true
+         */
+        checkOnRefresh: boolean;
+
+        /**
+         * Specify a z-index when using type: 'fixed'.
+         * @default 10
+         */
+        zIndex: number;
+
+        /**
+         * Value that context 'scrollTop' should be adjusted in pixels.
+         * Useful for making content appear below content fixed to the page.
+         * @default 0
+         */
+        offset: number;
+
+        /**
+         * Whether element calculations should include its margin.
+         * @default false
+         */
+        includeMargin: boolean;
+
+        /**
+         * When set to an 'integer', scroll position will be debounced using this ms value.
+         * 'false' will debounce with requestAnimationFrame.
+         * @default false
+         */
+        throttle: boolean | number;
+
+        /**
+         * Whether to automatically refresh content when changes are made to the element's DOM subtree.
+         * @default true
+         */
+        observeChanges: boolean;
+
+        /**
+         * When using type: image allows you to specify transition when showing a loaded image.
+         * @default false
+         */
+        transition: false | string;
+
+        /**
+         * When using type: image allows you to specify transition duration.
+         * @default 1000
+         */
+        duration: number;
+
+        // endregion
+
+        // region Callbacks
+
+        /**
+         * Any part of element is in current scroll viewport.
+         */
+        onOnScreen(this: JQuery): void;
+
+        /**
+         * No part of element is in current scroll viewport.
+         */
+        onOffScreen(this: JQuery): void;
+
+        /**
+         * No part of element is in current scroll viewport.
+         */
+        onOffScreen(this: JQuery): void;
+
+        /**
+         * Element's top edge has passed bottom of screen.
+         */
+        onTopVisible(this: JQuery): void;
+
+        /**
+         * Element's top edge has passed top of the screen.
+         */
+        onTopPassed(this: JQuery): void;
+
+        /**
+         * Element's bottom edge has passed bottom of screen.
+         */
+        onBottomVisible(this: JQuery): void;
+
+        /**
+         * Any part of an element is visible on screen.
+         */
+        onPassing(this: JQuery): void;
+
+        /**
+         * Element's bottom edge has passed top of screen.
+         */
+        onBottomPassed(this: JQuery): void;
+
+        /**
+         * Element's top edge has not passed bottom of screen.
+         */
+        onTopVisibleReverse(this: JQuery): void;
+
+        /**
+         * Element's top edge has not passed top of the screen.
+         */
+        onTopPassedReverse(this: JQuery): void;
+
+        /**
+         * Element's bottom edge has not passed bottom of screen.
+         */
+        onBottomVisibleReverse(this: JQuery): void;
+
+        /**
+         * Element's top has not passed top of screen but bottom has.
+         */
+        onPassingReverse(this: JQuery): void;
+
+        /**
+         * Element's bottom edge has not passed top of screen.
+         */
+        onBottomPassedReverse(this: JQuery): void;
+
+        /**
+         * Occurs after an image has completed loading.
+         */
+        onLoad(this: JQuery): void;
+
+        /**
+         * Occurs after all 'img' initialized at the same time have loaded.
+         */
+        onAllLoaded(this: JQuery): void;
+
+        /**
+         * Occurs after element has been assigned position fixed.
+         */
+        onFixed(this: JQuery): void;
+
+        /**
+         * Occurs after element has been removed from fixed position.
+         */
+        onUnfixed(this: JQuery): void;
+
+        /**
+         * Occurs each time an elements calculations are updated.
+         */
+        onUpdate(this: JQuery, calculations: object): void;
+
+        /**
+         * Occurs whenever element's visibility is refreshed.
+         */
+        onRefresh(this: JQuery, calculations: object): void;
+
+        // endregion
+
+        // region DOM Settings
+
+        /**
+         * Metadata used internally.
+         */
+        metadata: Visibility.MetadataSettings;
+
+        /**
+         * Class names used to determine element state.
+         */
+        className: Visibility.ClassNameSettings;
+
+        // endregion
+
+        // region Debug Settings
+
+        /**
+         * Name used in log statements
+         * @default 'Visibility'
+         */
+        name: string;
+
+        /**
+         * Event namespace. Makes sure module teardown does not effect other events attached to an element.
+         * @default 'visibility'
+         */
+        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: Visibility.ErrorSettings;
+
+        // endregion
+    }
+
+    namespace Visibility {
+        type ClassNameSettings = Partial<Pick<Settings.ClassNames, keyof Settings.ClassNames>>;
+        type MetadataSettings = Partial<Pick<Settings.Metadatas, keyof Settings.Metadatas>>;
+        type ErrorSettings = Partial<Pick<Settings.Errors, keyof Settings.Errors>>;
+
+        namespace Settings {
+            interface Metadatas {
+                /**
+                 * @default 'src'
+                 */
+                src: string;
+            }
+
+            interface ClassNames {
+                /**
+                 * @default 'fixed'
+                 */
+                fixed: string;
+
+                /**
+                 * @default 'constraint'
+                 */
+                placeholder: string;
+
+                /**
+                 * @default 'visible'
+                 */
+                visible: string;
+            }
+
+            interface Errors {
+                /**
+                 * @default 'The method you called is not defined.'
+                 */
+                method: string;
+
+                /**
+                 * @default 'Element is hidden, you must call refresh after element becomes visible'
+                 */
+                visible: string;
+            }
+        }
+    }
+}