1.0.2 • Published 9 months ago

react-select-nigeria-state-lg v1.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
9 months ago

React Nigeria Select

A React component for selecting Nigerian states and local government areas (LGAs).

Features

  • 🇳🇬 Complete list of Nigerian states and LGAs
  • 🎨 Customizable styling
  • ⌨️ TypeScript support
  • 🔄 Controlled and uncontrolled usage
  • 📱 Mobile-friendly
  • 🎯 Zero dependencies
  • ♿ Accessible

Installation

npm install react-select-nigeria-state-lg
# or

yarn add react-select-nigeria-state-lg

Demo link https://stateselection-demo.vercel.app/

Usage

jsx or tsx import { NigeriaSelect } from 'react-select-nigeria-state-lg';

function App() { const handleChange = ({ state, lga }) => { console.log(Selected state: ${state}, LGA: ${lga}); };

return ( ); }

Props

PropTypeDefaultDescription
onChange(values: SelectionValue) => void-Callback when either state or LGA changes
onStateChange(state: string) => void-Callback when state changes
onLGAChange(lga: string) => void-Callback when LGA changes
defaultStatestring-Initial state value
defaultLGAstring-Initial LGA value
classNamestring-Additional class for wrapper div
selectClassNamestring-Additional class for select elements
labelClassNamestring-Additional class for labels
showLabelsbooleantrueShow/hide labels
requiredbooleanfalseMake fields required
disabledbooleanfalseDisable both selects
loadingbooleanfalseShow loading state

Using with React Hook Form

import { useForm, Controller } from "react-hook-form";
import { NigeriaSelect } from "react-select-nigeria-state-lg";

function Form() {
  const { control } = useForm();

  return (
    <Controller
      name="location"
      control={control}
      render={({ field }) => (
        <NigeriaSelect onChange={field.onChange} required />
      )}
    />
  );
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1.0.2

9 months ago

1.0.1

9 months ago