bd_cities v1.1.1

bd-cities

bd-cities is a simple and lightweight React hook-based package that provides a list of cities in Bangladesh and their corresponding areas.

Installation

Install the package using npm or yarn:

npm install bd-cities
# or
yarn add bd-cities

Usage

Import the hooks in your React/Next.js project:

"use client"
import { useBdCities, useBdAreaByCity } from 'bd-cities';

export default function Home() {
  const cities = useBdCities();
  const area = useBdAreaByCity('jhenaidah');

  console.log("Cities:", cities);
  console.log("Areas in Jhenaidah:", area);

  return (
    <div>
      <h1>Bangladesh Cities and Areas</h1>
      <h2>All Cities</h2>
      <ul>
        {cities.map((city, index) => (
          <li key={index}>{city}</li>
        ))}
      </ul>
      <h2>Areas in Jhenaidah</h2>
      <ul>
        {area.map((a, index) => (
          <li key={index}>{a}</li>
        ))}
      </ul>
    </div>
  );
}

API

useBdCities()

Returns an array of all cities in Bangladesh.

const cities = useBdCities();
console.log(cities); // [ {cityId: 1, name: 'Dhaka', banglaName: 'ঢাকা'},{cityId: 2, name: 'Chittagong', banglaName: 'চট্টগ্রাম'},{cityId: 3, name: 'Khulna', banglaName: 'খুলনা'},...]

useBdAreaByCity(city: string)

Returns an array of areas within the specified city.

const areas = useBdAreaByCity('Dhaka');
console.log(areas); // [{areaId: 776, area: 'Dhanmondi-27', areaBangla: 'ধানমন্ডি-২৭'},{areaId: 777, area: 'Dhanmondi-28', areaBangla: 'ধানমন্ডি-২৮'},{areaId: 778, area: 'Dhanmondi-29', areaBangla: 'ধানমন্ডি-২৯'},...]

Contributing

Contributions are welcome! Feel free to submit issues and pull requests.

License

This project is licensed under the MIT License.

Happy Coding! 🚀