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

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

@@ -0,0 +1,372 @@
+declare namespace FomanticUI {
+    interface Embed {
+        settings: EmbedSettings;
+
+        /**
+         * Changes iframe to a new content source.
+         */
+        (behavior: 'change', source: string, id: string, url: string): JQuery;
+
+        /**
+         * Removes embed and shows placeholder content if available.
+         */
+        (behavior: 'reset'): JQuery;
+
+        /**
+         * Shows embed content.
+         */
+        (behavior: 'show'): JQuery;
+
+        /**
+         * Hides embed content and shows placeholder content.
+         */
+        (behavior: 'hide'): JQuery;
+
+        /**
+         * Returns current content id.
+         */
+        (behavior: 'get id'): string;
+
+        /**
+         * Returns placeholder image url.
+         */
+        (behavior: 'get placeholder'): string;
+
+        /**
+         * Returns source name.
+         */
+        (behavior: 'get sources'): string;
+
+        /**
+         * Returns source type.
+         */
+        (behavior: 'get sources'): string;
+
+        /**
+         * Returns URL with all parameters added.
+         */
+        (behavior: 'get url'): string;
+
+        /**
+         * Returns whether embed content has placeholder.
+         */
+        (behavior: 'has placeholder'): boolean;
+
+        /**
+         * Destroys instance and removes all events.
+         */
+        (behavior: 'destroy'): JQuery;
+
+        <K extends keyof EmbedSettings>(behavior: 'setting', name: K, value?: undefined): EmbedSettings._Impl[K];
+        <K extends keyof EmbedSettings>(behavior: 'setting', name: K, value: EmbedSettings._Impl[K]): JQuery;
+        (behavior: 'setting', value: EmbedSettings): JQuery;
+        (settings?: EmbedSettings): JQuery;
+    }
+
+    /**
+     * @see {@link https://fomantic-ui.com/modules/embed.html#/settings}
+     */
+    type EmbedSettings = EmbedSettings.Param;
+
+    namespace EmbedSettings {
+        type Param = (
+            | Pick<_Impl, 'icon'>
+            | Pick<_Impl, 'source'>
+            | Pick<_Impl, 'url'>
+            | Pick<_Impl, 'id'>
+            | Pick<_Impl, 'parameters'>
+            | Pick<_Impl, 'autoplay'>
+            | Pick<_Impl, 'color'>
+            | Pick<_Impl, 'hd'>
+            | Pick<_Impl, 'brandedUI'>
+            | Pick<_Impl, 'onCreate'>
+            | Pick<_Impl, 'onDisplay'>
+            | Pick<_Impl, 'onPlaceholderDisplay'>
+            | Pick<_Impl, 'onEmbed'>
+            | Pick<_Impl, 'selector'>
+            | Pick<_Impl, 'metadata'>
+            | Pick<_Impl, 'className'>
+            | Pick<_Impl, 'templates'>
+            | 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 Embed Settings
+
+            /**
+             * Specifies an icon to use with placeholder content.
+             * @default false
+             */
+            icon: false | string;
+
+            /**
+             * Specifies a source to use, if no source is provided it will be determined from the domain of a specified url.
+             * @default false
+             */
+            source: false | string;
+
+            /**
+             * Specifies a url to use for embed.
+             * @default false
+             */
+            url: false | string;
+
+            /**
+             * Specifies an id value to replace with the '{id}' value found in templated urls.
+             * @default false
+             */
+            id: false | string;
+
+            /**
+             * Specify an object containing key/value pairs to add to the iframes GET parameters.
+             * @default false
+             */
+            parameters: false | object;
+
+            // endregion
+
+            // region Video Settings
+
+            /**
+             * Default setting 'auto' will only autoplay content when a placeholder is specified.
+             * Setting to 'true' or 'false' will force autoplay.
+             * @default 'auto'
+             */
+            autoplay: 'auto' | boolean;
+
+            /**
+             * Default setting 'auto' will only autoplay content when a placeholder is specified.
+             * Setting to 'true' or 'false' will force autoplay.
+             * @default '#444444'
+             */
+            color: string;
+
+            /**
+             * Whether to prefer HD content.
+             * @default true
+             */
+            hd: boolean;
+
+            /**
+             * Whether to show networks branded UI like title cards, or after video calls to action.
+             * @default false
+             */
+            brandedUI: boolean;
+
+            // endregion
+
+            // region Callbacks
+
+            /**
+             * Callback when iframe is generated.
+             */
+            onCreate(this: JQuery, url: string): void;
+
+            /**
+             * Whenever an iframe contents is shown.
+             */
+            onDisplay(this: JQuery): void;
+
+            /**
+             * Callback immediately before Embed is removed from DOM.
+             */
+            onPlaceholderDisplay(this: JQuery): void;
+
+            /**
+             * Callback when module parameters are determined.
+             * Allows you to adjust parameters at run time by returning a new parameters object.
+             */
+            onEmbed(this: JQuery, parameters: object): void;
+
+            // endregion
+
+            // region DOM Settings
+
+            /**
+             * DOM Selectors used internally.
+             * Selectors used to find parts of a module.
+             */
+            selector: Embed.SelectorSettings;
+
+            /**
+             * HTML Data attributes used to store data.
+             */
+            metadata: Embed.MetadataSettings;
+
+            /**
+             * Class names used to determine element state.
+             */
+            className: Embed.ClassNameSettings;
+
+            /**
+             *
+             */
+            templates: Embed.TemplateSettings;
+
+            // 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: Embed.ErrorSettings;
+
+            // endregion
+        }
+
+        namespace Embed {
+            type SelectorSettings = SelectorSettings.Param;
+
+            namespace SelectorSettings {
+                type Param = (Pick<_Impl, 'embed'> | Pick<_Impl, 'placeholder'> | Pick<_Impl, 'play'>) &
+                    Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default '.embed'
+                     */
+                    embed: string;
+
+                    /**
+                     * @default '.placeholder'
+                     */
+                    placeholder: string;
+
+                    /**
+                     * @default '.play'
+                     */
+                    play: string;
+                }
+            }
+
+            type MetadataSettings = MetadataSettings.Param;
+
+            namespace MetadataSettings {
+                type Param = (
+                    | Pick<_Impl, 'id'>
+                    | Pick<_Impl, 'icon'>
+                    | Pick<_Impl, 'placeholder'>
+                    | Pick<_Impl, 'source'>
+                    | Pick<_Impl, 'url'>
+                ) &
+                    Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default 'id'
+                     */
+                    id: string;
+
+                    /**
+                     * @default 'icon'
+                     */
+                    icon: string;
+
+                    /**
+                     * @default 'placeholder'
+                     */
+                    placeholder: string;
+
+                    /**
+                     * @default 'source'
+                     */
+                    source: string;
+
+                    /**
+                     * @default 'url'
+                     */
+                    url: string;
+                }
+            }
+
+            type ClassNameSettings = ClassNameSettings.Param;
+
+            namespace ClassNameSettings {
+                type Param = (Pick<_Impl, 'active'> | Pick<_Impl, 'embed'>) & Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default 'active'
+                     */
+                    active: string;
+
+                    /**
+                     * @default 'embed'
+                     */
+                    embed: string;
+                }
+            }
+
+            type TemplateSettings = TemplateSettings.Param;
+
+            namespace TemplateSettings {
+                type Param = (Pick<_Impl, 'iframe'> | Pick<_Impl, 'placeholder'>) & Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default function
+                     */
+                    iframe: Function;
+
+                    /**
+                     * @default function
+                     */
+                    placeholder: Function;
+                }
+            }
+
+            type ErrorSettings = ErrorSettings.Param;
+
+            namespace ErrorSettings {
+                type Param = (Pick<_Impl, 'noURL'> | Pick<_Impl, 'method'>) & Partial<Pick<_Impl, keyof _Impl>>;
+
+                interface _Impl {
+                    /**
+                     * @default 'No URL specified'
+                     */
+                    noURL: string;
+
+                    /**
+                     * @default 'The method you called is not defined'
+                     */
+                    method: string;
+                }
+            }
+        }
+    }
+}