https://github.com/abrehan2/use-countries-hook

https://github.com/abrehan2/use-countries-hook

reactjs typescript

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/abrehan2/use-countries-hook
• Owner: abrehan2
• License: mit
• Created: 2023-08-31T10:30:31.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-04T17:16:00.000Z (10 months ago)
• Last Synced: 2024-11-15T23:48:33.540Z (about 2 months ago)
• Topics: reactjs, typescript
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/use-countries-hook
• Size: 19.5 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> The use-countries-hook is a customizable React hook that provides an effortless way for developers to integrate a list of countries into their components. It simplifies the process of fetching and managing country's data, allowing users to easily select countries for their applications.

## Installation

**npm:**

```sh

npm install use-countries-hook

```

## Getting started with use-countries-hook

Here is an example of a basic app using this hook:

```jsx

import * as React from 'react';

import { useCountries } from 'use-countries-hook';

function App() {

const { getAll, getByValue } = useCountries();

  

return 
Thank you for using this hook!
;


}

```

## Library options

  

    Field

    Description

  

  

    flag:

    It represents the national flag emoji associated with a specific geographical entity. Flags are often used to symbolize countries or regions and can carry cultural, national, or historical significance

  

  

    label:

    It provides a textual label that corresponds to the specific entity. Labels are commonly used to provide human-readable names or titles for data elements, making them more understandable and user-friendly

  

  

    latlng:

    It contains geographical coordinates represented as an array, consisting of two values: latitude and longitude. The latitude specifies the north-south position, and the longitude specifies the east-west position

  

  

    region:

    It categorizes the geographical entity into a broader region. Regions are often used to group countries or areas based on their geographic, political, or cultural characteristics

  

  

    value:

    It typically holds a code or identifier associated with the geographical entity. For example, the value is 'AW', which likely corresponds to a standardized code used for data processing, referencing, or classification purposes

  

## License

This project is licensed under the terms of the

[MIT license](/LICENSE)