@types/isotope-layout
Advanced tools
Comparing version 3.0.3 to 3.0.4
// Type definitions for isotope 3.0 | ||
// Project: http://isotope.metafizzy.co/ | ||
// Definitions by: Anže Videnič <https://github.com/avidenic> | ||
// Mălin Brândușe <https://github.com/malinushj> | ||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
// TypeScript Version: 2.3 | ||
/// <reference types="jquery"/> | ||
export as namespace Isotope | ||
export = Isotope; | ||
declare namespace IsotopeLibrary { | ||
declare namespace Isotope { | ||
type LayoutModes = 'masonry' | 'fitRows' | 'cellsByRow' | 'vertical' | 'packery' | 'masonryHorizontal' | 'fitColumns' | 'cellsByColumn' | 'horiz'; | ||
@@ -126,92 +128,2 @@ type Elements = HTMLElement[] | HTMLElement | JQuery | NodeList; | ||
interface Isotope { | ||
/** | ||
* Adds item elements to the Isotope instance. addItems does not lay out items like appended, prepended, or insert. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
addItems(elements: Elements): void; | ||
/** | ||
* Adds and lays out newly appended item elements to the end of the layout. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
appended(elements: Elements): void; | ||
/** | ||
* Filters, sorts, and lays out items. arrange is the principle method of Isotope. It is the default method with jQuery .isotope(). Pass in options to apply filtering and sorting. | ||
* @param options All options are optional, but itemSelector is recommended. Layout modes have their own separate options. | ||
*/ | ||
arrange(options: IsotopeOptions): void; | ||
/** | ||
* Removes the Isotope functionality completely. destroy will return the element back to its pre-initialized state. | ||
*/ | ||
destroy(): void; | ||
/** | ||
* Returns an array of filtered item elements in current sorted order. | ||
*/ | ||
getFilteredItemElements(): Element[]; | ||
/** | ||
* Returns an array of all item elements in the Isotope instance. | ||
*/ | ||
getItemElements(): Element[]; | ||
/** | ||
* Hide items. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
hideItemElements(elements: Elements): void; | ||
/** | ||
* Appends elements into container element, adds elements as items, and arranges items with filtering and sorting. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
insert(elements: Elements): void; | ||
/** | ||
* Lays out all item elements. layout is useful when an item has changed size, and all items need to be laid out again. layout does not apply filtering or sorting. | ||
*/ | ||
layout(): void; | ||
/** | ||
* Lays out specified items. | ||
* @param elements Array of Isotope.Items | ||
* @param isStill Disables transitions | ||
*/ | ||
layoutItems(elements: HTMLElement[], isStill: boolean): void; | ||
/** | ||
* Adds and lays out newly prepended item elements at the beginning of layout. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
prepended(elements: Elements): void; | ||
/** | ||
* Recollects all item elements. | ||
* For frameworks like Angular and React, reloadItems may be useful to apply changes to the DOM to Isotope. | ||
*/ | ||
reloadItems(): void; | ||
/** | ||
* Removes elements from the Isotope instance and DOM. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
remove(elements: Elements): void; | ||
/** | ||
* Reveals hidden items. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
revealItemElements(elements: Elements): void; | ||
/** | ||
* Shuffles items in a random order. | ||
*/ | ||
shuffle(): void; | ||
/** | ||
* Stamps elements in the layout. Isotope will lay out item elements around stamped elements. | ||
* Stamping is only supported by some layout modes: masonry, packery and masonryhorizontal. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
stamp(elements: Elements): void; | ||
/** | ||
* Un-stamps elements in the layout, so that Isotope will no longer layout item elements around them. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
unstamp(elements: Elements): void; | ||
/** | ||
* Updates sort data | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
updateSortData(elements: Elements): void; | ||
} | ||
interface Sorter { | ||
@@ -270,39 +182,35 @@ [key: string]: ((itemElm: JQuery) => number | string) | string; | ||
interface Isotope extends IsotopeLibrary.Isotope { } | ||
declare var Isotope: { | ||
prototype: IsotopeLibrary.Isotope; | ||
new (selector: string): IsotopeLibrary.Isotope; | ||
interface Isotope { | ||
/** | ||
* Get the Isotope instance via its element. Isotope.data() is useful for getting the Isotope instance in JavaScript, after it has been initalized in HTML. | ||
* Adds item elements to the Isotope instance. addItems does not lay out items like appended, prepended, or insert. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
data(element: HTMLElement | string): IsotopeLibrary.Isotope; | ||
}; | ||
interface JQuery { | ||
addItems(elements: Isotope.Elements): void; | ||
/** | ||
* Get the Isotope instance from a jQuery object. Isotope instances are useful to access Isotope properties. | ||
* Adds and lays out newly appended item elements to the end of the layout. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
data(methodName: 'isotope'): IsotopeLibrary.Isotope; | ||
appended(elements: Isotope.Elements): void; | ||
/** | ||
* Lays out specified items. | ||
* @param elements Array of Isotope.Items | ||
* @param isStill Disables transitions | ||
* Filters, sorts, and lays out items. arrange is the principle method of Isotope. It is the default method with jQuery .isotope(). Pass in options to apply filtering and sorting. | ||
* @param options All options are optional, but itemSelector is recommended. Layout modes have their own separate options. | ||
*/ | ||
isotope(methodName: 'layoutItems', elements: HTMLElement[], isStill: boolean): JQuery; | ||
arrange(options: Isotope.IsotopeOptions): void; | ||
/** | ||
* Adds item elements to the Isotope instance. addItems does not lay out items like appended, prepended, or insert. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
* Removes the Isotope functionality completely. destroy will return the element back to its pre-initialized state. | ||
*/ | ||
isotope(methodName: 'addItems', elements: IsotopeLibrary.Elements): JQuery; | ||
destroy(): void; | ||
/** | ||
* Adds and lays out newly appended item elements to the end of the layout. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
* Returns an array of filtered item elements in current sorted order. | ||
*/ | ||
isotope(methodName: 'appended', elements: IsotopeLibrary.Elements): JQuery; | ||
getFilteredItemElements(): Element[]; | ||
/** | ||
* Returns an array of all item elements in the Isotope instance. | ||
*/ | ||
getItemElements(): Element[]; | ||
/** | ||
* Hide items. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'hideItemElements', elements: IsotopeLibrary.Elements): JQuery; | ||
hideItemElements(elements: Isotope.Elements): void; | ||
/** | ||
@@ -312,13 +220,28 @@ * Appends elements into container element, adds elements as items, and arranges items with filtering and sorting. | ||
*/ | ||
isotope(methodName: 'insert', elements: IsotopeLibrary.Elements): JQuery; | ||
insert(elements: Isotope.Elements): void; | ||
/** | ||
* Lays out all item elements. layout is useful when an item has changed size, and all items need to be laid out again. layout does not apply filtering or sorting. | ||
*/ | ||
layout(): void; | ||
/** | ||
* Lays out specified items. | ||
* @param elements Array of Isotope.Items | ||
* @param isStill Disables transitions | ||
*/ | ||
layoutItems(elements: HTMLElement[], isStill: boolean): void; | ||
/** | ||
* Adds and lays out newly prepended item elements at the beginning of layout. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'prepended', elements: IsotopeLibrary.Elements): JQuery; | ||
prepended(elements: Isotope.Elements): void; | ||
/** | ||
* Recollects all item elements. | ||
* For frameworks like Angular and React, reloadItems may be useful to apply changes to the DOM to Isotope. | ||
*/ | ||
reloadItems(): void; | ||
/** | ||
* Removes elements from the Isotope instance and DOM. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'remove', elements: IsotopeLibrary.Elements): JQuery; | ||
remove(elements: Isotope.Elements): void; | ||
/** | ||
@@ -328,4 +251,8 @@ * Reveals hidden items. | ||
*/ | ||
isotope(methodName: 'revealItemElements', elements: IsotopeLibrary.Elements): JQuery; | ||
revealItemElements(elements: Isotope.Elements): void; | ||
/** | ||
* Shuffles items in a random order. | ||
*/ | ||
shuffle(): void; | ||
/** | ||
* Stamps elements in the layout. Isotope will lay out item elements around stamped elements. | ||
@@ -335,3 +262,3 @@ * Stamping is only supported by some layout modes: masonry, packery and masonryhorizontal. | ||
*/ | ||
isotope(methodName: 'stamp', elements: IsotopeLibrary.Elements): JQuery; | ||
stamp(elements: Isotope.Elements): void; | ||
/** | ||
@@ -341,3 +268,3 @@ * Un-stamps elements in the layout, so that Isotope will no longer layout item elements around them. | ||
*/ | ||
isotope(methodName: 'unstamp', elements: IsotopeLibrary.Elements): JQuery; | ||
unstamp(elements: Isotope.Elements): void; | ||
/** | ||
@@ -347,33 +274,108 @@ * Updates sort data | ||
*/ | ||
isotope(methodName: 'updateSortData', elements: IsotopeLibrary.Elements): JQuery; | ||
updateSortData(elements: Isotope.Elements): void; | ||
} | ||
declare const Isotope: { | ||
prototype: Isotope, | ||
new (elementOrSelector: HTMLElement | string, options: Isotope.IsotopeOptions): Isotope; | ||
/** | ||
* Removes the Isotope functionality completely. destroy will return the element back to its pre-initialized state. | ||
* Get the Isotope instance via its element. Isotope.data() is useful for getting the Isotope instance in JavaScript, after it has been initalized in HTML. | ||
*/ | ||
isotope(methodName: 'destroy'): void; | ||
/** | ||
* Returns an array of filtered item elements in current sorted order. | ||
*/ | ||
isotope(methodName: 'getFilteredItemElements'): Element[]; | ||
/** | ||
* Returns an array of all item elements in the Isotope instance. | ||
*/ | ||
isotope(methodName: 'getItemElements'): Element[]; | ||
/** | ||
* Lays out all item elements. layout is useful when an item has changed size, and all items need to be laid out again. layout does not apply filtering or sorting. | ||
*/ | ||
isotope(methodName: 'layout'): JQuery; | ||
/** | ||
* Recollects all item elements. | ||
* For frameworks like Angular and React, reloadItems may be useful to apply changes to the DOM to Isotope. | ||
*/ | ||
isotope(methodName: 'reloadItems'): JQuery; | ||
/** | ||
* Shuffles items in a random order. | ||
*/ | ||
isotope(methodName: 'shuffle'): JQuery; | ||
/** | ||
* Filters, sorts, and lays out items. Pass in options to apply filtering and sorting. | ||
* @param options All options are optional, but itemSelector is recommended. Layout modes have their own separate options. | ||
*/ | ||
isotope(options: IsotopeLibrary.IsotopeOptions): JQuery; | ||
data(element: HTMLElement | string): Isotope; | ||
}; | ||
declare global { | ||
interface JQuery { | ||
/** | ||
* Get the Isotope instance from a jQuery object. Isotope instances are useful to access Isotope properties. | ||
*/ | ||
data(methodName: 'isotope'): Isotope; | ||
/** | ||
* Lays out specified items. | ||
* @param elements Array of Isotope.Items | ||
* @param isStill Disables transitions | ||
*/ | ||
isotope(methodName: 'layoutItems', elements: HTMLElement[], isStill: boolean): JQuery; | ||
/** | ||
* Adds item elements to the Isotope instance. addItems does not lay out items like appended, prepended, or insert. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'addItems', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Adds and lays out newly appended item elements to the end of the layout. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'appended', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Hide items. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'hideItemElements', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Appends elements into container element, adds elements as items, and arranges items with filtering and sorting. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'insert', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Adds and lays out newly prepended item elements at the beginning of layout. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'prepended', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Removes elements from the Isotope instance and DOM. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'remove', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Reveals hidden items. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'revealItemElements', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Stamps elements in the layout. Isotope will lay out item elements around stamped elements. | ||
* Stamping is only supported by some layout modes: masonry, packery and masonryhorizontal. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'stamp', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Un-stamps elements in the layout, so that Isotope will no longer layout item elements around them. | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'unstamp', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Updates sort data | ||
* @param elements Element, jQuery Object, NodeList, or Array of Elements | ||
*/ | ||
isotope(methodName: 'updateSortData', elements: Isotope.Elements): JQuery; | ||
/** | ||
* Removes the Isotope functionality completely. destroy will return the element back to its pre-initialized state. | ||
*/ | ||
isotope(methodName: 'destroy'): void; | ||
/** | ||
* Returns an array of filtered item elements in current sorted order. | ||
*/ | ||
isotope(methodName: 'getFilteredItemElements'): Element[]; | ||
/** | ||
* Returns an array of all item elements in the Isotope instance. | ||
*/ | ||
isotope(methodName: 'getItemElements'): Element[]; | ||
/** | ||
* Lays out all item elements. layout is useful when an item has changed size, and all items need to be laid out again. layout does not apply filtering or sorting. | ||
*/ | ||
isotope(methodName: 'layout'): JQuery; | ||
/** | ||
* Recollects all item elements. | ||
* For frameworks like Angular and React, reloadItems may be useful to apply changes to the DOM to Isotope. | ||
*/ | ||
isotope(methodName: 'reloadItems'): JQuery; | ||
/** | ||
* Shuffles items in a random order. | ||
*/ | ||
isotope(methodName: 'shuffle'): JQuery; | ||
/** | ||
* Filters, sorts, and lays out items. Pass in options to apply filtering and sorting. | ||
* @param options All options are optional, but itemSelector is recommended. Layout modes have their own separate options. | ||
*/ | ||
isotope(options: Isotope.IsotopeOptions): JQuery; | ||
} | ||
} |
{ | ||
"name": "@types/isotope-layout", | ||
"version": "3.0.3", | ||
"version": "3.0.4", | ||
"description": "TypeScript definitions for isotope", | ||
@@ -11,2 +11,7 @@ "license": "MIT", | ||
"githubUsername": "avidenic" | ||
}, | ||
{ | ||
"name": "Mălin Brândușe", | ||
"url": "https://github.com/malinushj", | ||
"githubUsername": "malinushj" | ||
} | ||
@@ -20,7 +25,5 @@ ], | ||
"scripts": {}, | ||
"dependencies": { | ||
"@types/jquery": "*" | ||
}, | ||
"typesPublisherContentHash": "e18f54ff0cce0359235a9b9790306c8ce9c78b79a5b29d6492e51cd4d1f03c34", | ||
"dependencies": {}, | ||
"typesPublisherContentHash": "9451d5e722dd218c7359222e723f89b5a456be9117bff45ef6696846f221d650", | ||
"typeScriptVersion": "2.3" | ||
} |
@@ -11,7 +11,7 @@ # Installation | ||
Additional Details | ||
* Last updated: Thu, 14 Dec 2017 21:33:44 GMT | ||
* Dependencies: jquery | ||
* Last updated: Fri, 02 Mar 2018 10:54:53 GMT | ||
* Dependencies: none | ||
* Global values: Isotope | ||
# Credits | ||
These definitions were written by Anže Videnič <https://github.com/avidenic>. | ||
These definitions were written by Anže Videnič <https://github.com/avidenic>, Mălin Brândușe <https://github.com/malinushj>. |
Sorry, the diff of this file is not supported yet
18969
0
357
- Removed@types/jquery@*
- Removed@types/jquery@3.5.32(transitive)
- Removed@types/sizzle@2.3.9(transitive)