Hooks Overview

This section provides detailed information about the custom React hooks provided by react-phonebox. These hooks allow for full control over formatting, validation, placeholder generation, and country selection.

---

🧩 useFormatter

Formats a given phone number string according to the selected country.

import { useFormatter } from 'react-phonebox';

const { format } = useFormatter('TR');
const formatted = format('5012345678');

Returns:

• format(input: string): string – Formats input digits using libphonenumber-js AsYouType.

---

🔢 useExampleNumber

Generates an example number and placeholder for the selected country.

import { useExampleNumber } from 'react-phonebox';

const { placeholder, example, maxDigits } = useExampleNumber('US');

Returns:

• placeholder – Example-based national format string (e.g. 201-555-0123)
• example – Example number object with formatting methods
• maxDigits – Max allowed digit count for national number

---

📱 useMobileOnly

Validates a phone number and ensures it's a mobile number if mobileOnly = true.

import { useMobileOnly } from 'react-phonebox';

const { validate } = useMobileOnly();
const result = validate('+905012345678', true);

Returns:

• validate(raw: string, mobileOnly: boolean) → { isValid: boolean; parsed?: string }

---

🌍 useCountries

Loads all countries with localized names and dial codes.

import { useCountries } from 'react-phonebox';

const { countries, selectedCountry, setSelectedCountry } = useCountries('tr', 'TR');

Returns:

• countries: Array of { name, iso2, dialCode }
• selectedCountry: Currently selected country
• setSelectedCountry(country): Manually update selection

---