mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-09-09 11:13:57 +08:00
Merge pull request #1197 from jonathanhedren/master
Added Twitter Flight definitions
This commit is contained in:
basarat
@@ -68,6 +68,7 @@ List of Definitions
|
||||
* [Firebase](https://www.firebase.com/docs/javascript/firebase) (by [Vincent Bortone](https://github.com/vbortone))
|
||||
* [Firefox](https://developer.mozilla.org/en-US/docs/Web/API) (by [vvakame](https://github.com/vvakame))
|
||||
* [FlexSlider](http://www.woothemes.com/flexslider/) (by [Diullei Gomes](https://github.com/Diullei))
|
||||
* [Flight by Twitter](http://flightjs.github.com/flight/) (by [Jonathan Hedrén](https://github.com/jonathanhedren))
|
||||
* [Foundation](http://foundation.zurb.com/) (by [Boris Yankov](https://github.com/borisyankov))
|
||||
* [FPSMeter](http://darsa.in/fpsmeter/) (by [Aaron Lampros](https://github.com/alampros))
|
||||
* [FullCalendar](http://arshaw.com/fullcalendar/) (by [Neil Stalker](https://github.com/nestalk))
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
/// <reference path="flight.d.ts" />
|
||||
declare var el: Element;
|
||||
declare var els: Element[];
|
||||
declare var mixinFn: Function;
|
||||
|
||||
function TestComponent() {
|
||||
var self: Flight.Component = this;
|
||||
|
||||
self.defaultAttrs({
|
||||
fooSelector: '.bar'
|
||||
});
|
||||
|
||||
this.onClick = function (ev: JQueryEventObject, data: Flight.EventData) {
|
||||
var el: HTMLElement = data.el;
|
||||
self.select('fooSelector').addClass('bar');
|
||||
};
|
||||
|
||||
self.around('initialize', function () { });
|
||||
self.before('initialize', function () { });
|
||||
self.after("initialize", function () {
|
||||
|
||||
var $node: JQuery = self.$node;
|
||||
var node: Element = self.node;
|
||||
|
||||
self.on(el, 'click', {});
|
||||
self.on(els, 'click', function () { });
|
||||
self.on(document, 'click', this.onClick);
|
||||
self.on('click', function () { });
|
||||
self.on('click', {
|
||||
fooSelector: this.onClick
|
||||
});
|
||||
|
||||
self.off('click', function () { });
|
||||
self.off(document, 'click');
|
||||
self.off(el, 'click')
|
||||
self.off(els, 'click');
|
||||
|
||||
self.teardown();
|
||||
});
|
||||
}
|
||||
|
||||
flight.component(TestComponent, mixinFn).attachTo(el);
|
||||
flight.component(TestComponent, mixinFn).attachTo($(els));
|
||||
flight.component(TestComponent, mixinFn).attachTo('.test');
|
||||
flight.component(TestComponent, mixinFn).attachTo('.test', {
|
||||
some: 'data'
|
||||
});
|
||||
|
||||
flight.component.teardownAll();
|
||||
Vendored
+238
@@ -0,0 +1,238 @@
|
||||
/// <reference path="../jquery/jquery.d.ts" />
|
||||
|
||||
// Type definitions for Flight 1.1.1
|
||||
// Project: http://flightjs.github.com/flight/
|
||||
// Definitions by: Jonathan Hedrén <https://github.com/jonathanhedren/>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
declare module Flight {
|
||||
|
||||
export interface Base {
|
||||
|
||||
/**
|
||||
* Most Components and Mixins need to define attributes. In Flight,
|
||||
* default values are assigned by passing an object to the defaultAttrs
|
||||
* function.
|
||||
*/
|
||||
defaultAttrs(obj: Object): void;
|
||||
|
||||
/**
|
||||
* The select method takes an attr key as its argument. The value of the
|
||||
* attr must be a CSS Selector. The method will return all matching
|
||||
* elements within the component's node.
|
||||
*
|
||||
* This is a handy alternative to jQuery's this.$node.find() and prevents
|
||||
* accidental access to elements outside of the component's node.
|
||||
*
|
||||
* @param attr
|
||||
*/
|
||||
select(attr: string): JQuery;
|
||||
|
||||
/**
|
||||
* This method is attached to the prototype of every Component; it accepts
|
||||
* the component's node and an options object as arguments. The core
|
||||
* implementation, which is called every time an instance is created, will
|
||||
* assign the node to the instance and override the default attrs with the
|
||||
* options object.
|
||||
*
|
||||
* Components and Mixins will typically augment the core implementation by
|
||||
* supplying a function as an argument to the after method (see the advice
|
||||
* API for more information). This is a good place to set up event
|
||||
* listeners that bind to callbacks.
|
||||
*/
|
||||
initialize(node: any, options: Object): void;
|
||||
|
||||
/**
|
||||
* This allows a component instance to listen to an event and register a
|
||||
* callback to be invoked. Flight will automatically bind the context
|
||||
* (this) of the callback to the component instance.
|
||||
*
|
||||
* @param selector Optional. Specify the DOM node(s) that should listen
|
||||
* for the event. Defaults to the component instance's node value.
|
||||
*
|
||||
* @param eventType The event type to listen for.
|
||||
*
|
||||
* @param handler Either a function (callback) to be invoked, or a map of
|
||||
* targets and callbacks.
|
||||
*/
|
||||
on(eventType: string, handler: Function): void;
|
||||
on(eventType: string, handler: Object): void;
|
||||
on(selector: string, eventType: string, handler: Function): void;
|
||||
on(selector: Document, eventType: string, handler: Function): void;
|
||||
on(selector: Element, eventType: string, handler: Function): void;
|
||||
on(selector: Element[], eventType: string, handler: Function): void;
|
||||
on(selector: string, eventType: string, handler: Object): void;
|
||||
on(selector: Document, eventType: string, handler: Object): void;
|
||||
on(selector: Element, eventType: string, handler: Object): void;
|
||||
on(selector: Element[], eventType: string, handler: Object): void;
|
||||
|
||||
/**
|
||||
* If we no longer want a component instance to listen to an event we can
|
||||
* use the off method to unsubscribe.
|
||||
*
|
||||
* @param selector Optional. The DOM node(s) listening for the event.
|
||||
* Defaults to the component instance's node value.
|
||||
*
|
||||
* @param eventType The event type being listened to.
|
||||
*
|
||||
* @param handler Optional. The function (callback) to detach from the
|
||||
* component instance. Defaults to the detaching all callbacks for the event.
|
||||
*/
|
||||
off(eventType: string, handler?: Function): void;
|
||||
off(selector: string, eventType: string, handler?: Function): void;
|
||||
off(selector: Document, eventType: string, handler?: Function): void;
|
||||
off(selector: Element, eventType: string, handler?: Function): void;
|
||||
off(selector: Element[], eventType: string, handler?: Function): void;
|
||||
off(selector: string, eventType: Object, handler?: Function): void;
|
||||
off(selector: Document, eventType: Object, handler?: Function): void;
|
||||
off(selector: Element, eventType: Object, handler?: Function): void;
|
||||
off(selector: Element[], eventType: Object, handler?: Function): void;
|
||||
off(selector: string, eventType: string, handler?: Object): void;
|
||||
off(selector: Document, eventType: string, handler?: Object): void;
|
||||
off(selector: Element, eventType: string, handler?: Object): void;
|
||||
off(selector: Element[], eventType: string, handler?: Object): void;
|
||||
off(selector: string, eventType: Object, handler?: Object): void;
|
||||
off(selector: Document, eventType: Object, handler?: Object): void;
|
||||
off(selector: Element, eventType: Object, handler?: Object): void;
|
||||
off(selector: Element[], eventType: Object, handler?: Object): void;
|
||||
|
||||
/**
|
||||
* Trigger an event.
|
||||
*
|
||||
* @param selector Optional. The DOM node(s) that the event will be
|
||||
* dispatched to. Defaults to the component instance's node value.
|
||||
*
|
||||
* @param eventType String. The event type to be triggered.
|
||||
*
|
||||
* You can also specify a default function that will be called by the
|
||||
* component, providing that nothing in the event's bubble chain invokes
|
||||
* preventDefault. Default functions in custom events are analagous to the
|
||||
* default actions of native events.
|
||||
*
|
||||
* To define a default function, make the eventType argument an object
|
||||
* that specifies the event's type and a defaultBehavior property. A
|
||||
* common use case is defining default behavior for keyboard events.
|
||||
*
|
||||
* @param eventPayload This is the payload of data that accompanies the event.
|
||||
*/
|
||||
trigger(eventType: string): void;
|
||||
trigger(selector: string, eventType: string, eventPayload?: Object): void;
|
||||
trigger(selector: Document, eventType: string, eventPayload?: Object): void;
|
||||
trigger(selector: Element, eventType: string, eventPayload?: Object): void;
|
||||
trigger(selector: Element[], eventType: string, eventPayload?: Object): void;
|
||||
trigger(eventType: Object): void;
|
||||
trigger(selector: string, eventType: Object, eventPayload?: Object): void;
|
||||
trigger(selector: Document, eventType: Object, eventPayload?: Object): void;
|
||||
trigger(selector: Element, eventType: Object, eventPayload?: Object): void;
|
||||
trigger(selector: Element[], eventType: Object, eventPayload?: Object): void;
|
||||
|
||||
/**
|
||||
* Remove a component instance and its event bindings.
|
||||
*
|
||||
* It's a good idea to teardown components after each unit test - and
|
||||
* teardown is also good for unbinding event listeners when, for example,
|
||||
* the user navigates away from a page.
|
||||
*
|
||||
*/
|
||||
teardown(): void;
|
||||
}
|
||||
|
||||
export interface Advice extends Base {
|
||||
/**
|
||||
* Run the customFunc function after the existingFunc function.
|
||||
*
|
||||
* @param existingFuncName The name of the existing function (existingFunc)
|
||||
* you want to augment.
|
||||
*
|
||||
* customFunc The function to be invoked after existingFunc.
|
||||
*/
|
||||
after(method: string, fn: Function): void;
|
||||
|
||||
/**
|
||||
* Run the existingFunc function in the middle of the customFunc function.
|
||||
* It's similar to underscore's _wrap function).
|
||||
*
|
||||
* @param existingFuncName The name of the existing function (existingFunc)
|
||||
* you want to augment.
|
||||
*
|
||||
* customFunc The function to wrap around existingFunc. The existingFunc
|
||||
* function will be passed to customFunc as an argument.
|
||||
*
|
||||
* The existing function is passed to the custom function as an argument so
|
||||
* that it can be referenced. If the custom function does not call the
|
||||
* existing function then it will replace that function instead of
|
||||
* surrounding it.
|
||||
*/
|
||||
around(method: string, fn: Function): void;
|
||||
|
||||
/**
|
||||
* Run the customFunc function before the existingFunc function.
|
||||
*
|
||||
* @param existingFuncName The name of the existing function (existingFunc)
|
||||
* you want to augment.
|
||||
*
|
||||
* @param customFunc The function to be invoked before existingFunc.
|
||||
*/
|
||||
before(method: string, fn: Function): void;
|
||||
}
|
||||
|
||||
export interface Component extends Base, Advice {
|
||||
node: Element;
|
||||
$node: JQuery;
|
||||
}
|
||||
|
||||
|
||||
export interface AdviceStatic {
|
||||
withAdvice(): Function;
|
||||
}
|
||||
|
||||
export interface ComponentStatic {
|
||||
(...fns: Function[]): ComponentStatic;
|
||||
attachTo(selector: string, options?: Object): void;
|
||||
attachTo(selector: Element, options?: Object): void;
|
||||
attachTo(selector: JQuery, options?: Object): void;
|
||||
teardownAll(): void;
|
||||
}
|
||||
|
||||
export interface ComposeStatic {
|
||||
mixin(base: Object, mixins: Function[]): void;
|
||||
}
|
||||
|
||||
export interface DebugStatic {
|
||||
events: {
|
||||
logAll(): void;
|
||||
logByAction(action: string): void;
|
||||
logByName(name: string): void;
|
||||
logNone(): void;
|
||||
}
|
||||
}
|
||||
|
||||
export interface UtilsStatic {
|
||||
compose(fn1: Function, fn2: Function, ...fns: Function[]): Function;
|
||||
countThen(num: number, base: Function): Function;
|
||||
debounce(func: Function, wait: number, immediate: boolean): Function;
|
||||
delegate(rules: Object): void;
|
||||
isDomObj(obj: Object): boolean;
|
||||
isEnumerable(obj: Object, property: string): boolean;
|
||||
merge(obj1: Object, obj2: Object, deepClone?: boolean): Object;
|
||||
merge(obj1: Object, obj2: Object, ...args: any[]): Object;
|
||||
push(base: Object, extra: Object, protect?: boolean): void;
|
||||
throttle(func: Function, wait: number): Function;
|
||||
toArray(obj: Object, from?: number): Array;
|
||||
uniqueArray(array: Array): Array;
|
||||
}
|
||||
|
||||
export interface EventData {
|
||||
el: HTMLElement;
|
||||
}
|
||||
|
||||
export interface FlightStatic {
|
||||
advice: AdviceStatic;
|
||||
component: ComponentStatic;
|
||||
compose: ComposeStatic;
|
||||
utils: UtilsStatic;
|
||||
}
|
||||
}
|
||||
|
||||
declare var DEBUG: Flight.DebugStatic;
|
||||
declare var flight: Flight.FlightStatic;
|
||||
Reference in New Issue
Block a user