Language-Flag-Colors

A package with the color of every language's flag

Instalation

1# npm
2npm install language-flag-colors
3
4# yarn
5yarn add language-flag-colors

Usage

Importing

TypeScript

1// Here we're importing the default export "languages", which is an array with all the language objects
2// as well as the getLanguage function which is used to get a language object or an array of language objects
3import languages, { getLanguage } from "language-flag-colors";

JavaScript

1// Here we're importing the default export "languages", which is an array with all the language objects
2// as well as the getLanguage function which is used to get a language object or an array of language objects
3const { getLanguage, default: languages } = require("language-flag-colors");

Or, if you only want the default array export

1const languages = require("language-flag-colors");

Or if you only want a function

1const { getLanguage } = require("language-flag-colors");

Using our custom methods

1// Every method's input is case-insensitive!
2
3// Getting the full language object for one language
4// This method accepts a language's name, locale or ISO 639-(1/2/3) code
5const dutch = getLanguage("Dutch");
6const portuguese = getLanguage("pt-pt");
7
8// Getting an array of language objects for multiple languages
9const [dutch, portuguese] = getLanguage(["nl-nl", "portuguese"]); // This will return an array with the language objects corresponding to Dutch and Portuguese
10
11// Getting the name of a language
12// This method accepts a language's name, locale or ISO 639-(1/2/3) code
13const ptName = getName("pt-pt"); // Will return "Portuguese"
14
15// Getting the native name of a language
16// This method accepts a language's name, locale or ISO 639-(1/2/3) code
17const ptNativeName = getNativeName("pt-pt"); // Will return "Português"
18
19// Getting a language's IDs. This will return an object with the language's locale, ISO_639_1, ISO_639_2, ISO_639_3 codes, androidCode, osxCode, osxLocale and glottolog ID
20// This method accepts a language's name, locale or ISO 639-(1/2/3) code
21const dutchIds = getIds("nld");
22
23// Getting the locale of a language
24// This method accepts a language's name, locale or ISO 639-(1/2/3) code
25const dutchLocale = getLocale("dutch"); // Will return "nl-NL"
26
27// Getting the language's ISO 639-1 code
28// This method accepts a language's name, locale or ISO 639-(1/2/3) code
29const ptISO_639_1 = getISO_639_1("PORTUGUESE"); // Will return "pt"
30
31// Getting the language's ISO 639-2 code
32// This method accepts a language's name, locale or ISO 639-(1/2/3) code
33const dutchISO_639_2 = getISO_639_2("dutch"); // Will return "nld"
34
35// Getting the language's ISO 639-3 code
36// This method accepts a language's name, locale or ISO 639-(1/2/3) code
37const englishISO_639_3 = getISO_639_3("English"); // Will return "eng"
38
39// Getting the language's Android code. This is used to name "values-" directories in Android-based OSs
40// This method accepts a language's name, locale or ISO 639-(1/2/3) code
41const ptAndroidCode = getAndroidCode("PORTUGUESE"); // Will return "pt-rPT"
42
43// Getting the language's OS X code
44// This method accepts a language's name, locale or ISO 639-(1/2/3) code
45const dutchOSXCode = getOSXCode("nl-nl"); // Will return "nl.lproj"
46
47// Getting the language's OS X locale
48// This method accepts a language's name, locale or ISO 639-(1/2/3) code
49const englishOSXLocale = getOSXLocale("eng"); // Will return "en"
50
51// Getting the language's Glottolog ID. This will return the link to the glottolog page on the language provided if the second parameter is passed as true
52// This method accepts a language's name, locale or ISO 639-(1/2/3) code
53const ptGlottologUrl = getGlottolog("pt-pt", true); // Will return "https://glottolog.org/resource/languoid/id/port1283"
54const dutchGlottologId = getGlottolog("nl-nl"); // Will return "mode1257"
55
56// Getting a language's text direction. This can be "rtl" or "ltr" for "right-to-left" and "left-to-right" respectively
57const dutchDirection = getDirection("Dutch"); // Will return "ltr"
58const arabicDirection = getDirection("ar"); // Will return "rtl"
59
60// Getting the language's country name
61// This method accepts a language's name, locale or ISO 639-(1/2/3) code
62const ptCountry = getCountry("pt"); // Will return "Portugal"
63
64// Getting the language's country code
65// This method accepts a language's name, locale or ISO 639-(1/2/3) code
66const dutchCountryCode = getCountryCode("dutch"); // Will return "nl"
67
68// Getting all the languages in a country
69const netherlandsLangs = getCountryLanguages("netherlands"); // Will return an array with the language objects for Dutch, Frisian, Limburgish and Zeelandic
70
71// Getting the language's flag. This will return an object with a link to the language's flag image from Crowdin, the flag's unicode emoji, if any, the flag's primaryColor and flagColors all in hexadecimal, RGB, CMYK and base-10
72// This method accepts a language's name, locale or ISO 639-(1/2/3) code
73const ptFlag = getFlag("pt");
74
75// Getting the language's flag image URL
76// This method accepts a language's name, locale or ISO 639-(1/2/3) code
77const dutchFlagImage = getImage("nl"); // Will return "https://crowdin.com/images/flags/nl.png"
78
79// Getting the flag unicode emoji of a language
80// This method accepts a country's name or code, or a language's name, locale or ISO 639-(1/2/3) code
81const ptEmoji = getEmoji("pt-pt"); // Will return "🇵🇹"
82const dutchEmoji = getEmoji("dutch"); // Will return "🇳🇱"
83const ukEmoji = getEmoji("United Kingdom"); // Will return "🇬🇧"
84const usEmoji = getEmoji("us"); // Will return "🇺🇸"
85
86// Getting the language's primary color. This will return an object with the language's primary color in hexadecimal, RGB, CMYK and base-10
87// This method accepts a language's name, locale or ISO 639-(1/2/3) code
88const ptPrimaryColor = getPrimaryColor("pt");
89
90// Getting the primary hexadecimal color value for a language.
91// This method accepts a language's name, locale or ISO 639-(1/2/3) code
92const ptPrimaryHex = getPrimaryHex("pt-pt"); // Will return "#FF0000"
93const dutchPrimaryHex = getPrimaryHex("dutch"); // Will return "#FF4F00"
94
95// Getting the primary RGB color values for a language.
96// This method accepts a language's name, locale or ISO 639-(1/2/3) code
97const ptPrimaryRGB = getPrimaryRGB("pt-pt"); // Will return [255, 0, 0]
98const dutchPrimaryRGB = getPrimaryRGB("dutch"); // Will return [255, 79, 0]
99
100// Getting the primary CMYK color values for a language.
101// This method accepts a language's name, locale or ISO 639-(1/2/3) code
102const ptPrimaryCMYK = getPrimaryCMYK("pt-pt"); // Will return [0, 100, 100, 0]
103const dutchPrimaryCMYK = getPrimaryCMYK("dutch"); // Will return [0, 69, 100, 0]
104
105// Getting the primary base-10 color value for a language.
106// This method accepts a language's name, locale or ISO 639-(1/2/3) code
107const ptPrimaryBase10 = getPrimaryBase10("pt-pt"); // Will return 16711680
108const dutchPrimaryBase10 = getPrimaryBase10("dutch"); // Will return 16731904
109
110// Getting the language's flag colors. This will return an array of objects with the language's primary color in hexadecimal, RGB, CMYK and base-10
111// This method accepts a language's name, locale or ISO 639-(1/2/3) code
112const dutchFlagColors = getFlagColors("nl");
113
114// Getting the hexadecimal color values for a language.
115// This method accepts a language's name, locale or ISO 639-(1/2/3) code
116const ptHexFlagColors = getHexFlagColors("pt-pt");
117const dutchHexFlagColors = getHexFlagColors("dutch");
118
119// Getting the RGB color values for a language.
120// This method accepts a language's name, locale or ISO 639-(1/2/3) code
121const ptRGBFlagColors = getRGBFlagColors("pt-pt");
122const dutchRGBFlagColors = getRGBFlagColors("dutch");
123
124// Getting the CMYK color values for a language.
125// This method accepts a language's name, locale or ISO 639-(1/2/3) code
126const ptCMYKFlagColors = getCMYKFlagColors("pt-pt");
127const dutchCMYKFlagColors = getCMYKFlagColors("dutch");
128
129// Getting the base-10 color values for a language.
130// This method accepts a language's name, locale or ISO 639-(1/2/3) code
131const ptBase10FlagColors = getBase10FlagColors("pt-pt");
132const dutchBase10FlagColors = getBase10FlagColors("dutch");
133
134// Getting the language's region name, if any
135// This method accepts a language's name, locale or ISO 639-(1/2/3) code
136const sardinianRegion = getRegion("Sardinian"); // Will return "Sardinia"
137
138// Getting the language's region code, if any
139// This method accepts a language's name, locale or ISO 639-(1/2/3) code
140const basqueRegionCode = getRegionCode("eu-ES"); // Will return "pv"
141
142// Getting all the languages specific to a region
143const scotlandLangs = getRegionLanguages("scotland"); // Will return an array with the language objects for Scots and Scottish Gaelic

Contributing

Due to the large amount of languages we support in this package, it is possible that some information may be inaccurate. If you believe so, feel free to open a pull request.

Inspiration

We got all the language names and locale from Crowdin's officially supported languages (with some minor differences) and added all the colors, countries and regions manually. We hope to keep this list updated whenever they add new languages, but we may also add other ones not supported by them if these are requested by anyone. This package was created by Bas950 and Rodry and is not officially endorsed by Crowdin nor affiliated with the company in any way.