npm

npm’s 2019 JavaScript ecosystem survey analysis is now available!Get your copy here »

validate.io-color-hexadecimal

1.0.0 • Public • Published

Hexadecimal Color

NPM version Build Status Coverage Status Dependencies

Validates if a value is a hexadecimal color.

Installation

$ npm install validate.io-color-hexadecimal

For use in the browser, use browserify.

Usage

var isHexColor = require( 'validate.io-color-hexadecimal' );

isHexColor( value[, mode] )

Validates if a value is a hexadecimal color.

var bool = isHexColor( 'ffffff' );
// returns true

To validate for shorthand, full, or either shorthand or full hexadecimal colors, set the mode option.

  • full: (default) validate for a 6-digit hexadecimal color.
  • shorthand: validate for a shorthand (3-digit) hexadecimal color.
  • either: validate for either shorthand or full length hexadecimal colors.
var bool;
 
// Full length colors...
bool = isHexColor( 'ffffff', 'full' );
// returns true
 
bool = isHexColor( 'fff', 'full' );
// returns false
 
 
// Shorthand colors...
bool = isHexColor( 'ffffff', 'shorthand' );
// returns false
 
bool = isHexColor( 'fff', 'shorthand' );
// returns true
 
 
// Either shorthand or full length colors...
bool = isHexColor( 'ffffff', 'either' );
// returns true
 
bool = isHexColor( 'fff', 'either' );
// returns true

Examples

var isHexColor = require( 'validate.io-color-hexadecimal' );
 
console.log( isHexColor( 'ffffff' ) );
// returns true
 
console.log( isHexColor( '000000' ) );
// returns true
 
console.log( isHexColor( 'e0e0e0' ) );
// returns true
 
console.log( isHexColor( 'E0F44A' ) );
// returns true
 
console.log( isHexColor( 'E0f44B' ) );
// returns true
 
console.log( isHexColor( 'FFF' ) );
// returns false
 
console.log( isHexColor( 'FFFFFF', 'shorthand' ) );
// returns false
 
console.log( isHexColor( 'FFF', 'shorthand' ) );
// returns true
 
console.log( isHexColor( 'FFFFFF', 'either' ) );
// returns true
 
console.log( isHexColor( 'fff', 'either' ) );
// returns true
 
console.log( isHexColor( '#ffffff' ) );
// returns false

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.

install

npm i validate.io-color-hexadecimal

Downloadsweekly downloads

17

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability