@types/jquery.fullscreen

Installation

npm install --save @types/jquery.fullscreen

Summary

This package contains type definitions for jquery.fullscreen (https://github.com/private-face/jquery.fullscreen).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery.fullscreen.

index.d.ts

/// <reference types="jquery"/>

/**
 * Extends jQuery interface
 * i.e: To use $elem.fullscreen()
 */
interface JQuery {
    fullscreen(options?: Object): void;
}

/**
 * Interface for the jquery plugin
 */
interface JQueryFullscreen {
    /**
     * [open Activate fullscreen mode in a specific element through static method]
     * @param {Element} element [description]
     * @param {Object}  options [description]
     */
    open(element: Element, options?: Object): void;

    /**
     * [close Deactivate fullscreen mode]
     * TODO: have to check for params
     */
    close(): void;

    /**
     * [isFullScreen Get fullscreen status]
     * @return {boolean} [description]
     */
    isFullScreen(): boolean;

    /**
     * [isNativelySupported Check if fullscreen is supported by the browser]
     * @return {boolean} [description]
     */
    isNativelySupported(): boolean;

    /**
     * [exit Deactivate and destroy all fullscreen instances]
     */
    exit(): void;
}

/**
 * Extends JqueryStatic ($)
 * i.e: To use $.fullscreen.functionName()
 */
interface JQueryStatic {
    fullscreen: JQueryFullscreen;
}

Additional Details

• Last updated: Tue, 07 Nov 2023 0337 GMT
• Dependencies: @types/jquery

Credits

These definitions were written by Piraveen Kamalathas.