Add definitions for 'bricks.js'

This commit is contained in:
Pusztai Tibor 2017-09-22 18:32:19 +02:00
parent 78d81429f4
commit 64c8216c08
4 changed files with 78 additions and 0 deletions

View File

@ -0,0 +1,18 @@
import Bricks from 'bricks.js';
const bricks = Bricks({
container: document.body.firstChild!,
packed: 'packed',
sizes: [
{ columns: 2, gutter: 10 },
{ mq: '768px', columns: 3, gutter: 25 },
{ mq: '1024px', columns: 4, gutter: 25 },
]
});
bricks
.pack()
.resize()
.on('resize', (detail) => {
const columns: number = detail.columns;
});

36
types/bricks.js/index.d.ts vendored Normal file
View File

@ -0,0 +1,36 @@
// Type definitions for bricks.js 1.8
// Project: https://github.com/callmecavs/bricks.js
// Definitions by: Pusztai Tibor <https://github.com/kondi>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare function BricksFactory(options: BricksOptions): BricksInstance;
export interface BricksInstance {
pack(): BricksInstance;
update(): BricksInstance;
resize(flag?: boolean): BricksInstance;
on(event: 'pack' | 'update', listener: () => any): BricksInstance;
on(event: 'resize', listener: (sizeDetail: SizeDetail) => any): BricksInstance;
once(event: 'pack' | 'update', listener: () => any): BricksInstance;
once(event: 'resize', listener: (sizeDetail: SizeDetail) => any): BricksInstance;
off(event: 'pack' | 'update', listener?: () => any): BricksInstance;
off(event: 'resize', listener?: (sizeDetail: SizeDetail) => any): BricksInstance;
}
export interface BricksOptions {
container: Node | string;
packed: string;
sizes: SizeDetail[];
position?: boolean;
}
export interface SizeDetail {
mq?: string;
columns: number;
gutter: number;
}
export default BricksFactory;

View File

@ -0,0 +1,23 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6",
"dom"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": true,
"baseUrl": "../",
"typeRoots": [
"../"
],
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"bricks.js-tests.ts"
]
}

View File

@ -0,0 +1 @@
{ "extends": "dtslint/dt.json" }