Hexadecimal Color

Validates if a value is a hexadecimal color.

Installation

1$ npm install validate.io-color-hexadecimal

For use in the browser, use browserify.

Usage

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

isHexColor( value[, mode] )

Validates if a value is a hexadecimal color.

1var bool = isHexColor( 'ffffff' );
2// 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.

1var bool;
2
3// Full length colors...
4bool = isHexColor( 'ffffff', 'full' );
5// returns true
6
7bool = isHexColor( 'fff', 'full' );
8// returns false
9
10
11// Shorthand colors...
12bool = isHexColor( 'ffffff', 'shorthand' );
13// returns false
14
15bool = isHexColor( 'fff', 'shorthand' );
16// returns true
17
18
19// Either shorthand or full length colors...
20bool = isHexColor( 'ffffff', 'either' );
21// returns true
22
23bool = isHexColor( 'fff', 'either' );
24// returns true

Examples

1var isHexColor = require( 'validate.io-color-hexadecimal' );
2
3console.log( isHexColor( 'ffffff' ) );
4// returns true
5
6console.log( isHexColor( '000000' ) );
7// returns true
8
9console.log( isHexColor( 'e0e0e0' ) );
10// returns true
11
12console.log( isHexColor( 'E0F44A' ) );
13// returns true
14
15console.log( isHexColor( 'E0f44B' ) );
16// returns true
17
18console.log( isHexColor( 'FFF' ) );
19// returns false
20
21console.log( isHexColor( 'FFFFFF', 'shorthand' ) );
22// returns false
23
24console.log( isHexColor( 'FFF', 'shorthand' ) );
25// returns true
26
27console.log( isHexColor( 'FFFFFF', 'either' ) );
28// returns true
29
30console.log( isHexColor( 'fff', 'either' ) );
31// returns true
32
33console.log( isHexColor( '#ffffff' ) );
34// returns false

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

1$ 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:

1$ 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:

1$ make test-cov

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

1$ make view-cov

---

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.