@tclohm/car-colors

A comprehensive ESM module of car colors, organized by category with utility functions.

Install

npm install @tclohm/car-colors

Usage

import carColors, { blues, findByName, randomColor, getDefaultByHueName } from '@tclohm/car-colors';

// Get all colors
console.log(carColors.allColors);

// Get all blues
console.log(blues);

// Search by name
console.log(findByName('midnight'));     // { name: 'Midnight Black', hex: '#1C1C1C' }

// Get a random color
console.log(randomColor());             // { name: 'Soul Red', hex: '#B22222' }

// Get the plain/default color for a hue — no need to pick a specific shade
console.log(findByName('red'));         // { name: 'Red', hex: '#FF0000' }
console.log(getDefaultByHueName('green')); // { name: 'Green', hex: '#008000' }

Categories

| Category | Description | |-------------|----------------------------------------| | whites | White tones (polar, pearl, ivory…) | | silvers | Silver tones (lunar, platinum, sonic…) | | blacks | Black tones (jet, obsidian, carbon…) | | grays | Grays (graphite, nardo, gunmetal…) | | blues | Blues (navy, cobalt, portimao…) | | reds | Reds (rosso corsa, crimson, candy…) | | greens | Greens (british racing, lime…) | | yellows | Yellows (racing, sunburst, dakar…) | | golds | Golds (metallic, champagne, amber…) | | oranges | Oranges (blaze, volcanic, copper…) | | browns | Browns (mocha, chestnut, walnut…) | | purples | Purples (ultraviolet, midnight…) | | pinks | Pinks (hot pink, sakura, rose…) | | specialty | Special finishes (matte, chrome, candy…) |

Every category (except specialty) also includes a plain, generic entry — White, Silver, Black, Gray, Blue, Red, Green, Yellow, Gold, Orange, Brown, Purple, Pink — so a simple search like findByName('blue') returns a sensible default instead of an oddly specific shade like Portimao Blue.

API

allColors

Flat array of every color object { name, hex }.

categories

Object containing all category arrays.

defaults

Object mapping each category name to its plain/default color, e.g. defaults.blues → { name: 'Blue', hex: '#0000FF' }.

findByName(name)

Returns the first color whose name contains the search string (case-insensitive). Since each category's plain entry (Red, Blue, etc.) is listed first, a search like findByName('red') returns the generic Red rather than a specific shade.

searchByName(name)

Returns all colors whose name contains the search string.

findByHex(hex)

Returns the color matching the given hex code exactly.

getCategory(category)

Returns the array of colors for a given category name string.

getCategoryNames()

Returns an array of all category name strings.

randomColor()

Returns a random color from the full list.

getDefaultColor(category)

Returns the default color object for a given category name, e.g. getDefaultColor('greens') → { name: 'Green', hex: '#008000' }.

getDefaultByHueName(hueName)

Same as getDefaultColor, but accepts a loose hue name — singular or plural, any case — e.g. getDefaultByHueName('Green'), getDefaultByHueName('greens'), and getDefaultByHueName('GREEN') all return the same default green.

License

MIT