@types/tether NPM

Installation

npm install --save @types/tether

Summary

This package contains type definitions for Tether (https://github.com/shipshapecode/tether).

Details

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

index.d.ts

// Type definitions for Tether v1.4
// Project: https://github.com/shipshapecode/tether
// Definitions by: Adi Dahiya <https://github.com/adidahiya>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

export = Tether;
export as namespace Tether;

// global Tether constructor
declare class Tether {
    constructor(options: Tether.ITetherOptions);

    public setOptions(options: Tether.ITetherOptions): void;
    public disable(): void;
    public enable(): void;
    public destroy(): void;
    public position(): void;

    public static position(): void;
}

declare namespace Tether {
    interface ITetherOptions {
        attachment: string;
        bodyElement?: HTMLElement | undefined;
        classes?: {[className: string]: boolean | string} | undefined;
        classPrefix?: string | undefined;
        constraints?: ITetherConstraint[] | undefined;
        element?: HTMLElement | string | any | undefined /* JQuery */;
        enabled?: boolean | undefined;
        offset?: string | undefined;
        optimizations?: any;
        target?: HTMLElement | string | any | undefined /* JQuery */;
        targetAttachment?: string | undefined;
        targetOffset?: string | undefined;
        targetModifier?: string | undefined;
    }

    interface ITetherConstraint {
        attachment?: string | undefined;
        outOfBoundsClass?: string | undefined;
        pin?: boolean | string[] | undefined;
        pinnedClass?: string | undefined;
        to?: string | HTMLElement | number[] | undefined;
    }
}