Skip to content
πŸ€ 🎨 Get all NBA team's color.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.babelrc
.editorconfig
.eslintignore
.eslintrc
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
index.d.ts
package.json
yarn.lock

README.md

NBA Color

Get all NBA team's color code (Hex or RGB).
Useful for building NBA-related colorful product.

Build Status Coverage Status

screen shot 2017-10-27 at 9 33 07 pm

Install

$ npm install nba-color

or

$ yarn add nba-color

Usage

import chalk from 'chalk';
import { getMainColor, getFullName } from 'nba-color';

const warriors = 'GSW';
const { hex: warriorsColorHex } = getMainColor(warriors);
const warriorsFullName = getFullName(warriors);

console.log(chalk.bgHex(warriorsColorHex).bold(warriorsFullName));

result: screen shot 2017-10-28

APIs

getAllColors() => Object

Return an Object containing all NBA teams colors data.
The object's keys are uppercase Team Abbreviations.

getMainColor(teamAbbreviation) => Object

Parameter: String
It can be uppercase or lowercase Team Abbreviations.

Return: Object
Contain the NBA team main color's Hexadecimal Colors Code and RGB Color Code.

Note.
If received an excluded team abbreviation, return undefined.

Example

import { getMainColor } from 'nba-color';

console.log(getMainColor('CLE'));

/*
{
  hex: '#6f263d',
  rgb: [111, 38, 61]
}
*/

getSecondaryColor(teamAbbreviation) => Object

Parameter: String
It can be uppercase or lowercase Team Abbreviations.

Return: Object
Contain the NBA team secondary color's Hexadecimal Colors Code and RGB Color Code.

Note.
If received an excluded team abbreviation, return undefined.

Example

import { getSecondaryColor } from 'nba-color';

console.log(getSecondaryColor('NYK'));

/*
{
  hex: '#ff671f',
  rgb: [255, 103, 31],
}
*/

getColors(teamAbbreviation) => Object

Parameter: String
It can be uppercase or lowercase Team Abbreviations.

Return: Object
Contain the NBA team all colors, including Hexadecimal Colors Code and RGB Color Code for each color.

Note.
If received an excluded team abbreviation, return undefined.

Example

import { getColors } from 'nba-color';

console.log(getColors('LAL'));

/*
{
  purple: {
    hex: '#702f8a',
    rgb: [112, 47, 138],
  },
  gold: {
    hex: '#ffc72c',
    rgb: [255, 199, 44],
  },
  white: {
    hex: '#ffffff',
    rgb: [255, 255, 255],
  }
}
*/

getColorsList(teamAbbreviation) => Array

Parameter: String
It can be uppercase or lowercase Team Abbreviations.

Return: Array
Contain the NBA team colors.

Note.
If received an excluded team abbreviation, return undefined.

Example

import { getColorsList } from 'nba-color';

console.log(getColorsList('LAL'));

/*
['purple', 'gold', 'white']
*/

getFullName(teamAbbreviation) => String

Parameter: String
It can be uppercase or lowercase Team Abbreviations.

Return: String
The NBA team full name.

Note.
If received an excluded team abbreviation, return undefined.

Example

import { getFullName } from 'nba-color';

console.log(getFullName('SAS'));

/*
'San Antonio Spurs'
*/

License

MIT Β© xxhomey19

You can’t perform that action at this time.