https://github.com/tabuckner/random-contrast-compliant
A SCSS helper to generate a Random color that is Compliant with your specified WCAG contrast guidelines.
https://github.com/tabuckner/random-contrast-compliant
Last synced: about 2 months ago
JSON representation
A SCSS helper to generate a Random color that is Compliant with your specified WCAG contrast guidelines.
- Host: GitHub
- URL: https://github.com/tabuckner/random-contrast-compliant
- Owner: tabuckner
- License: other
- Created: 2019-10-16T13:04:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T22:50:33.000Z (over 3 years ago)
- Last Synced: 2025-08-08T22:54:26.838Z (11 months ago)
- Language: CSS
- Size: 599 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Random-Contrast-Compliant
A SCSS helper to generate a Random Color that is Compliant with your specified WCAG contrast guidelines. Import into your SASS/SCSS files and use!
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
* An existing functional SASS/SCSS project.
* A functional import process.
* You’ll need to add Bourbon to your node-sass `includePaths` option. This project should be imported from `dist/_random-contrast-compliant.scss`. How you do this depends on how node-sass is integrated into your project.
### Installing
Install with `NPM` or `Yarn`
```
npm i -D @tabuckner/random-contrast-compliant
```
```
yarn add -D @tabuckner/random-contrast-compliant
```
## Running the tests
Tests are handled by [True](https://www.oddbird.net/true/) and [Jest](https://jestjs.io/).
```
yarn test
```
or...
```
yarn test --watch
```
### And coding style tests
Style Linting can be handled with:
```
yarn lint
```
## Deployment
Add additional notes about how to deploy this on a live system
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Taylor Buckner** - *Initial work* - [tabuckner](https://github.com/tabuckner)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* [Sergio Gomes](https://medium.com/@sergiomdgomes) - [WCAG Contrast in SASS](https://medium.com/dev-channel/using-sass-to-automatically-pick-text-colors-4ba7645d2796)