DefinitelyTyped/foundation-sites/index.d.ts

// Type definitions for Foundation Sites v6.1.1
// Project: http://foundation.zurb.com/
// Definitions by: Sam Vloeberghs <https://github.com/samvloeberghs/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

// please also see the typings project and prefer to use it!
// typings project: https://github.com/typings/typings
// typings: https://github.com/samvloeberghs/foundation-sites-typings

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

declare namespace FoundationSites {

    // http://foundation.zurb.com/sites/docs/abide.html#javascript-reference
    interface Abide {
        requiredChecked(element:Object): boolean;
        findFormError($el:Object): Object;
        findLabel(element:Object): boolean;
        addErrorClasses(element:Object): void;
        removeErrorClasses(element:Object): void;
        validateInput(element:Object, form:Object): void;
        validateForm(element:Object): void;
        validateText(element:Object): boolean;
        validateRadio(group:string): boolean;
        matchValidation($el:Object, validators:string, required:boolean): boolean;
        resetForm($form:Object): void;
        destroy(): void;
    }

    interface IAbidePatterns {
        alpha?: RegExp;
        alpha_numeric?: RegExp;
        integer?: RegExp;
        number?: RegExp;
        card?: RegExp;
        cvv?: RegExp;
        email ?: RegExp;
        url?: RegExp;
        domain?: RegExp;
        datetime?: RegExp;
        date?: RegExp;
        time?: RegExp;
        dateISO?: RegExp;
        month_day_year?: RegExp;
        day_month_year?: RegExp;
        color?: RegExp;
    }

    interface IAbideOptions {
        validateOn?: string;
        labelErrorClass?: string;
        inputErrorClass?: string;
        formErrorSelector?: string;
        formErrorClass?: string;
        liveValidate?: boolean;
        validators?:any;
    }

    // http://foundation.zurb.com/sites/docs/accordion.html#javascript-reference
    interface Accordion {
        toggle($target:JQuery): void;
        down($target:JQuery, firstTime:boolean): void;
        up($target:JQuery): void;
        destroy(): void;
    }

    interface IAccordionOptions {
        slideSpeed?: number
        multiOpen?: boolean;
        allowAllClosed?: boolean;
    }

    // http://foundation.zurb.com/sites/docs/accordion-menu.html#javascript-reference
    interface AccordionMenu {
        hideAll(): void;
        toggle($target:JQuery): void;
        down($target:JQuery, firstTime:boolean): void;
        up($target:JQuery): void;
        destroy(): void;
    }

    interface IAccordionMenuOptions {
        slideSpeed?: number;
        multiOpen?: boolean;
    }

    // http://foundation.zurb.com/sites/docs/drilldown-menu.html#javascript-reference
    interface Drilldown {
        _hideAll(): void;
        _back($elem:JQuery): void;
        _show($elem:JQuery): void;
        _hide($elem:JQuery): void;
        destroy(): void;
    }

    interface IDrilldownOptions {
        backButton?: string;
        wrapper?: string
        closeOnClick?: boolean
    }

    // http://foundation.zurb.com/sites/docs/dropdown.html#javascript-reference
    interface Dropdown {
        getPositionClass(): string;
        open(): void;
        close(): void;
        toggle(): void;
        destroy(): void;
    }

    interface IDropdownOptions {
        hoverDelay?: number;
        hover?: boolean;
        hoverPane?: boolean;
        vOffset?: number;
        hOffset?: number;
        positionClass?: string;
        trapFocus?: boolean;
        autoFocus?: boolean;
        closeOnClick?: boolean;
    }

    // http://foundation.zurb.com/sites/docs/dropdown-menu.html#javascript-reference
    interface DropdownMenu {
        destroy(): void;
    }

    interface IDropdownMenuOptions {
        disableHover?: boolean;
        autoclose?: boolean;
        hoverDelay?: number;
        clickOpen?: boolean;
        closingTime?: number;
        alignment?: string;
        closeOnClick?:boolean;
        verticalClass?: string;
        rightClass?: string;
        forceFollow?: boolean;
    }

    // http://foundation.zurb.com/sites/docs/equalizer.html#javascript-reference
    interface Equalizer {
        getHeights(element:Object): Array<any>;
        getHeightsByRow(cb:Function): void;
        applyHeight(heights:Array<any>): void;
        applyHeightByRow(groups:Array<any>):void;
        destroy(): void;
    }

    interface IEqualizerOptions {
        equalizeOnStack?: boolean;
        equalizeByRow?: boolean;
        equalizeOn?:string;
    }

    // http://foundation.zurb.com/sites/docs/interchange.html#javascript-reference
    interface Interchange {
        replace(path:string): void;
        destroy(): void;
    }

    interface IInterchangeOptions {
        rules?: Array<any>
    }

    // http://foundation.zurb.com/sites/docs/magellan.html#javascript-reference
    interface Magellan {
        calcPoints(): void;
        reflow(): void;
        destroy(): void;
    }

    interface IMagellanOptions {
        animationDuration?: number;
        animationEasing?: string;
        threshold?: number;
        activeClass?: string;
        deepLinking?: boolean;
        barOffset?: number;
    }

    // http://foundation.zurb.com/sites/docs/offcanvas.html#javascript-reference
    interface OffCanvas {
        reveal(isRevealed:boolean): void;
        open(event:Object, trigger:JQuery): void;
        close(): void;
        toggle(event:Object, trigger:JQuery): void;
        destroy(): void;
    }

    interface IOffCanvasOptions {
        closeOnClick?: boolean;
        transitionTime?: number;
        position?: string;
        forceTop?: boolean;
        isRevealed?: boolean;
        revealOn?: string;
        autoFocus?: boolean;
        revealClass?: string;
    }

    // http://foundation.zurb.com/sites/docs/orbit.html#javascript-reference
    interface Orbit {
        geoSync(): void;
        changeSlide(isLTR:boolean, chosenSlide?:Object, idx?:number): void;
        destroy(): void;
    }

    interface IOrbitOptions {
        bullets?: boolean;
        navButtons?: boolean;
        animInFromRight?: string;
        animOutToRight?: string;
        animInFromLeft?: string;
        animOutToLeft?: string;
        autoPlay?: boolean;
        timerDelay?: number;
        infiniteWrap?: boolean;
        swipe?: boolean;
        pauseOnHover?: boolean;
        accessible?: boolean;
        containerClass?: string;
        slideClass?: string;
        boxOfBullets?: string;
        nextClass?: string;
        prevClass?: string;
        useMUI?: boolean;
    }

    // http://foundation.zurb.com/sites/docs/reveal.html#javascript-reference
    interface Reveal {
        open(): void;
        toggle(): void;
        close(): void;
        destroy(): void;
    }

    interface IRevealOptions {
        animationIn?: string;
        animationOut?: string;
        showDelay?: number;
        hideDelay?: number;
        closeOnClick?: boolean;
        closeOnEsc?: boolean;
        multipleOpened?: boolean;
        vOffset?: number;
        hOffset?: number;
        fullScreen?: boolean;
        btmOffsetPct?: number;
        overlay?: boolean;
        resetOnClose?: boolean;
    }

    // http://foundation.zurb.com/sites/docs/slider.html#javascript-reference
    interface Slider {
        destroy(): void;
    }

    interface ISliderOptions {
        start?: number;
        end?: number;
        step?: number;
        initialStart ?: number;
        initialEnd?: number;
        binding?: boolean;
        clickSelect?: boolean;
        vertical?: boolean;
        draggable?: boolean;
        disabled?: boolean;
        doubleSided?: boolean;
        decimal?: number;
        moveTime?: number;
        disabledClass?: string;
    }

    // http://foundation.zurb.com/sites/docs/sticky.html#javascript-reference
    interface Sticky {
        _pauseListeners(scrollListener:string): void;
        _calc(checkSizes:boolean, scroll:number): void;
        destroy(): void;
        emCalc(Number:number): void;
    }

    interface IStickyOptions {
        container?: string;
        stickTo?: string;
        anchor?: string;
        topAnchor?: string;
        btmAnchor?: string;
        marginTop?: number;
        marginBottom?: number;
        stickyOn?: string;
        stickyClass?: string;
        containerClass?: string;
        checkEvery?: number;
    }

    // http://foundation.zurb.com/sites/docs/tabs.html#javascript-reference
    interface Tabs {
        _handleTabChange($target:JQuery): void;
        selectTab($target:JQuery): void;
        destroy(): void;
    }

    interface ITabsOptions {
        autoFocus?: boolean;
        wrapOnKeys?: boolean;
        matchHeight?: boolean;
        linkClass?: string;
        panelClass?: string;
    }

    // http://foundation.zurb.com/sites/docs/toggler.html#javascript-reference
    interface Toggler {
        toggle(): void;
        destroy(): void;
    }

    interface ITogglerOptions {
        animate?: boolean;
    }

    // http://foundation.zurb.com/sites/docs/tooltip.html#javascript-reference
    interface Tooltip {
        show(): void;
        hide(): void;
        toggle(): void;
        destroy(): void;
    }

    interface ITooltipOptions {
        hoverDelay?: number;
        fadeInDuration?: number;
        fadeOutDuration?: number;
        disableHover?: boolean;
        templateClasses?: string;
        tooltipClass?: string;
        triggerClass?: string;
        showOn?: string;
        template?: string;
        tipText?: string;
        clickOpen?: boolean;
        positionClass?: string;
        vOffset?: number;
        hOffset?:number;
    }

    // Utilities
    // ---------

    interface Box {
        ImNotTouchingYou(element:Object, parent?:Object, lrOnly?:boolean, tbOnly?:boolean): boolean;
        GetDimensions(element:Object): Object;
        GetOffsets(element:Object, anchor:Object, position:string, vOffset:number, hOffset:number, isOverflow:boolean): Object;
    }

    interface KeyBoard {
        parseKey(event:any): string;
        handleKey(event:any, component:any, functions:any):void;
        findFocusable($element:Object): Object;
    }

    interface MediaQuery {
        get(size:string): string;
        atLeast(size:string): boolean;
        queries:Array<string>;
        current:string;
    }

    interface Motion {
        animateIn(element:Object, animation:any, cb:Function): void;
        animateOut(element:Object, animation:any, cb:Function): void;
    }

    interface Move {
        // TODO
    }

    interface Nest {
        Feather(menu:any, type:any):void;
        Burn(menu:any, type:any):void;
    }

    interface Timer {
        start(): void;
        restart(): void;
        pause(): void;
    }

    interface Touch {
        // TODO :extension on jQuery
    }

    interface Triggers {
        // TODO :extension on jQuery
    }

    interface FoundationSitesStatic {
        version : string;

        rtl(): boolean;
        plugin(plugin:Object, name:string): void;
        registerPlugin(plugin:Object): void;
        unregisterPlugin(plugin:Object): void;
        reInit(plugins:Array<any>):void;
        GetYoDigits(length:number, namespace?:string): string;
        reflow(elem:Object, plugins?:Array<string>|string): void;
        getFnName(fn:string): string;
        transitionend(): string;

        util : {
            throttle(func:(...args:any[]) => any, delay:number): (...args:any[]) => any;
        };

        Abide(element:Object, options?:IAbideOptions): Abide;
        Accordion(element:Object, options?:IAccordionOptions): Accordion;
        AccordionMenu(element:Object, options?:IAccordionMenuOptions): AccordionMenu;
        DrillDown(element:Object, options?:IDrilldownOptions): Drilldown;
        Dropdown(element:Object, options?:IDropdownOptions): Dropdown;
        DropdownMenu(element:Object, options?:IDropdownMenuOptions): DropdownMenu;
        Equalizer(element:Object, options?:IEqualizerOptions): Equalizer;
        Interchange(element:Object, options?:IInterchangeOptions): Interchange;
        Magellan(element:Object, options?:IMagellanOptions): Magellan;
        OffCanvas(element:Object, options?:IOffCanvasOptions): OffCanvas;
        Orbit(element:Object, options?:IOrbitOptions): Orbit;
        Reveal(element:Object, options?:IRevealOptions): Reveal;
        Slider(element:Object, options?:ISliderOptions): Slider;
        Sticky(element:Object, options?:IStickyOptions): Sticky;
        Tabs(element:Object, options?:ITabsOptions): Tabs;
        Toggler(element:Object, options?:ITogglerOptions): Toggler;
        Tooltip(element:Object, options?:ITooltipOptions): Tooltip;

        // utils
        Box: Box;
        KeyBoard: KeyBoard;
        MediaQuery: MediaQuery;
        Motion: Motion;
        Move: Move;
        Nest: Nest;
        Timer: Timer;
        Touch: Touch;
        Triggers: Triggers;

    }

}

interface JQuery {
    foundation(method?:string|Array<any>) : JQuery;
}

declare var Foundation:FoundationSites.FoundationSitesStatic;

declare module "foundation-sites" {
    export = Foundation;
}