npm - color-contrast-finder - Versions diffs - 1.0.0 - Mend

color-contrast-finder 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/LICENSE +21 -0
package/README.md +111 -0
package/dist/color-contrast-finder.js +208 -0
package/dist/color-contrast-finder.umd.cjs +1 -0
package/dist/index.d.ts +1 -0
package/dist/main.d.ts +8 -0
package/dist/types.d.ts +16 -0
package/package.json +74 -0

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2024 Chad.K
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,111 @@
+# Color Contrast Finder
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+The **Color Contrast Finder** is a library that automatically selects text colors that contrast with a given color. The library supports a variety of color formats (HEX, RGB, RGBA) and allows for user-defined thresholds and default color settings.
+<br>
+## Features
+- Support for HEX, RGB, and RGBA color formats
+- Color contrast calculation taking into account transparency (Alpha)
+- Support for user-defined brightness thresholds
+- Customizable for high and low brightness colors
+- Easy to use and flexible settings
+<br>
+## Installation
+```bash
+# with npm
+$ npm i color-contrast-finder
+# with Yarn
+$ yarn add color-contrast-finder
+# with pnpm
+$ pnpm add color-contrast-finder
+```
+<br>
+## Usage
+```javascript
+// module
+import { findContrastColor } from 'color-contrast-finder';
+/**
+ * `options.color` types:
+ *   - `#f00`    // rgba(255, 0, 0, 1)  (Short hex code with no alpha channel)
+ *   - `#f00f`   // rgba(255, 0, 0, 1)  (Short hex code with alpha channel)
+ *   - `#ffffff` // rgba(255, 255, 255, 1)  (Full hex code with no alpha channel)
+ *   - `#ffffffff` // rgba(255, 255, 255, 1)  (Full hex code with alpha channel)
+ *   - `rgb(255, 255, 255)` // rgba(255, 255, 255, 1)  (RGB color with no alpha channel)
+ *   - `rgba(255, 255, 255, 0.3)` // rgba(255, 255, 255, 0.3)  (RGBA color with alpha channel)
+ */
+const options = {
+  color: '#3498db', // input color (in HEX, RGB, RGBA format)
+  threshold: 0.5, // brightness threshold (default: 0.5)
+  highColor: 'black', // text color to use when high brightness  (default: #000000)
+  lowColor: 'white' // text color to use when low brightness (default: #FFFFFF)
+};
+const contrastColor = findContrastColor(options);
+console.log(contrastColor); // 'black' or 'white'
+```
+```javascript
+// umd
+/**
+ * html code
+ * <script type="text/javascript" src="{path}/color-contrast-finder.umd.cjs"></script>
+ */
+ const contrastColor = window['color-contrast-finder'].findContrastColor(options);
+ console.log(contrastColor); // 'black' or 'white'
+```
+<br>
+![alt text](https://github.com/user-attachments/assets/2752c37e-aea0-43b5-b8e8-ccfb9ad3f064)
+<br>
+## License
+[MIT](LICENSE).
+<br>
+## TODO
+- [x] Function findContrastColor
+- [x] Library build
+- [x] Changesets setup
+- [x] CI (lint)
+- [x] CD (npm publish)
+- [x] NPM publish
+<br>
+## How to use publish
+```bash
+# 1. pnpm changeset
+$ pnpm cs
+# 2. Input next version
+# 3. New file created in the .changeset folder
+# 4. Commit & push new files
+# 5. Automatically generate, merge, and publish PRs with CD jobs running.
+```
+<br>

package/dist/color-contrast-finder.js ADDED Viewed

@@ -0,0 +1,208 @@
+const i = {
+  WHITE: "#FFFFFF",
+  BLACK: "#000000"
+}, b = 1, c = {
+  aliceblue: "#f0f8ff",
+  antiquewhite: "#faebd7",
+  aqua: "#00ffff",
+  aquamarine: "#7fffd4",
+  azure: "#f0ffff",
+  beige: "#f5f5dc",
+  bisque: "#ffe4c4",
+  black: "#000000",
+  blanchedalmond: "#ffebcd",
+  blue: "#0000ff",
+  blueviolet: "#8a2be2",
+  brown: "#a52a2a",
+  burlywood: "#deb887",
+  cadetblue: "#5f9ea0",
+  chartreuse: "#7fff00",
+  chocolate: "#d2691e",
+  coral: "#ff7f50",
+  cornflowerblue: "#6495ed",
+  cornsilk: "#fff8dc",
+  crimson: "#dc143c",
+  cyan: "#00ffff",
+  darkblue: "#00008b",
+  darkcyan: "#008b8b",
+  darkgoldenrod: "#b8860b",
+  darkgray: "#a9a9a9",
+  darkgreen: "#006400",
+  darkgrey: "#a9a9a9",
+  darkkhaki: "#bdb76b",
+  darkmagenta: "#8b008b",
+  darkolivegreen: "#556b2f",
+  darkorange: "#ff8c00",
+  darkorchid: "#9932cc",
+  darkred: "#8b0000",
+  darksalmon: "#e9967a",
+  darkseagreen: "#8fbc8f",
+  darkslateblue: "#483d8b",
+  darkslategray: "#2f4f4f",
+  darkslategrey: "#2f4f4f",
+  darkturquoise: "#00ced1",
+  darkviolet: "#9400d3",
+  deeppink: "#ff1493",
+  deepskyblue: "#00bfff",
+  dimgray: "#696969",
+  dimgrey: "#696969",
+  dodgerblue: "#1e90ff",
+  firebrick: "#b22222",
+  floralwhite: "#fffaf0",
+  forestgreen: "#228b22",
+  fuchsia: "#ff00ff",
+  gainsboro: "#dcdcdc",
+  ghostwhite: "#f8f8ff",
+  gold: "#ffd700",
+  goldenrod: "#daa520",
+  gray: "#808080",
+  green: "#008000",
+  greenyellow: "#adff2f",
+  grey: "#808080",
+  honeydew: "#f0fff0",
+  hotpink: "#ff69b4",
+  indianred: "#cd5c5c",
+  indigo: "#4b0082",
+  ivory: "#fffff0",
+  khaki: "#f0e68c",
+  lavender: "#e6e6fa",
+  lavenderblush: "#fff0f5",
+  lawngreen: "#7cfc00",
+  lemonchiffon: "#fffacd",
+  lightblue: "#add8e6",
+  lightcoral: "#f08080",
+  lightcyan: "#e0ffff",
+  lightgoldenrodyellow: "#fafad2",
+  lightgray: "#d3d3d3",
+  lightgreen: "#90ee90",
+  lightgrey: "#d3d3d3",
+  lightpink: "#ffb6c1",
+  lightsalmon: "#ffa07a",
+  lightseagreen: "#20b2aa",
+  lightskyblue: "#87cefa",
+  lightslategray: "#778899",
+  lightslategrey: "#778899",
+  lightsteelblue: "#b0c4de",
+  lightyellow: "#ffffe0",
+  lime: "#00ff00",
+  limegreen: "#32cd32",
+  linen: "#faf0e6",
+  magenta: "#ff00ff",
+  maroon: "#800000",
+  mediumaquamarine: "#66cdaa",
+  mediumblue: "#0000cd",
+  mediumorchid: "#ba55d3",
+  mediumpurple: "#9370db",
+  mediumseagreen: "#3cb371",
+  mediumslateblue: "#7b68ee",
+  mediumspringgreen: "#00fa9a",
+  mediumturquoise: "#48d1cc",
+  mediumvioletred: "#c71585",
+  midnightblue: "#191970",
+  mintcream: "#f5fffa",
+  mistyrose: "#ffe4e1",
+  moccasin: "#ffe4b5",
+  navajowhite: "#ffdead",
+  navy: "#000080",
+  oldlace: "#fdf5e6",
+  olive: "#808000",
+  olivedrab: "#6b8e23",
+  orange: "#ffa500",
+  orangered: "#ff4500",
+  orchid: "#da70d6",
+  palegoldenrod: "#eee8aa",
+  palegreen: "#98fb98",
+  paleturquoise: "#afeeee",
+  palevioletred: "#db7093",
+  papayawhip: "#ffefd5",
+  peachpuff: "#ffdab9",
+  peru: "#cd853f",
+  pink: "#ffc0cb",
+  plum: "#dda0dd",
+  powderblue: "#b0e0e6",
+  purple: "#800080",
+  red: "#ff0000",
+  rosybrown: "#bc8f8f",
+  royalblue: "#4169e1",
+  saddlebrown: "#8b4513",
+  salmon: "#fa8072",
+  sandybrown: "#f4a460",
+  seagreen: "#2e8b57",
+  seashell: "#fff5ee",
+  sienna: "#a0522d",
+  silver: "#c0c0c0",
+  skyblue: "#87ceeb",
+  slateblue: "#6a5acd",
+  slategray: "#708090",
+  slategrey: "#708090",
+  snow: "#fffafa",
+  springgreen: "#00ff7f",
+  steelblue: "#4682b4",
+  tan: "#d2b48c",
+  teal: "#008080",
+  thistle: "#d8bfd8",
+  tomato: "#ff6347",
+  turquoise: "#40e0d0",
+  violet: "#ee82ee",
+  wheat: "#f5deb3",
+  white: "#ffffff",
+  whitesmoke: "#f5f5f5",
+  yellow: "#ffff00",
+  yellowgreen: "#9acd32"
+};
+function m(a) {
+  if (!/^#?([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$/.test(a))
+    throw new Error("Invalid HEX color code");
+  const f = a.replace(/^#/, ""), r = f.length === 3 ? f.split("").map((o) => o + o).join("") : f, n = parseInt(r, 16);
+  return {
+    r: n >> 16 & 255,
+    g: n >> 8 & 255,
+    b: n & 255,
+    a: b
+  };
+}
+function h(a) {
+  const f = /rgba?\((\d+),\s*(\d+),\s*(\d+)(?:,\s*(\d*\.?\d+))?\)/.exec(a);
+  if (!f)
+    throw new Error("Invalid RGB color code");
+  const [, r, n, o, d] = f;
+  return {
+    r: parseInt(r, 10),
+    g: parseInt(n, 10),
+    b: parseInt(o, 10),
+    a: d ? parseFloat(d) : b
+  };
+}
+function k(a) {
+  let e = a.trim().toLowerCase();
+  if (e in c && (e = c[e]), e.startsWith("#"))
+    return m(e);
+  if (e.startsWith("rgb")) {
+    const f = h(e);
+    if (f)
+      return f;
+    throw new Error("Invalid RGB color format");
+  }
+  throw new Error("Invalid color format");
+}
+function s({ r: a, g: e, b: f }) {
+  const r = (t) => {
+    const l = t / 255;
+    return l <= 0.03928 ? l / 12.92 : Math.pow((l + 0.055) / 1.055, 2.4);
+  }, n = r(a), o = r(e), d = r(f);
+  return n * 0.2126 + o * 0.7152 + d * 0.0722;
+}
+function w(a, e) {
+  const f = s({ r: 255, g: 255, b: 255 });
+  return a < 1 ? a * e + (1 - a) * f : e;
+}
+function p(a, e, f, r) {
+  return a >= e ? f : r;
+}
+function y(a) {
+  const { color: e, threshold: f = 0.5, highColor: r = i.BLACK, lowColor: n = i.WHITE } = a, { r: o, g: d, b: t, a: l } = k(e), g = s({ r: o, g: d, b: t }), u = w(l, g);
+  return p(u, f, r, n);
+}
+export {
+  y as findContrastColor
+};

package/dist/color-contrast-finder.umd.cjs ADDED Viewed

@@ -0,0 +1 @@

package/dist/index.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export * from './main'

package/dist/main.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+import { ColorContrastOptions, RGBAColor } from './types';
+/**
+ * Finds the best contrast color for text based on the provided options.
+ * @param {ColorContrastOptions} options - Configuration for contrast color selection
+ * @returns {string} Best contrast color for the text
+ */
+export declare function findContrastColor(options: ColorContrastOptions): string;
+export type { ColorContrastOptions, RGBAColor };

package/dist/types.d.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import { CSS_COLORS } from './constants';
+export type RGBAColor = {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+};
+type CSSColorKey = keyof typeof CSS_COLORS;
+export type InputColor = CSSColorKey | string;
+export type ColorContrastOptions = {
+    color: InputColor;
+    threshold?: number;
+    highColor?: string;
+    lowColor?: string;
+};
+export {};

package/package.json ADDED Viewed

@@ -0,0 +1,74 @@
+{
+  "name": "color-contrast-finder",
+  "description": "The Color Contrast Finder is a library that automatically selects text colors that contrast with a given color.",
+  "version": "1.0.0",
+  "author": "Chad.K <kangqod@naver.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kangqod/color-contrast-finder.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kangqod/color-contrast-finder.git/issues"
+  },
+  "homepage": "https://github.com/kangqod/color-contrast-finder.git#readme",
+  "engines": {
+    "node": ">=20.14.0",
+    "pnpm": ">=9.4.0"
+  },
+  "type": "module",
+  "files": [
+    "dist",
+    "index.d.ts"
+  ],
+  "keywords": [
+    "typescript",
+    "color-contrast",
+    "color-contrast-finder",
+    "color-utils"
+  ],
+  "main": "./dist/color-contrast-finder.js",
+  "module": "./dist/color-contrast-finder.umd.cjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/color-contrast-finder.js",
+      "require": "./dist/color-contrast-finder.umd.cjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@changesets/cli": "^2.27.7"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.8.0",
+    "eslint": "9.x",
+    "eslint-config-airbnb-typescript": "^18.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "globals": "^15.9.0",
+    "prettier": "^3.3.3",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^8.0.1",
+    "vite": "^5.2.10",
+    "vite-plugin-dts": "^4.0.1",
+    "vitest": "^2.0.5"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint ./lib ./src --cache",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "format:check": "prettier --check ./lib ./src --cache",
+    "format:write": "prettier --write ./lib ./src --cache",
+    "coverage": "vitest run --coverage",
+    "cs": "changeset",
+    "cs-v": "changeset version",
+    "cs-t": "changeset tag",
+    "release": "changeset publish"
+  }
+}