Code Monkey home page Code Monkey logo

country-phonecode-flag's Introduction

country-phonecode-flag

country-phonecode-flag is a lightweight, easy-to-use npm package that provides utility functions for fetching country-related information, such as country flags, phone codes, and names. The package is framework-agnostic and can be used in any JavaScript or TypeScript project, including modern frameworks like React, Vue, and Angular.

Installation

To install the country-phonecode-flag package, run the following command:

npm install country-phonecode-flag

Usage

Import the utility functions and use them in your JavaScript or TypeScript project:

import {
  getCountryFlag,
  getCountryPhoneCode,
  getCountryByName,
  getCountryByFlag,
  getAllCountries,
} from "country-phonecode-flag";

API

getCountryFlag(code: string): string | undefined Returns the flag emoji for a given country code (ISO 3166-1 alpha-2). Returns undefined if the country code is not found.

const flag = getCountryFlag("US"); // πŸ‡ΊπŸ‡Έ

getCountryPhoneCode(code: string): string | undefined Returns the phone code for a given country code (ISO 3166-1 alpha-2). Returns undefined if the country code is not found.

const phoneCode = getCountryPhoneCode("US"); // +1

getCountryByName(name: string): Country | undefined Returns a Country object for a given country name. Returns undefined if the country name is not found.

const country = getCountryByName("United States");
// {
//   name: "United States",
//   code: "US",
//   flag: "πŸ‡ΊπŸ‡Έ",
//   phoneCode: "+1",
// }

getCountryByFlag(flag: string): Country | undefined Returns a Country object for a given flag emoji. Returns undefined if the flag is not found.

const country = getCountryByFlag("πŸ‡ΊπŸ‡Έ");
// {
//   name: "United States",
//   code: "US",
//   flag: "πŸ‡ΊπŸ‡Έ",
//   phoneCode: "+1",
// }

getAllCountries(): Country[]

Returns an array of all Country objects in the dataset.

const countries = getAllCountries();

example in react js

Using the country-phonecode-flag package in a React component:

import React from "react";
import {
  getCountryFlag,
  getCountryPhoneCode,
  getCountryByName,
  getCountryByFlag,
  getAllCountries,
} from "country-phonecode-flag";

function CountryInfo({ countryCode }) {
  const flag = getCountryFlag(countryCode);
  const phoneCode = getCountryPhoneCode(countryCode);

  return (
    <div>
      <h2>Country Information</h2>
      <p>Flag: {flag}</p>
      <p>Phone Code: {phoneCode}</p>
    </div>
  );
}

export default CountryInfo;

The package can be similarly used with other frameworks like Vue or Angular, or in plain JavaScript or TypeScript projects.

country-phonecode-flag's People

Contributors

pouyapanahandeh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.