@nativescript/core
Version:
A JavaScript library providing an easy to use api for interacting with iOS and Android platform APIs.
520 lines • 17.7 kB
JavaScript
import * as types from '../utils/types';
import * as knownColors from './known-colors';
import { Color } from '.';
const SHARP = '#';
const HEX_REGEX = /(^#[0-9A-F]{6}$)|(^#[0-9A-F]{3}$)|(^#[0-9A-F]{8}$)/i;
export class ColorBase {
constructor(...args) {
if (args.length === 1) {
const arg = args[0];
if (types.isString(arg)) {
const lowered = arg.toLowerCase();
if (isRgbOrRgba(lowered)) {
this._argb = argbFromRgbOrRgba(lowered);
}
else if (isHslOrHsla(lowered)) {
this._argb = argbFromHslOrHsla(lowered);
}
else if (isHsvOrHsva(lowered)) {
this._argb = argbFromHsvOrHsva(lowered);
}
else if (knownColors.isKnownName(lowered)) {
// The parameter is a known color name
const argb = knownColors.getKnownColor(lowered);
this._name = arg;
this._argb = argb;
}
else if (arg[0].charAt(0) === SHARP && (arg.length === 4 || arg.length === 7 || arg.length === 9)) {
// we dont use the regexp as it is quite slow. Instead we expect it to be a valid hex format
// strange that it would not be. And if it is not a thrown error seems best
// The parameter is a "#RRGGBBAA" formatted string
this._argb = this._argbFromString(arg);
}
else {
throw new Error('Invalid color: ' + arg);
}
}
else if (types.isNumber(arg)) {
// The parameter is a 32-bit unsigned integer where each 8 bits specify a color component
// In case a 32-bit signed int (Android, Java has no unsigned types) was provided - convert to unsigned by applyint >>> 0
this._argb = arg >>> 0;
}
else if (arg && arg._argb) {
// we would go there if a color was passed as an argument (or an object which is why we dont do instanceof)
// The parameter is a 32-bit unsigned integer where each 8 bits specify a color component
// In case a 32-bit signed int (Android, Java has no unsigned types) was provided - convert to unsigned by applyint >>> 0
this._argb = arg._argb >>> 0;
}
else {
throw new Error('Expected 1 or 4 constructor parameters.');
}
}
else if (args.length >= 4) {
const a = args[0];
switch (args[4]) {
case 'hsl': {
const { r, g, b } = hslToRgb(args[1], args[2], args[3]);
this._argb = (a & 0xff) * 0x01000000 + (r & 0xff) * 0x00010000 + (g & 0xff) * 0x00000100 + (b & 0xff) * 0x00000001;
break;
}
case 'hsv': {
const { r, g, b } = hsvToRgb(args[1], args[2], args[3]);
this._argb = (a & 0xff) * 0x01000000 + (r & 0xff) * 0x00010000 + (g & 0xff) * 0x00000100 + (b & 0xff) * 0x00000001;
break;
}
default:
this._argb = (a & 0xff) * 0x01000000 + (args[1] & 0xff) * 0x00010000 + (args[2] & 0xff) * 0x00000100 + (args[3] & 0xff) * 0x00000001;
break;
}
}
else {
throw new Error('Expected 1 or 4 constructor parameters.');
}
}
get a() {
return (this._argb / 0x01000000) & 0xff;
}
get r() {
return (this._argb / 0x00010000) & 0xff;
}
get g() {
return (this._argb / 0x00000100) & 0xff;
}
get b() {
return (this._argb / 0x00000001) & 0xff;
}
get argb() {
return this._argb;
}
get hex() {
let result = SHARP + ('000000' + (this._argb & 0xffffff).toString(16)).toUpperCase().slice(-6);
if (this.a !== 0xff) {
return (result += ('00' + this.a.toString(16).toUpperCase()).slice(-2));
}
return result;
}
get name() {
return this._name;
}
get ios() {
return undefined;
}
get android() {
return undefined;
}
_argbFromString(hex) {
// always called as SHARP as first char
hex = hex.substring(1);
const length = hex.length;
// first we normalize
if (length === 3) {
hex = hex[0] + hex[0] + hex[1] + hex[1] + hex[2] + hex[2];
}
else if (length === 4) {
hex = hex[0] + hex[0] + hex[1] + hex[1] + hex[2] + hex[2] + hex[3] + hex[3];
}
let intVal = parseInt(hex, 16);
if (hex.length === 6) {
// add the alpha component since the provided string is RRGGBB
intVal = (intVal & 0x00ffffff) + 0xff000000;
}
else {
// the new format is #RRGGBBAA
// we need to shift the alpha value to 0x01000000 position
const a = (intVal / 0x00000001) & 0xff;
intVal = (intVal >>> 8) + (a & 0xff) * 0x01000000;
}
return intVal;
}
equals(value) {
return value && this.argb === value.argb;
}
static equals(value1, value2) {
// both values are falsy
if (!value1 && !value2) {
return true;
}
// only one is falsy
if (!value1 || !value2) {
return false;
}
return value1.equals(value2);
}
static isValid(value) {
if (value instanceof Color) {
return true;
}
if (!types.isString(value)) {
return false;
}
const lowered = value.toLowerCase();
if (knownColors.isKnownName(lowered)) {
return true;
}
return HEX_REGEX.test(value) || isRgbOrRgba(lowered) || isHslOrHsla(lowered);
}
static fromHSL(a, h, s, l) {
return new Color(a, h, s, l, 'hsl');
}
static fromHSV(a, h, s, l) {
return new Color(a, h, s, l, 'hsv');
}
toString() {
return this.hex;
}
/**
* @param {UIColor} value
*/
static fromIosColor(value) {
return undefined;
}
/**
* return true if brightness < 128
*
*/
isDark() {
return this.getBrightness() < 128;
}
/**
* return true if brightness >= 128
*
*/
isLight() {
return !this.isDark();
}
/**
* return the [brightness](http://www.w3.org/TR/AERT#color-contrast)
*
*/
getBrightness() {
return (this.r * 299 + this.g * 587 + this.b * 114) / 1000;
}
/**
* return the [luminance](http://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef)
*
*/
getLuminance() {
let R, G, B;
const RsRGB = this.r / 255;
const GsRGB = this.g / 255;
const BsRGB = this.b / 255;
if (RsRGB <= 0.03928) {
R = RsRGB / 12.92;
}
else {
R = Math.pow((RsRGB + 0.055) / 1.055, 2.4);
}
if (GsRGB <= 0.03928) {
G = GsRGB / 12.92;
}
else {
G = Math.pow((GsRGB + 0.055) / 1.055, 2.4);
}
if (BsRGB <= 0.03928) {
B = BsRGB / 12.92;
}
else {
B = Math.pow((BsRGB + 0.055) / 1.055, 2.4);
}
return 0.2126 * R + 0.7152 * G + 0.0722 * B;
}
/**
* Return this color (as a new Color instance) with the provided alpha
*
* @param alpha (between 0 and 255)
*/
setAlpha(a) {
return new Color(a, this.r, this.g, this.b);
}
/**
* return the hsl representation of the color
*
*/
toHsl() {
return { ...rgbToHsl(this.r, this.g, this.b), a: this.a };
}
/**
* return the [CSS hsv](https://www.w3schools.com/Css/css_colors_hsl.asp) representation of the color
*
*/
toHslString() {
const hsl = rgbToHsl(this.r, this.g, this.b);
const h = Math.round(hsl.h), s = Math.round(hsl.s), l = Math.round(hsl.l);
const a = this.a;
return a == 255 ? 'hsl(' + h + ', ' + s + '%, ' + l + '%)' : 'hsla(' + h + ', ' + s + '%, ' + l + '%, ' + (a / 255).toFixed(2) + ')';
}
/**
* return the hsv representation of the color
*
*/
toHsv() {
return { ...rgbToHsv(this.r, this.g, this.b), a: this.a };
}
/**
* return the [CSS hsv](https://www.w3schools.com/Css/css_colors_rgb.asp) representation of the color
*
*/
toHsvString() {
const hsv = rgbToHsv(this.r, this.g, this.b);
const h = Math.round(hsv.h * 360), s = Math.round(hsv.s * 100), v = Math.round(hsv.v * 100);
const a = this.a;
return a == 255 ? 'hsv(' + h + ', ' + s + '%, ' + v + '%)' : 'hsva(' + h + ', ' + s + '%, ' + v + '%, ' + (a / 255).toFixed(2) + ')';
}
/**
* return the [CSS rgb](https://www.w3schools.com/Css/css_colors_rgb.asp) representation of the color
*
*/
toRgbString() {
const a = this.a;
return a == 1 ? 'rgb(' + Math.round(this.r) + ', ' + Math.round(this.g) + ', ' + Math.round(this.b) + ')' : 'rgba(' + Math.round(this.r) + ', ' + Math.round(this.g) + ', ' + Math.round(this.b) + ', ' + (a / 255).toFixed(2) + ')';
}
/**
* Desaturate the color a given amount, from 0 to 100. Providing 100 will is the same as calling greyscale.
*
* @param amount (between 0 and 100)
*/
desaturate(amount) {
amount = amount === 0 ? 0 : amount || 10;
const hsl = rgbToHsl(this.r, this.g, this.b);
return Color.fromHSL(this.a, hsl.h, Math.min(100, Math.max(0, hsl.s - amount)), hsl.l);
}
/**
* Saturate the color a given amount, from 0 to 100.
*
* @param amount (between 0 and 100)
*/
saturate(amount) {
amount = amount === 0 ? 0 : amount || 10;
const hsl = rgbToHsl(this.r, this.g, this.b);
return Color.fromHSL(this.a, hsl.h, Math.min(100, Math.max(0, hsl.s + amount)), hsl.l);
}
/**
* Completely desaturates a color into greyscale. Same as calling desaturate(100).
*
*/
greyscale() {
return this.desaturate(100);
}
/**
* Lighten the color a given amount, from 0 to 100. Providing 100 will always return white.
*
* @param amount (between 0 and 100)
*/
lighten(amount) {
amount = amount === 0 ? 0 : amount || 10;
const hsl = rgbToHsl(this.r, this.g, this.b);
return Color.fromHSL(this.a, hsl.h, hsl.s, Math.min(100, Math.max(0, hsl.l + amount)));
}
/**
* Brighten the color a given amount, from 0 to 100.
*
* @param amount (between 0 and 100)
*/
brighten(amount) {
amount = amount === 0 ? 0 : amount || 10;
const r = Math.max(0, Math.min(255, this.r - Math.round(255 * -(amount / 100))));
const g = Math.max(0, Math.min(255, this.g - Math.round(255 * -(amount / 100))));
const b = Math.max(0, Math.min(255, this.b - Math.round(255 * -(amount / 100))));
return new Color(this.a, r, g, b);
}
/**
* Darken the color a given amount, from 0 to 100. Providing 100 will always return black.
*
* @param amount (between 0 and 100)
*/
darken(amount) {
amount = amount === 0 ? 0 : amount || 10;
const hsl = rgbToHsl(this.r, this.g, this.b);
return Color.fromHSL(this.a, hsl.h, hsl.s, Math.min(100, Math.max(0, hsl.l - amount)));
}
/**
* Spin the hue a given amount, from -360 to 360. Calling with 0, 360, or -360 will do nothing (since it sets the hue back to what it was before).
*
* @param amount (between -360 and 360)
*/
spin(amount) {
const hsl = this.toHsl();
const hue = (hsl.h + amount) % 360;
hsl.h = hue < 0 ? 360 + hue : hue;
return Color.fromHSL(this.a, hsl.h, hsl.s, hsl.l);
}
/**
* returns the color complement
*
*/
complement() {
const hsl = this.toHsl();
hsl.h = (hsl.h + 180) % 360;
return Color.fromHSL(this.a, hsl.h, hsl.s, hsl.l);
}
static mix(color1, color2, amount = 50) {
const p = amount / 100;
const rgba = {
r: (color2.r - color1.r) * p + color1.r,
g: (color2.g - color1.g) * p + color1.g,
b: (color2.b - color1.b) * p + color1.b,
a: (color2.a - color1.a) * p + color1.a,
};
return new Color(rgba.a, rgba.r, rgba.g, rgba.b);
}
}
function isRgbOrRgba(value) {
return (value.startsWith('rgb(') || value.startsWith('rgba(')) && value.endsWith(')');
}
function isHslOrHsla(value) {
return (value.startsWith('hsl') || value.startsWith('hsla(')) && value.endsWith(')');
}
function isHsvOrHsva(value) {
return (value.startsWith('hsv') || value.startsWith('hsva(')) && value.endsWith(')');
}
function parseColorWithAlpha(value) {
const separator = value.indexOf(',') !== -1 ? ',' : ' ';
const parts = value
.replace(/(rgb|hsl|hsv)a?\(/, '')
.replace(')', '')
.replace(/\//, ' ')
.replace(/%/g, '')
.split(separator)
.filter((part) => Boolean(part.length));
let f = 255;
let s = 255;
let t = 255;
let a = 255;
if (parts[0]) {
f = parseFloat(parts[0].trim());
}
if (parts[1]) {
s = parseFloat(parts[1].trim());
}
if (parts[2]) {
t = parseFloat(parts[2].trim());
}
if (parts[3]) {
a = Math.round(parseFloat(parts[3].trim()) * 255);
}
return { f, s, t, a };
}
function argbFromRgbOrRgba(value) {
const { f: r, s: g, t: b, a } = parseColorWithAlpha(value);
return (a & 0xff) * 0x01000000 + (r & 0xff) * 0x00010000 + (g & 0xff) * 0x00000100 + (b & 0xff);
}
function argbFromHslOrHsla(value) {
const { f: h, s: s, t: l, a } = parseColorWithAlpha(value);
const { r, g, b } = hslToRgb(h, s, l);
return (a & 0xff) * 0x01000000 + (r & 0xff) * 0x00010000 + (g & 0xff) * 0x00000100 + (b & 0xff);
}
function argbFromHsvOrHsva(value) {
const { f: h, s: s, t: v, a } = parseColorWithAlpha(value);
const { r, g, b } = hsvToRgb(h, s, v);
return (a & 0xff) * 0x01000000 + (r & 0xff) * 0x00010000 + (g & 0xff) * 0x00000100 + (b & 0xff);
}
// `rgbToHsl`
// Converts an RGB color value to HSL.
// *Assumes:* r, g, and b are contained in [0, 255]
// *Returns:* { h, s, l } in [0,360] and [0,100]
function rgbToHsl(r, g, b) {
r /= 255;
g /= 255;
b /= 255;
const max = Math.max(r, g, b), min = Math.min(r, g, b);
let h, s;
const l = (max + min) / 2;
if (max == min) {
h = s = 0; // achromatic
}
else {
const d = max - min;
s = l > 0.5 ? d / (2 - max - min) : d / (max + min);
switch (max) {
case r:
h = (g - b) / d + (g < b ? 6 : 0);
break;
case g:
h = (b - r) / d + 2;
break;
case b:
h = (r - g) / d + 4;
break;
}
h /= 6;
}
return { h: h * 360, s: s * 100, l: l * 100 };
}
function hue2rgb(p, q, t) {
if (t < 0)
t += 1;
if (t > 1)
t -= 1;
if (t < 1 / 6)
return p + (q - p) * 6 * t;
if (t < 1 / 2)
return q;
if (t < 2 / 3)
return p + (q - p) * (2 / 3 - t) * 6;
return p;
}
// `hslToRgb`
// Converts an HSL color value to RGB.
// *Assumes:* h is contained in [0, 360] and s and l are contained [0, 100]
// *Returns:* { r, g, b } in the set [0, 255]
function hslToRgb(h1, s1, l1) {
const h = (h1 % 360) / 360;
const s = s1 / 100;
const l = l1 / 100;
let r, g, b;
if (s === 0) {
r = g = b = l; // achromatic
}
else {
const q = l < 0.5 ? l * (1 + s) : l + s - l * s;
const p = 2 * l - q;
r = hue2rgb(p, q, h + 1 / 3);
g = hue2rgb(p, q, h);
b = hue2rgb(p, q, h - 1 / 3);
}
return { r: Math.round(r * 255), g: Math.round(g * 255), b: Math.round(b * 255) };
}
// `rgbToHsv`
// Converts an RGB color value to HSV
// *Assumes:* r, g, and b are contained in the set [0, 255]
// *Returns:* { h, s, v } in [0,360] and [0,100]
function rgbToHsv(r, g, b) {
r /= 255;
g /= 255;
b /= 255;
const max = Math.max(r, g, b), min = Math.min(r, g, b);
let h;
const v = max;
const d = max - min;
const s = max === 0 ? 0 : d / max;
if (max == min) {
h = 0; // achromatic
}
else {
switch (max) {
case r:
h = (g - b) / d + (g < b ? 6 : 0);
break;
case g:
h = (b - r) / d + 2;
break;
case b:
h = (r - g) / d + 4;
break;
}
h /= 6;
}
return { h: h * 360, s: s * 100, v: v * 100 };
}
// `hsvToRgb`
// Converts an HSV color value to RGB.
// *Assumes:* h is contained in [0, 360] and s and v are contained [0, 100]
// *Returns:* { r, g, b } in the set [0, 255]
function hsvToRgb(h1, s1, v1) {
const h = ((h1 % 360) / 360) * 6;
const s = s1 / 100;
const v = v1 / 100;
var i = Math.floor(h), f = h - i, p = v * (1 - s), q = v * (1 - f * s), t = v * (1 - (1 - f) * s), mod = i % 6, r = [v, q, p, p, t, v][mod], g = [t, v, v, q, p, p][mod], b = [p, p, t, v, v, q][mod];
return { r: r * 255, g: g * 255, b: b * 255 };
}
//# sourceMappingURL=color-common.js.map