vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-04 06:47:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #17493 from nvh/master

Browse Source 
Updated definitions for tinycolor2 1.4.1
This commit is contained in:
Nathan Shively-Sanders
2017-06-26 09:02:04 -07:00
committed by GitHub
parent 7b7e670201 785ee394c2
commit 864ea483f6
2 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/tinycolor2/index.d.ts
Vendored
+19 -11
View File
@@ -1,6 +1,6 @@
// Type definitions for tinycolor v1.1.1
// Type definitions for tinycolor v1.4.1
// Project: https://github.com/bgrins/TinyColor
// Definitions by: Mordechai Zuber <https://github.com/M-Zuber>, Geert Jansen <https://github.com/geertjansen>
// Definitions by: Mordechai Zuber <https://github.com/M-Zuber>, Geert Jansen <https://github.com/geertjansen>, Niels van Hoorn <https://github.com/nvh>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare var tinycolor: tinycolor;
@@ -70,27 +70,34 @@ interface tinycolor {
* @param firstColor - the first color to be used in the comparison.
* @param secondColor - the second color to be used in the comparison.
*/
readability(firstColor: tinycolorInstance, secondColor: tinycolorInstance): Readable.Readable;
readability(firstColor: ColorInput, secondColor: ColorInput): Readable.Readable;
/**
* Ensure that foreground and background color combinations provide sufficient contrast.
* Ensure that foreground and background color combinations meet WCAG2 guidelines.
*
* @param foreColor - the fore color wanted.
* @param backCOlor - the back color wanted.
* @param backColor - the back color wanted.
* @param wcag2 - The 'level' property states 'AA' or 'AAA' - if missing or invalid, it defaults to 'AA'; the 'size' property states 'large' or 'small' - if missing or invalid, it defaults to 'small'. If the entire object is absent, isReadable defaults to {level:"AA",size:"small"}.
*/
isReadable(foreColor: tinycolorInstance, backColor: tinycolorInstance): boolean;
isReadable(foreColor: ColorInput, backColor: ColorInput, wcag2?: {level?: string, size?: string}): boolean;
/**
* Given a base color and a list of possible foreground or background colors for that base,
* returns the most readable color.
* returns the most readable color. Optionally returns Black or White if the most readable color is unreadable.
*
* @param color - the base color.
* @param colorsToCompare - array of colors to pick the most readable one from.
* @param args - and object with extra arguments
*/
mostReadable(color: tinycolorInstance, colorsToCompare: tinycolorInstance[]): tinycolorInstance;
mostReadable(color: ColorInput, colorsToCompare: ColorInput[], args?: {includeFallbackColors?: boolean, level?: string, size?: string}): tinycolorInstance;
/**/
mix(color1: tinycolorInstance, color2: tinycolorInstance, amount?: number): tinycolorInstance;
mix(color1: ColorInput, color2: ColorInput, amount?: number): tinycolorInstance;
/**
* Can be called with any tinycolor input
*/
equals(color1: ColorInput, color2: ColorInput): boolean;
/**
* Returns a random color
@@ -265,7 +272,6 @@ interface tinycolorInstance {
* Default value: 10.
*/
darken(amount?: number): tinycolorInstance;
/**
* Desaturate the color a given amount.
* Providing 100 will is the same as calling greyscale.
@@ -380,6 +386,8 @@ declare namespace ColorFormats {
}
}
type ColorInput = string | ColorFormats.RGB | ColorFormats.RGBA | ColorFormats.HSL | ColorFormats.HSLA | ColorFormats.HSV | ColorFormats.HSVA | tinycolorInstance
declare module 'tinycolor2' {
export = tinycolor;
}
}
types/tinycolor2/tinycolor2-tests.ts
+4
View File
@@ -28,14 +28,18 @@ tester = tinycolor({ h: 0, s: 0, v: 0, a: 0 });
//tinycolor static methods
tester = tinycolor.mix(tester, tester);
tester = tinycolor.mix("#ff0000", "#00ff00");
tester = tinycolor.mix(tester, tester, 50);
tester = tinycolor.random();
var isEqual = tinycolor.equals(tester, tester);
/*Tinycolor object properties*/
var readable: Readable.Readable = tinycolor.readability(tester, tester);
var isReadable: boolean = tinycolor.isReadable(tester, tester);
var isReadable: boolean = tinycolor.isReadable(tester, tester, {size: "small"});
tester = tinycolor.mostReadable(tester, [tester, tester, tester]);
tester = tinycolor.mostReadable(tester, [tester, tester, tester], {size: "large", level:"AA"});
var hexNames: { [key: string]: string } = tinycolor.hexNames;
var names: { [key: string]: string } = tinycolor.names;