{"_id":"a11y-contrast-color","_rev":"14-e3990e44adc45dd808b62db180dcea80","name":"a11y-contrast-color","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.2":{"name":"a11y-contrast-color","version":"1.0.2","author":{"name":"Moonki Kim","email":"moonki.kim.kr@gmail.com"},"license":"MIT","_id":"a11y-contrast-color@1.0.2","maintainers":[{"name":"moong23","email":"moonki0623@naver.com"}],"homepage":"https://github.com/moong23/a11y-contrast-color#a11y-contrast-color","bugs":{"url":"https://github.com/moong23/a11y-contrast-color/issues"},"dist":{"shasum":"b430723a441a913ca680d6be2ef5f32798726b34","tarball":"https://registry.npmjs.org/a11y-contrast-color/-/a11y-contrast-color-1.0.2.tgz","fileCount":12,"integrity":"sha512-8+FQE75Dx2RTFvwc0jW/85pRV407nWhIOaY4a0/cNGGUzNDw7js8KFB/Cwyb1LUuKUEqCNOWmnt74MbRGnCMbA==","signatures":[{"sig":"MEYCIQCoZZ/uC/2Bz+zxyicFNMtESWzuj9O3mWlemBJ6OM1NEQIhANzewWzwoipT73joIbda1OnCp9c/KeOUQhtULRjIIAVB","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":15873},"main":"dist/src/index.js","type":"commonjs","types":"./dist/src/index.d.ts","gitHead":"3e3b737cc67ff1f229b62f70ae96b613341d19a1","scripts":{"test":"jest","build":"tsc","start":"npm run build && node dist/src/index.js","coverage":"jest --coverage"},"_npmUser":{"name":"moong23","email":"moonki0623@naver.com"},"repository":{"url":"git+https://github.com/moong23/a11y-contrast-color.git","type":"git"},"_npmVersion":"10.8.1","description":"A utility library for calculating luminance, contrast ratio, and appropriate contrast colors to ensure web accessibility.","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.2.4","typescript":"^5.5.4","@types/jest":"^29.5.12"},"_npmOperationalInternal":{"tmp":"tmp/a11y-contrast-color_1.0.2_1722937495541_0.48226884614038057","host":"s3://npm-registry-packages"}},"1.0.4":{"name":"a11y-contrast-color","version":"1.0.4","keywords":["a11y","accessibility","contrast","color","luminance","ratio"],"author":{"name":"Moonki Kim","email":"moonki.kim.kr@gmail.com"},"license":"MIT","_id":"a11y-contrast-color@1.0.4","maintainers":[{"name":"moong23","email":"moonki0623@naver.com"}],"homepage":"https://github.com/moong23/a11y-contrast-color#a11y-contrast-color","bugs":{"url":"https://github.com/moong23/a11y-contrast-color/issues"},"dist":{"shasum":"249ae180b522ef3fa6d60db982e558a81e8af878","tarball":"https://registry.npmjs.org/a11y-contrast-color/-/a11y-contrast-color-1.0.4.tgz","fileCount":12,"integrity":"sha512-JQ11U4Ls67ncYoCuutZlJwDQ3CKyA2GVbp2y2CvYsEmVhFVtMBUXvkee2foDMqEvjKpqbS9Vt/8q39DBOVnnww==","signatures":[{"sig":"MEUCIDP2Pq8UnB5P9t9y6CNFktsH1GA6S5wNu/e3qgN7KQLzAiEAwx+hovxJmt3V88rwO1HdfK0xXfDrdujdpcasOyqHJsA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":15735},"main":"dist/src/index.js","type":"commonjs","types":"./dist/src/index.d.ts","gitHead":"ac0fc22c74581a036de7dcb73a2af1d22e79164a","scripts":{"test":"jest","build":"tsc","start":"npm run build && node dist/src/index.js","coverage":"jest --coverage"},"_npmUser":{"name":"moong23","email":"moonki0623@naver.com"},"repository":{"url":"git+https://github.com/moong23/a11y-contrast-color.git","type":"git"},"_npmVersion":"10.8.1","description":"A utility library for calculating luminance, contrast ratio, and appropriate contrast colors to ensure web accessibility.","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.2.4","typescript":"^5.5.4","@types/jest":"^29.5.12"},"_npmOperationalInternal":{"tmp":"tmp/a11y-contrast-color_1.0.4_1722994723190_0.6791898045358196","host":"s3://npm-registry-packages"}},"1.0.5":{"name":"a11y-contrast-color","version":"1.0.5","keywords":["a11y","accessibility","contrast","color","luminance","ratio"],"author":{"name":"Moonki Kim","email":"moonki.kim.kr@gmail.com"},"license":"MIT","_id":"a11y-contrast-color@1.0.5","maintainers":[{"name":"moong23","email":"moonki0623@naver.com"}],"homepage":"https://github.com/moong23/a11y-contrast-color#a11y-contrast-color","bugs":{"url":"https://github.com/moong23/a11y-contrast-color/issues"},"dist":{"shasum":"e1c102a8a612ab51ac1d386f5b0cc96f8f625d56","tarball":"https://registry.npmjs.org/a11y-contrast-color/-/a11y-contrast-color-1.0.5.tgz","fileCount":11,"integrity":"sha512-U9UIQ2OszaKocS9I0iSkvdpoZDOAM3zRYSJcjEYS/AulS6V4zl7L7WK5Bc2tF5cj89JjNZbXSk5iIw7ZhiL2vg==","signatures":[{"sig":"MEQCIHpDk0fJb3MJOEWsQHvsLbl53FvLxs/ECRuVpjDuKU5pAiBVDBjJYcwwrcezCtDL7aCMoEiX2A4CG40zWzDet6jH0g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13221},"main":"./dist/src/index.js","type":"commonjs","types":"./dist/src/index.d.ts","gitHead":"135fe349db6f0782d0427e52ef6ca6d947fdad57","scripts":{"test":"jest","build":"tsc","start":"npm run build && node dist/src/index.js","coverage":"jest --coverage"},"_npmUser":{"name":"moong23","email":"moonki0623@naver.com"},"repository":{"url":"git+https://github.com/moong23/a11y-contrast-color.git","type":"git"},"_npmVersion":"10.8.1","description":"A utility library for calculating luminance, contrast ratio, and appropriate contrast colors to ensure web accessibility.","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.2.4","typescript":"^5.5.4","@types/jest":"^29.5.12"},"_npmOperationalInternal":{"tmp":"tmp/a11y-contrast-color_1.0.5_1723629810518_0.4189036670039272","host":"s3://npm-registry-packages"}},"1.0.7":{"name":"a11y-contrast-color","version":"1.0.7","keywords":["a11y","accessibility","contrast","color","luminance","ratio"],"author":{"name":"Moonki Kim","email":"moonki.kim.kr@gmail.com"},"license":"MIT","_id":"a11y-contrast-color@1.0.7","maintainers":[{"name":"moong23","email":"moonki0623@naver.com"}],"homepage":"https://github.com/moong23/a11y-contrast-color#a11y-contrast-color","bugs":{"url":"https://github.com/moong23/a11y-contrast-color/issues"},"dist":{"shasum":"ecef8fe1b015a535cdd59e46d68fac32a838624c","tarball":"https://registry.npmjs.org/a11y-contrast-color/-/a11y-contrast-color-1.0.7.tgz","fileCount":10,"integrity":"sha512-KAZrdaGJDguYMkcFoZnRoQIwTzTuWfd9lQtaE+yoTYSdxBIdD61bojJ67Eo/0XMJTaAUThOhG8h+9cQQ0yG6bA==","signatures":[{"sig":"MEYCIQC43lBDKGadQgiJxDTzNZIk0YHOPeP62ByqTDfcK5TYlQIhAKdHKgd3iAGeJMKEdB13TcoMNqEmwR+e0kTF9QSvC1nn","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":23397},"main":"./dist/src/index.js","type":"commonjs","types":"./dist/src/index.d.ts","gitHead":"135fe349db6f0782d0427e52ef6ca6d947fdad57","scripts":{"test":"jest","build":"tsc","start":"npm run build && node dist/src/index.js","coverage":"jest --coverage"},"_npmUser":{"name":"moong23","email":"moonki0623@naver.com"},"repository":{"url":"git+https://github.com/moong23/a11y-contrast-color.git","type":"git"},"_npmVersion":"10.8.1","description":"A utility library for calculating luminance, contrast ratio, and appropriate contrast colors to ensure web accessibility.","directories":{},"_nodeVersion":"20.16.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.2.4","typescript":"^5.5.4","@types/jest":"^29.5.12"},"_npmOperationalInternal":{"tmp":"tmp/a11y-contrast-color_1.0.7_1724052435757_0.40310990860787377","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"a11y-contrast-color","version":"1.1.0","description":"A utility library for calculating luminance, contrast ratio, and appropriate contrast colors to ensure web accessibility.","main":"./dist/src/index.js","scripts":{"build":"rm -rf ./dist && tsc","start":"npm run build && node dist/src/index.js","test":"jest","coverage":"jest --coverage"},"author":{"name":"Moonki Kim","email":"moonki.kim.kr@gmail.com"},"license":"MIT","type":"commonjs","repository":{"type":"git","url":"git+https://github.com/moong23/a11y-contrast-color.git"},"keywords":["a11y","accessibility","contrast","color","luminance","ratio"],"homepage":"https://github.com/moong23/a11y-contrast-color#a11y-contrast-color","devDependencies":{"@types/jest":"^29.5.12","jest":"^29.7.0","ts-jest":"^29.2.4","typescript":"^5.5.4"},"_id":"a11y-contrast-color@1.1.0","gitHead":"f8ee6d834b63eba3838b46767a880ae6be771bd0","types":"./dist/src/index.d.ts","bugs":{"url":"https://github.com/moong23/a11y-contrast-color/issues"},"_nodeVersion":"20.16.0","_npmVersion":"10.8.1","dist":{"integrity":"sha512-u12+mM43bzVqwP/6LEdXi4JxAcOpj+9F2jO75jZuhD2iX9S3MOXM6XPFJxpzst2jFIMhQARa+hQUzPGxEW5oIQ==","shasum":"1550085622ffa4c6eddd5435f001fe106551c2b8","tarball":"https://registry.npmjs.org/a11y-contrast-color/-/a11y-contrast-color-1.1.0.tgz","fileCount":10,"unpackedSize":23108,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDI9Ut0uPpXRoVW5eF3eaSnMtegkCU4LvStCdTGItq+kAiEA63kw9QaHNUl4NllBL1tTRP1rL8roTHUlGpis2AwkP+8="}]},"_npmUser":{"name":"moong23","email":"moonki0623@naver.com"},"directories":{},"maintainers":[{"name":"moong23","email":"moonki0623@naver.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/a11y-contrast-color_1.1.0_1724062433590_0.46949762725766475"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-06T03:27:10.080Z","modified":"2024-08-19T10:13:53.918Z","0.0.1":"2024-08-06T03:27:10.258Z","1.0.0":"2024-08-06T09:40:45.291Z","1.0.1":"2024-08-06T09:43:42.884Z","1.0.2":"2024-08-06T09:44:55.742Z","1.0.3":"2024-08-07T01:27:58.603Z","1.0.4":"2024-08-07T01:38:43.350Z","1.0.5":"2024-08-14T10:03:30.672Z","1.0.6":"2024-08-19T07:23:27.313Z","1.0.7":"2024-08-19T07:27:15.949Z","1.1.0":"2024-08-19T10:13:53.735Z"},"bugs":{"url":"https://github.com/moong23/a11y-contrast-color/issues"},"author":{"name":"Moonki Kim","email":"moonki.kim.kr@gmail.com"},"license":"MIT","homepage":"https://github.com/moong23/a11y-contrast-color#a11y-contrast-color","keywords":["a11y","accessibility","contrast","color","luminance","ratio"],"repository":{"type":"git","url":"git+https://github.com/moong23/a11y-contrast-color.git"},"description":"A utility library for calculating luminance, contrast ratio, and appropriate contrast colors to ensure web accessibility.","maintainers":[{"name":"moong23","email":"moonki0623@naver.com"}],"readme":"# 🎨 a11y-contrast-color 🎨\n\n[![version](https://img.shields.io/npm/v/a11y-contrast-color.svg?style=flat-square)](https://www.npmjs.com/package/a11y-contrast-color)\n[![downloads](https://img.shields.io/npm/dt/a11y-contrast-color)](https://npmtrends.com/a11y-contrast-color)\n[![Website Demo](https://img.shields.io/badge/Website-Demo-orange?style=flat-square)](https://a11y-contrast-color.vercel.app/)\n[![Github Repository](https://img.shields.io/badge/Github%20Repository-181717?style=flat-square&logo=Github&logoColor=white)](https://github.com/moong23/a11y-contrast-color)\n\n**a11y-contrast-color** is a utility library for calculating [luminance](https://www.w3.org/TR/WCAG20/relative-luminance.xml), [contrast ratio](https://www.w3.org/TR/WCAG20/#contrast-ratiodef), and recommending appropriate contrast colors to ensure accessibility compliance in web applications.\n\nIt helps developers easily determine whether text and background color combinations meet the [Web Content Accessibility Guidelines(WCAG) standards](https://www.w3.org/WAI/older-users/developing/#color) by providing functions to recommend contrast colors that can improve readability and accessibility.\n\n## Installation\n\n```sh\nnpm install a11y-contrast-color\n```\n\nOr\n\n```sh\nyarn add a11y-contrast-color\n```\n\n## Usage\n\n### `getLuminance`\n\nCalculates the luminance of a color.\n\n#### Parameters\n\n- color: RGB (required): An array of three numbers representing the `RGB values(value in the range of [0,255])` of the color.\n\n#### Returns\n\n- number: The calculated luminance value.\n\n```ts\nimport { getLuminance } from 'a11y-contrast-color';\n\nconst luminance = getLuminance([255, 0, 0]);\nconsole.log(luminance); // Output: 0.2126\n```\n\n### `getContrastRatio`\n\nCalculates the contrast ratio between two colors.\n\n#### Parameters\n\n- color1: RGB (required): The first color value in RGB format.\n- color2: RGB (required): The second color value in RGB format.\n\n#### Returns\n\n- number: The contrast ratio between the two luminance values.\n\n```ts\nimport { getContrastRatio } from 'a11y-contrast-color';\n\nconst color1 = [128, 128, 128];\nconst color2 = [255, 255, 255];\nconst contrastRatio = getContrastRatio(color1, color2);\nconsole.log(contrastRatio); // Output: 3.949439...\n```\n\n### `getContrastColor`\n\nDetermines the appropriate contrast color (black or white) for a given background color to ensure readability.\n\n#### Parameters\n\n- color: RGB (required): An array of three numbers representing the RGB values of the background color.\n- luminance: number (required): The target luminance ratio to be achieved or exceeded.\n\n#### Returns\n\n- RGB | null: An array representing the RGB values of the contrast color, or null if no suitable color is found.\n\n```ts\nimport { getContrastColor } from 'a11y-contrast-color';\n\nconst contrastColor = getContrastColor([255, 0, 0], 4.5);\nconsole.log(contrastColor); // Output: [R, G, B] || null depending on the contrast requirement\n```\n\n---\n\nAll projects are under the MIT license. Please refer to the [LICENSE](LICENSE) file for more information.\n","readmeFilename":"README.md"}