{"_id":"@chancethedev/colors","_rev":"2-fc4542a23ce3a704d3a3c8286b9f0b68","name":"@chancethedev/colors","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.2":{"name":"@chancethedev/colors","version":"0.0.2","license":"Apache-2.0","repository":{"type":"git","url":"https://github.com/chancestrickland/chancethedev-design/tree/master/packages/colors"},"bugs":{"url":"https://github.com/chancestrickland/chancethedev-design/issues"},"main":"lib/index.js","module":"es/index.js","publishConfig":{"access":"public"},"scripts":{"build":"yarn clean && bundler bundle src/index.js --name Colors && node tasks/build.js && bundler check \"scss/*.scss\" && bundler sassdoc \"scss/*.scss\"","clean":"rimraf css es lib umd scss"},"devDependencies":{"@chancethedev/bundler":"^0.0.2","@chancethedev/cli-reporter":"^0.0.2","@chancethedev/scss-generator":"^0.0.2","@chancethedev/test-utils":"^0.0.2","change-case":"3.1.0","core-js":"3.2.1","fs-extra":"8.1.0","node-sass":"4.12.0","rimraf":"3.0.0"},"eyeglass":{"exports":false,"name":"@chancethedev/colors","sassDir":"scss","needs":"^1.3.0"},"description":"> Colors for digital and software products using the chancethedev Design System. A fork of [`@carbon/colors`](https://github.com/carbon-design-system/carbon/blob/master/packages/colors/README.md).","_id":"@chancethedev/colors@0.0.2","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"chancestrickland","email":"chance.strickland@gmail.com"},"dist":{"integrity":"sha512-mpa89WxVx0KiGBvLRjPZES2KZd66IaHaH0hR+wEjazK8s3KIj9dH3DxgGgr810XX65KR0b4w+WSZzt0IlCm+rg==","shasum":"5a5c03c76bb698c94995f4954acdc35861f2c7b5","tarball":"https://registry.npmjs.org/@chancethedev/colors/-/colors-0.0.2.tgz","fileCount":8,"unpackedSize":24933,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJddbYGCRA9TVsSAnZWagAANHUQAJXN1ivPDfctoT8eo5mY\nEcKghYaeR/MiMe4jIiYOPZdGzrB24IGaBCbrt3x6pRRnv/a0tbf5mbcnhAja\n2VzI6hgCH6F/6RoGSWQSpN2Uhi4rHQmkJzva564BCkgpK5Fc+szsYuH/6cCd\n9ehcINTTNI/kkEoVsWtf2J8/bx8toj9Vjrle83HpYf/pwjLwdRCHsZvc6MtQ\n64vHXb7xEofT2TZmWpuP6y9pLkqHw0wfL8SRfu1dVlGrE2hbuhYXqroxW9M2\ndNBWpfpseJwmwA9z0RTYWyWmV+I9fVFUSBDJtQTd7FdCWg4cc3ZAswSBe4w9\nuYbJDB+ONeBI3/SlVLr1rukHyJuRaBfxHCJcnmRBQvZ2s8DVsfQ36QWaUxhf\nX9eghOgQ9/gUs2Jqr+KjwckvaI4UEucz6b/cH+v7fF1zEyAuhg/CVTfOgOQ8\nKP+Oc4KNFIyHiqSqtvBDshYOxbqP3PYNt4gA+8/IDjiywGQ9233rz5nxRzrl\niQ7sn7kZZsAEj6Sfs7x2VTdEKsYuxHU6oWt1IuXoZgY6Ja6gRD4th48N8PBL\nWgUbhjWnIcrlrEq50cD5DNwEW/TXD6eLHtTASnr+KGvbvWDp1HL4pj7IZwqP\nybro0ComHex3iLXKvV6dcX0pwPtCrcOtNzpjAC8sFWXo3Fv3Y8DXy1a2L9Y2\nzPFO\r\n=wbT4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC82XGEefqZKWaJIh5Z9pnWtviJjRzY3ByxfsUGSt2bbAIhAMKg4Ij/S6KppeOx7Cdf+yanNOSF5kMEwKc+6uhYIv+J"}]},"maintainers":[{"name":"chancestrickland","email":"chance.strickland@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/colors_0.0.2_1567995397988_0.2771848909869208"},"_hasShrinkwrap":false},"0.0.3":{"name":"@chancethedev/colors","version":"0.0.3","license":"Apache-2.0","repository":{"type":"git","url":"https://github.com/chancestrickland/chancethedev-design/tree/master/packages/colors"},"bugs":{"url":"https://github.com/chancestrickland/chancethedev-design/issues"},"main":"lib/index.js","module":"es/index.js","publishConfig":{"access":"public"},"scripts":{"build":"yarn clean && bundler bundle src/index.js --name Colors && node tasks/build.js && bundler check \"scss/*.scss\" && bundler sassdoc \"scss/*.scss\"","clean":"rimraf css es lib umd scss"},"devDependencies":{"@chancethedev/bundler":"^0.0.2","@chancethedev/cli-reporter":"^0.0.2","@chancethedev/scss-generator":"^0.0.2","@chancethedev/test-utils":"^0.0.2","change-case":"3.1.0","core-js":"3.2.1","fs-extra":"8.1.0","node-sass":"4.12.0","rimraf":"3.0.0"},"eyeglass":{"exports":false,"name":"@chancethedev/colors","sassDir":"scss","needs":"^1.3.0"},"description":"> Colors for digital and software products using the chancethedev Design System. A fork of [`@carbon/colors`](https://github.com/carbon-design-system/carbon/blob/master/packages/colors/README.md).","_id":"@chancethedev/colors@0.0.3","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"chancestrickland","email":"chance.strickland@gmail.com"},"dist":{"integrity":"sha512-NR3TXmT1hgcn5DU1zbsmAK4IOTs64fChuJu4skGJDFYUdRPAJlDcuAMwvwKVGFxwJB4b7zkHDTcM8XR5vlq4pA==","shasum":"d5bc76062e9487f2f1dd0557f9b4284dc6b11227","tarball":"https://registry.npmjs.org/@chancethedev/colors/-/colors-0.0.3.tgz","fileCount":8,"unpackedSize":24862,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdddiwCRA9TVsSAnZWagAAX2AQAJyo46jGOybufQL6KbgA\nPuaxaiA7gVOl2shpi+ITjqJbtWhIPacGbj8o3fHvrv4ANFF1QiaSHkPDxGSM\nnLjHLXZZm80+cKN7wg/9S4SqqTR5657Z7RGh8+cs0eGLghWLio5ugkWV21p5\nKPgWP+f9UnqL71DQmh2GZMoxPc4fBJtP1gmqVbUYkqmhRE9hXhBcbeQcQS5x\nydpqNi0MMXFZnPZl8iSyuNH8DVmZVELriBTK/uCh9xvIuSfur0YBQhLzwOJU\nrvMOIuU9lBEV1xrXQg6wPtpwZ8vPyfQMRo/+Q+lTtduCmdA6YQ7+kXa4Pt+z\nyGGJNLoMXRMUVHYx7aKGQM9GGwK0bY9DoGnSG0uaXo1CeVDHo4lX0mHW1ReT\ntKpt0IMD5FCSwgraLek3ALpVLGLX3evTzKmsy/iXxxndRG1TFWtlKFdbsp0i\nddZfnjlLAnuVb0iaZgHO5SsfFnLe3QoBU+3BQ9sEu9dGmO2aTRrQyz4KLICM\nFfnDV+gIq93ZrCS5l7LKUF9S/esduBDBGYSIUuLbETpO6Sf4t73II/7KCwra\nQEHEl5enamXvvxEglrEwR00T8cMCefulyby1dI0PRx8nwtmwccuX1q0sYfN/\nRf4/XN7edAxV9r1aP3NyqoRcXPSohmmWrZhtAzTSElB1bhOAiB19m5MMTEc3\nUsCr\r\n=mkWJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICsKzV22LTjiodXFqbTqHFacnkeSxd1cRxW+jVXuh3KdAiBHn3URs7uuWMzAUr9vwenDj6TSG8TzHylDxwQMqZXXkw=="}]},"maintainers":[{"name":"chancestrickland","email":"chance.strickland@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/colors_0.0.3_1568004271458_0.4041245196427403"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-09T02:16:37.773Z","0.0.2":"2019-09-09T02:16:38.148Z","modified":"2022-04-04T22:30:08.246Z","0.0.3":"2019-09-09T04:44:31.642Z"},"maintainers":[{"name":"chancestrickland","email":"chance.strickland@gmail.com"}],"description":"> Colors for digital and software products using the chancethedev Design System. A fork of [`@carbon/colors`](https://github.com/carbon-design-system/carbon/blob/master/packages/colors/README.md).","repository":{"type":"git","url":"https://github.com/chancestrickland/chancethedev-design/tree/master/packages/colors"},"bugs":{"url":"https://github.com/chancestrickland/chancethedev-design/issues"},"license":"Apache-2.0","readme":"# @chancethedev/colors\n\n> Colors for digital and software products using the chancethedev Design System. A fork of [`@carbon/colors`](https://github.com/carbon-design-system/carbon/blob/master/packages/colors/README.md).\n\n## Getting started\n\nTODO\n\n## Usage\n\nYou can use the `@chancethedev/colors` module in your JavaScript, in addition to your Sass.\n\n### Sass\n\nIn Sass, you can import the files individual by doing:\n\n```scss\n@import '@chancethedev/colors/scss/colors';\n```\n\nThis file automatically includes the `chancethedev--colors` mixin which initializes\nall the color variables for the design system.\n\nThese color variables follow the naming convention: `$chancethedev--<swatch>-<grade>`.\nFor example:\n\n```scss\n$chancethedev--blue-50;\n$chancethedev--cool-gray-10;\n$chancethedev--black-100;\n$chancethedev--white-0;\n```\n\nYou can also use the shorthand form of these colors by dropping the `chancethedev--`\nnamespace:\n\n```scss\n$blue-50;\n$cool-gray-10;\n$black-100;\n$white-0;\n```\n\n_Note: the shorthand variables require that you do not have any other\nconflicting variables in your setup. Namespaced variables are always preferred\nfor this reason, unless you are confident that no collisions will occur._\n\nIf you would like you choose when these variables are defined, then you can call\nthe `chancethedev--colors` mixin directly by importing the following file:\n\n```scss\n@import '@chancethedev/colors/scss/mixins';\n\n// ...\n@include chancethedev--colors();\n```\n\nAlongside the color variables detailed above, we also provide a map of colors so\nthat you can programmatically use these values. This map is called\n`$chancethedev--colors` and each key is the name of a swatch. The value of these\nswatches is also a map, but each key is now the grade. In code, this looks like\nthe following:\n\n<!-- prettier-ignore-start -->\n\n```scss\n$chancethedev--colors: (\n  'blue': (\n    10: #edf4ff,\n    // ...\n  )\n);\n```\n\n<!-- prettier-ignore-end -->\n\nYou can include this variable by including `@chancethedev/colors/scss/colors` or\ncalling the `chancethedev--colors()` mixin directly.\n\n### JavaScript\n\nFor JavaScript, you can import and use this module by doing the following in\nyour code:\n\n```js\n// ESM\nimport { black, blue, warmGray } from '@chancethedev/colors';\n\n// CommonJS\nconst { black, blue, warmGray } = require('@chancethedev/colors');\n```\n\nEach color swatch is exported as a variable, and each color name is also\nexported as an object that can be called by specifying grade, for example:\n\n```js\nblack;\nblue[50]; // Using the `blue` object.\nwarmGray100; // Using the `warmGray100` variable.\n```\n\n## 📖 API Documentation\n\nIf you're looking for `@chancethedev/colors` API documentation, check out:\n\n- [Sass](./docs/sass.md)\n\n## 🙌 Contributing\n\nWe're always looking for contributors to help us fix bugs, build new features,\nor help us improve the project documentation. If you're interested, definitely\ncheck out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀\n\n## 📝 License\n\nLicensed under the [Apache 2.0 License](/LICENSE).\n","readmeFilename":"README.md"}