fomantic-ui 2.9.3-beta.46 → 2.9.3-beta.47

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

@@ -49,254 +49,271 @@ declare namespace FomanticUI {
         (behavior: 'get settings'): FlyoutSettings;
 
         (behavior: 'destroy'): JQuery;
-        <K extends keyof FlyoutSettings>(behavior: 'setting', name: K, value?: undefined): FlyoutSettings._Impl[K];
-        <K extends keyof FlyoutSettings>(behavior: 'setting', name: K, value: FlyoutSettings._Impl[K]): JQuery;
-        (behavior: 'setting', value: FlyoutSettings): JQuery;
-        (settings?: FlyoutSettings): 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: FlyoutSettings[K]): JQuery;
+        (behavior: 'setting', value: Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>): JQuery;
+        (settings?: Partial<Pick<FlyoutSettings, keyof FlyoutSettings>>): JQuery;
     }
 
     /**
      * @see {@link https://fomantic-ui.com/modules/flyout.html#/settings}
      */
-    type FlyoutSettings = FlyoutSettings.Param;
-
-    namespace FlyoutSettings {
-        type Param = (
-            | Pick<_Impl, 'context'>
-            | Pick<_Impl, 'exclusive'>
-            | Pick<_Impl, 'closable'>
-            | Pick<_Impl, 'dimPage'>
-            | Pick<_Impl, 'blurring'>
-            | Pick<_Impl, 'autofocus'>
-            | Pick<_Impl, 'restoreFocus'>
-            | Pick<_Impl, 'keyboardShortcuts'>
-            | Pick<_Impl, 'scrollLock'>
-            | Pick<_Impl, 'returnScroll'>
-            | Pick<_Impl, 'delaySetup'>
-            | Pick<_Impl, 'autoShow'>
-            | Pick<_Impl, 'onChange'>
-            | Pick<_Impl, 'onShow'>
-            | Pick<_Impl, 'onHide'>
-            | Pick<_Impl, 'onVisible'>
-            | Pick<_Impl, 'onHidden'>
-            | Pick<_Impl, 'onApprove'>
-            | Pick<_Impl, 'onDeny'>
-            | Pick<_Impl, 'selector'>
-            | Pick<_Impl, 'className'>
-            | Pick<_Impl, 'regExp'>
-            | 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 Accordion Settings
-
-            /**
-             * Selector or jquery object specifying the area to dim.
-             * @default 'body'
-             */
-            context: string | JQuery;
-
-            /**
-             * Opening another flyout will dismiss the one displayed.
-             * Set to 'true' to allow multiple flyout at the same time.
-             * @default false
-             */
-            exclusive: boolean;
-
-            /**
-             * Setting to 'false' will not allow you to close the flyout by clicking on the dimmer.
-             * @default true
-             */
-            closable: boolean;
-
-            /**
-             * Whether to dim 'context' contents when flyout is visible.
-             * @default true
-             */
-            dimPage: boolean;
-
-            /**
-             * If dimmer should blur background.
-             * @default false
-             */
-            blurring: boolean;
-
-            /**
-             * When 'true', the first form input inside the flyout will receive focus when shown.
-             * Set this to 'false' to prevent this behavior.
-             * @default true
-             */
-            autofocus: boolean;
-
-            /**
-             * When 'false', the last focused element, before the flyout was shown, will not get refocused again when the flyout hides.
-             * This could prevent unwanted scrolling behaviors after closing a flyout.
-             * @default true
-             */
-            keyboardShortcuts: boolean;
-
-            /**
-             * Whether to automatically bind keyboard shortcuts.
-             * This will close the flyout when the 'ESC-key' is pressed.
-             * @default true
-             */
-            restoreFocus: boolean;
-
-            /**
-             * Whether to lock page scroll when flyout is visible.
-             * @default false
-             */
-            scrollLock: boolean;
-
-            /**
-             * Whether to return to original scroll position when flyout is hidden.
-             * @default false
-             */
-            returnScroll: boolean;
-
-            /**
-             * When flyout is initialized without the proper HTML, using this option will defer creation of DOM to use 'requestAnimationFrame'.
-             * @default false
-             */
-            delaySetup: boolean;
-
-            /**
-             * When 'true', immediately shows the flyout at instantiation time.
-             * @default false
-             */
-            autoShow: boolean;
-
-            // endregion
-
-            // region Callbacks
-
-            /**
-             * Is called when a flyout is either shown or hidden.
-             */
-            onChange(this: JQuery): void;
-
-            /**
-             * Is called when a flyout starts to show.
-             */
-            onShow(this: JQuery): void;
-
-            /**
-             * Is called after a flyout starts to hide.
-             */
-            onHide(this: JQuery): void;
-
-            /**
-             * Is called after a flyout has finished showing animating.
-             */
-            onVisible(this: JQuery): void;
-
-            /**
-             * Is called after a flyout has finished hiding animation.
-             */
-            onHidden(this: JQuery): void;
-
-            /**
-             * Is called after a positive, approve or ok button is pressed.
-             * If the function returns 'false', the flyout will not hide.
-             */
-            onApprove(this: JQuery): void;
-
-            /**
-             * Is called after a negative, deny or cancel button is pressed.
-             * If the function 'returns' false, the flyout will not hide.
-             */
-            onDeny(this: JQuery): void;
-
-            // endregion
-
-            // region DOM Settings
-
-            /**
-             * DOM Selectors used internally.
-             * Selectors used to find parts of a module.
-             */
-            selector: Flyout.SelectorSettings;
-
-            /**
-             * Class names used to determine element state.
-             */
-            className: Flyout.ClassNameSettings;
-
-            /**
-             *
-             */
-            regExp: Flyout.RegExpSettings;
-
-            // endregion
-
-            // region Config Template Settings
-
-            // 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;
+    interface FlyoutSettings {
+        // region Accordion Settings
 
-            /**
-             * Debug output includes all internal behaviors
-             */
-            verbose: boolean;
+        /**
+         * Selector or jquery object specifying the area to dim.
+         * @default 'body'
+         */
+        context: string | JQuery;
 
-            error: Flyout.ErrorSettings;
+        /**
+         * Opening another flyout will dismiss the one displayed.
+         * Set to 'true' to allow multiple flyout at the same time.
+         * @default false
+         */
+        exclusive: boolean;
 
-            // endregion
-        }
+        /**
+         * Setting to 'false' will not allow you to close the flyout by clicking on the dimmer.
+         * @default true
+         */
+        closable: boolean;
+
+        /**
+         * Whether to dim 'context' contents when flyout is visible.
+         * @default true
+         */
+        dimPage: boolean;
+
+        /**
+         * If dimmer should blur background.
+         * @default false
+         */
+        blurring: boolean;
+
+        /**
+         * When 'true', the first form input inside the flyout will receive focus when shown.
+         * Set this to 'false' to prevent this behavior.
+         * @default true
+         */
+        autofocus: boolean;
+
+        /**
+         * When 'false', the last focused element, before the flyout was shown, will not get refocused again when the flyout hides.
+         * This could prevent unwanted scrolling behaviors after closing a flyout.
+         * @default true
+         */
+        keyboardShortcuts: boolean;
+
+        /**
+         * Whether to automatically bind keyboard shortcuts.
+         * This will close the flyout when the 'ESC-key' is pressed.
+         * @default true
+         */
+        restoreFocus: boolean;
+
+        /**
+         * Whether to lock page scroll when flyout is visible.
+         * @default false
+         */
+        scrollLock: boolean;
+
+        /**
+         * Whether to return to original scroll position when flyout is hidden.
+         * @default false
+         */
+        returnScroll: boolean;
+
+        /**
+         * When flyout is initialized without the proper HTML, using this option will defer creation of DOM to use 'requestAnimationFrame'.
+         * @default false
+         */
+        delaySetup: boolean;
+
+        /**
+         * When 'true', immediately shows the flyout at instantiation time.
+         * @default false
+         */
+        autoShow: boolean;
+
+        // endregion
+
+        // region Config Template Settings
+
+        /**
+         * Content of the flyout header.
+         * @default ''
+         */
+        title: boolean;
+
+        /**
+         * Content of the flyout content.
+         * @default ''
+         */
+        content: boolean;
+
+        /**
+         * Can hold a string to be added to the flyout class to control its appearance.
+         * @default ''
+         */
+        class: boolean;
+
+        /**
+         * Can hold a string to be added to the title class to control its appearance.
+         * @default ''
+         */
+        classTitle: boolean;
+
+        /**
+         * Can hold a string to be added to the content class to control its appearance.
+         * @default ''
+         */
+        classContent: boolean;
+
+        /**
+         * Can hold a string to be added to the actions class to control its appearance.
+         * @default ''
+         */
+        classActions: boolean;
+
+        /**
+         * Can hold a string to be added to the actions class to control its appearance.
+         * @default false
+         */
+        closeIcon: boolean;
+
+        /**
+         * An array of objects. Each object defines an action with properties `text`, `class`, `icon` and `click`.
+         * @default false
+         */
+        actions: false | object[];
+
+        /**
+         * Whether HTML included in given title, content or actions should be preserved.
+         * Set to `false` in case you work with untrusted 3rd party content.
+         * @default true
+         */
+        preserveHTML: boolean;
+
+        // endregion
+
+        // region Callbacks
+
+        /**
+         * Is called when a flyout is either shown or hidden.
+         */
+        onChange(this: JQuery): void;
+
+        /**
+         * Is called when a flyout starts to show.
+         */
+        onShow(this: JQuery): void;
+
+        /**
+         * Is called after a flyout starts to hide.
+         */
+        onHide(this: JQuery): void;
+
+        /**
+         * Is called after a flyout has finished showing animating.
+         */
+        onVisible(this: JQuery): void;
+
+        /**
+         * Is called after a flyout has finished hiding animation.
+         */
+        onHidden(this: JQuery): void;
+
+        /**
+         * Is called after a positive, approve or ok button is pressed.
+         * If the function returns 'false', the flyout will not hide.
+         */
+        onApprove(this: JQuery): void;
+
+        /**
+         * Is called after a negative, deny or cancel button is pressed.
+         * If the function 'returns' false, the flyout will not hide.
+         */
+        onDeny(this: JQuery): void;
+
+        // endregion
+
+        // region DOM Settings
+
+        /**
+         * DOM Selectors used internally.
+         * Selectors used to find parts of a module.
+         */
+        selector: Flyout.SelectorSettings;
+
+        /**
+         * Class names used to determine element state.
+         */
+        className: Flyout.ClassNameSettings;
+
+        /**
+         *
+         */
+        regExp: Flyout.RegExpSettings;
+
+        // endregion
+
+        // region Config Template Settings
+
+        // endregion
+
+        // region Debug Settings
+
+        /**
+         * Name used in log statements
+         * @default 'Flyout'
+         */
+        name: string;
+
+        /**
+         * Event namespace. Makes sure module teardown does not effect other events attached to an element.
+         * @default 'flyout'
+         */
+        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: Flyout.ErrorSettings;
+
+        // endregion
     }
 
     namespace Flyout {
-        type SelectorSettings = SelectorSettings.Param;
-
-        namespace SelectorSettings {
-            type Param = (
-                | Pick<_Impl, 'fixed'>
-                | Pick<_Impl, 'omitted'>
-                | Pick<_Impl, 'pusher'>
-                | Pick<_Impl, 'flyout'>
-                | Pick<_Impl, 'header'>
-                | Pick<_Impl, 'content'>
-                | Pick<_Impl, 'actions'>
-                | Pick<_Impl, 'close'>
-                | Pick<_Impl, 'approve'>
-                | Pick<_Impl, 'deny'>
-            ) &
-                Partial<Pick<_Impl, keyof _Impl>>;
-
-            interface _Impl {
+        type SelectorSettings = Partial<Pick<Settings.Selectors, keyof Settings.Selectors>>;
+        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>>;
+
+        namespace Settings {
+            interface Selectors {
                 /**
                  * @default '.fixed'
                  */
@@ -347,39 +364,8 @@ declare namespace FomanticUI {
                  */
                 deny: string;
             }
-        }
-
-        type ClassNameSettings = ClassNameSettings.Param;
-
-        namespace ClassNameSettings {
-            type Param = (
-                | Pick<_Impl, 'flyout'>
-                | Pick<_Impl, 'close'>
-                | Pick<_Impl, 'header'>
-                | Pick<_Impl, 'content'>
-                | Pick<_Impl, 'actions'>
-                | Pick<_Impl, 'active'>
-                | Pick<_Impl, 'animating'>
-                | Pick<_Impl, 'dimmed'>
-                | Pick<_Impl, 'ios'>
-                | Pick<_Impl, 'pushable'>
-                | Pick<_Impl, 'pushed'>
-                | Pick<_Impl, 'right'>
-                | Pick<_Impl, 'top'>
-                | Pick<_Impl, 'left'>
-                | Pick<_Impl, 'bottom'>
-                | Pick<_Impl, 'visible'>
-                | Pick<_Impl, 'overlay'>
-                | Pick<_Impl, 'fullscreen'>
-                | Pick<_Impl, 'template'>
-                | Pick<_Impl, 'button'>
-                | Pick<_Impl, 'ok'>
-                | Pick<_Impl, 'cancel'>
-                | Pick<_Impl, 'prompt'>
-            ) &
-                Partial<Pick<_Impl, keyof _Impl>>;
-
-            interface _Impl {
+            
+            interface ClassNames {
                 /**
                  * @default 'ui flyout'
                  */
@@ -495,15 +481,8 @@ declare namespace FomanticUI {
                  */
                 prompt: string;
             }
-        }
-
-        type RegExpSettings = RegExpSettings.Param;
-
-        namespace RegExpSettings {
-            type Param = (Pick<_Impl, 'ios'> | Pick<_Impl, 'mobileChrome'> | Pick<_Impl, 'mobile'>) &
-                Partial<Pick<_Impl, keyof _Impl>>;
-
-            interface _Impl {
+        
+            interface RegExps {
                 /**
                  * @default /(iPad|iPhone|iPod)/g
                  */
@@ -519,20 +498,8 @@ declare namespace FomanticUI {
                  */
                 mobile: RegExp;
             }
-        }
-
-        type ErrorSettings = ErrorSettings.Param;
-
-        namespace ErrorSettings {
-            type Param = (
-                | Pick<_Impl, 'method'>
-                | Pick<_Impl, 'pusher'>
-                | Pick<_Impl, 'movedFlyout'>
-                | Pick<_Impl, 'notFound'>
-            ) &
-                Partial<Pick<_Impl, keyof _Impl>>;
 
-            interface _Impl {
+            interface Errors {
                 /**
                  * @default 'The method you called is not defined.'
                  */