@alikhalilll/a-tel-input 1.0.2 → 1.1.1

package/README.md

@@ -1,41 +1,166 @@
-# @alikhalilll/a-tel-input
+# `@alikhalilll/a-tel-input`
 
-Headless, [shadcn-vue](https://www.shadcn-vue.com) style Vue 3 **international telephone input**.
-Detects the country from what the user types (debounced, NANP-aware via
-[`libphonenumber-js`](https://github.com/catamphetamine/libphonenumber-js)), validates + formats the
-number, and offers a country picker that's a **popover on desktop / drawer on mobile**. RTL, i18n,
-and alternative-numeral (Arabic-Indic, Persian, Devanagari, Bengali) input all work out of the box.
+<p align="center">
+  <img
+    src="https://raw.githubusercontent.com/alikhalilll/ali-nuxt-toolkit/master/packages/ui-components/ATelInput/.media/hero.png"
+    alt="ATelInput — input on the left with the country picker open next to it, showing flags, country names, and dial codes"
+    width="820"
+  />
+</p>
 
-Components: **`ATelInput`** · **`ACountrySelect`** · **`ACountryFlag`**.
+<p align="center">
+  <sub>Headless picker — popover on desktop, bottom-sheet on mobile.</sub>
+</p>
 
-## Install
+> A headless, shadcn-vue style **international telephone input** for Vue 3 / Nuxt 3+.
+> Country auto-detect · libphonenumber-js validation · responsive picker (popover ⇆ drawer) ·
+> RTL & i18n ready · first-class VeeValidate + Zod integration · server-side validation hook.
+
+[![npm version](https://img.shields.io/npm/v/%40alikhalilll%2Fa-tel-input.svg?style=for-the-badge&label=npm&labelColor=0a0a0a&color=635bff)](https://www.npmjs.com/package/@alikhalilll/a-tel-input)
+[![license](https://img.shields.io/npm/l/%40alikhalilll%2Fa-tel-input.svg?style=for-the-badge&labelColor=0a0a0a&color=635bff)](./LICENSE)
+[![types](https://img.shields.io/npm/types/%40alikhalilll%2Fa-tel-input.svg?style=for-the-badge&labelColor=0a0a0a&color=635bff)](https://www.npmjs.com/package/@alikhalilll/a-tel-input)
 
 ```bash
+# pnpm
 pnpm add @alikhalilll/a-tel-input
+
+# npm
+npm install @alikhalilll/a-tel-input
+
+# yarn
+yarn add @alikhalilll/a-tel-input
+
+# bun
+bun add @alikhalilll/a-tel-input
 ```
 
-(Pulls in `@alikhalilll/a-responsive-popover` → `a-popover` + `a-drawer` automatically. Design
-tokens are bundled into each component's `styles.css`, so there's no separate base package to install.)
+```vue
+<!-- Single E.164 string — what VeeValidate's <Field v-slot="{ field }"> + native forms expect -->
+<ATelInput v-model="phone" default-country="SA" show-validation />
+
+<!-- Or split phone + country into two v-models -->
+<ATelInput v-model:phone="phone" v-model:country="country" default-country="SA" show-validation />
+```
+
+---
+
+## Why this component
+
+- **Universal country detection** — debounced parse against the **full libphonenumber
+  metadata (~250 countries)**. Works with international format (`+201066105963`) AND
+  local format (`01066105963`), with NANP disambiguation and a hint-priority chain
+  (env → current → recents → popular → all). No "only the popular countries" caveats.
+- **Validates and formats** — error reasons, format hint, E.164 output, every keystroke.
+- **Responsive surface** — popover on desktop, bottom-sheet drawer on mobile, sticky-safe
+  scroll lock on **both**. The page underneath never scrolls; the inner picker list does.
+- **Headless slots for every region** — trigger, chevron, flag, item, search, hint,
+  error. Restyle the field down to the pixel without forking the logic.
+- **First-class form-library integration** — controlled `error` prop, `@blur` event,
+  `useTelField()` composable for VeeValidate, `zPhone()` factory for Zod schemas, and a
+  `validating` spinner for async server-side checks ("is this number already registered?").
+- **Two binding contracts, your pick** — single default `v-model` (E.164 string, drops
+  into VeeValidate's `<Field v-slot="{ field }">` via `v-bind="field"`), or split
+  `v-model:phone` + `v-model:country`. Both stay in sync.
+- **i18n + RTL out of the box** — country names localised via `Intl.DisplayNames`,
+  alternative numerals (Arabic-Indic, Persian, Devanagari, Bengali) folded to ASCII on
+  input, RTL inherited from the page or forced via `dir`.
+- **Efficient by default** — REST Countries fetch + IP geolocation request deduped to
+  one network call per page across every `<ATelInput>` / `<ACountrySelect>` /
+  `useTelField()` / `zPhone()` instance. LRU-cached matcher. `FALLBACK_COUNTRIES`
+  pre-seeded into the lookup indexes so detection works synchronously from first paint.
+- **SSR-safe** — country detection runs only after mount, hydration is clean.
+- **TypeScript-first** — every prop, slot, and event fully typed; web-types ship for
+  JetBrains IDEs.
+
+---
+
+## Table of contents
+
+- [Install](#install)
+- [Quick start](#quick-start)
+- [Form integration](#form-integration)
+  - [VeeValidate + Zod](#veevalidate--zod)
+  - [Server-side validation](#server-side-validation-is-this-phone-already-registered)
+  - [Native HTML forms](#native-html-forms)
+- [API reference](#api-reference)
+  - [Props](#props)
+  - [Events](#events)
+  - [Slots](#slots)
+  - [Exposed methods](#exposed-methods)
+  - [Composables](#composables)
+- [Theming](#theming)
+- [Accessibility](#accessibility)
+- [Auto-import](#auto-import)
+- [SSR](#ssr)
+- [TypeScript](#typescript)
+- [Browser support](#browser-support)
+- [Troubleshooting](#troubleshooting)
+- [License](#license)
+
+---
+
+## Install
+
+Pick your package manager:
+
+```bash
+# pnpm
+pnpm add @alikhalilll/a-tel-input
 
-## Styles
+# npm
+npm install @alikhalilll/a-tel-input
 
-The picker renders the popover/drawer, so import their stylesheets too:
+# yarn
+yarn add @alikhalilll/a-tel-input
+
+# bun
+bun add @alikhalilll/a-tel-input
+```
+
+**One CSS import — everything in.** The popover, drawer, and design tokens are all
+bundled into the same stylesheet:
 
 ```ts
-import '@alikhalilll/a-popover/styles.css';
-import '@alikhalilll/a-drawer/styles.css';
 import '@alikhalilll/a-tel-input/styles.css';
 ```
 
-## Usage
+No separate `a-popover` / `a-drawer` / `a-ui-base` imports needed.
+
+---
+
+## Quick start
+
+The component supports **two binding contracts** — pick whichever fits your form code:
+
+### Single v-model (E.164 string)
+
+The friendliest with VeeValidate's `<Field v-slot="{ field }">`, native HTML `<form>`
+submission, and anything else that expects one canonical value:
 
 ```vue
 <script setup lang="ts">
 import { ref } from 'vue';
 import { ATelInput } from '@alikhalilll/a-tel-input';
 
-const phone = ref('');
-const country = ref<number | null>(null);
+const phone = ref(''); // → '+201066105963'
+</script>
+
+<template>
+  <ATelInput v-model="phone" default-country="SA" show-validation />
+</template>
+```
+
+### Split `v-model:phone` + `v-model:country`
+
+When you want the raw national digits and the dial code as separate values:
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { ATelInput } from '@alikhalilll/a-tel-input';
+
+const phone = ref(''); // → '1066105963'
+const country = ref<number | null>(null); // → 20  (the dial code as a number)
 </script>
 
 <template>
@@ -43,82 +168,482 @@ const country = ref<number | null>(null);
 </template>
 ```
 
-By default the picker is hidden and reveals once a leading dial code is detected from typing. Pass
-`default-country` (ISO2 like `"EG"` or a dial code like `"20"`) to show it pre-selected, or
-`:detect-from-input="false"` for the legacy always-visible picker.
-
-## API
-
-### Key props
-
-| Prop                                  | Type                           | Default  | Description                                              |
-| ------------------------------------- | ------------------------------ | -------- | -------------------------------------------------------- |
-| `phone`                               | `string`                       | —        | `v-model:phone` — the raw national number.               |
-| `country`                             | `number \| null`               | —        | `v-model:country` — selected dial code.                  |
-| `defaultCountry`                      | `string`                       | —        | Initial country: ISO2 (`"EG"`) or dial code (`"20"`).    |
-| `detectCountry`                       | `DetectionStrategy`            | `auto`   | Silent IP → timezone → `navigator.language` hint.        |
-| `detectFromInput`                     | `boolean`                      | `true`   | Reveal the picker on first dial-code match while typing. |
-| `detectDebounceMs`                    | `number`                       | —        | Debounce for input-based detection.                      |
-| `allowedDialCodes`                    | `string[]`                     | —        | Whitelist of dial codes; others render disabled.         |
-| `size`                                | `Size` (`xs`–`xl`)             | `md`     | Control size.                                            |
-| `dir`                                 | `'ltr' \| 'rtl' \| 'auto'`     | `auto`   | Text direction (inherits from the page by default).      |
-| `locale`                              | `string`                       | —        | BCP-47 locale for country names + numerals.              |
-| `messages`                            | `TelInputMessagesInput`        | —        | Localize every UI string in one bag.                     |
-| `showValidation`                      | `boolean`                      | `false`  | Colour the field border/ring by validity.                |
-| `showValidationIcon`                  | `boolean`                      | `false`  | Show the valid/error icon at the field end.              |
-| `disabled` / `loading`                | `boolean`                      | `false`  | Field state.                                             |
-| `flagUrl`                             | `(iso2, width) => string`      | —        | Override the flag image source.                          |
-| `countries` / `searcher` / `detector` | —                              | —        | Override the data sources.                               |
-| `ipEndpoint`                          | `string`                       | —        | Override the IP-geolocation endpoint.                    |
-| `scrollLock`                          | `'events' \| 'body' \| 'none'` | `events` | Desktop scroll-lock behaviour of the picker.             |
-
-Class hooks: `class`, `fieldClass`, `inputClass`, `contentClass`, `popoverClass`, `drawerClass`,
-`hintClass`, `errorClass`. Full prop/type reference:
-[docs](https://alikhalilll.github.io/ali-nuxt-toolkit/ui/tell-input).
+| Binding           | Type             | Carries                                                               |
+| ----------------- | ---------------- | --------------------------------------------------------------------- |
+| `v-model`         | `string`         | Full E.164 string (`'+201066105963'`). Empty when invalid / blank.    |
+| `v-model:phone`   | `string`         | Digits-only national number (no `+`, no spaces).                      |
+| `v-model:country` | `number \| null` | Dial-digit number (e.g. `20` for Egypt, `1` for NANP). `null` ≈ none. |
+
+> The two contracts stay in sync — you can mix them, but most apps pick one and stick with it.
+
+The picker is **hidden by default** until a leading dial code is detected from typing —
+pass `default-country` to show it pre-selected, or `:detect-from-input="false"` for the
+legacy always-visible picker.
+
+---
+
+## Form integration
+
+`@alikhalilll/a-tel-input` ships two thin subpath entries so the same validation engine
+that powers the in-field UI is also available to your form layer:
+
+- **`@alikhalilll/a-tel-input/vee-validate`** — `useTelField()` composable.
+- **`@alikhalilll/a-tel-input/zod`** — `zPhone()` / `zPhoneObject()` schema factories.
+
+Both `vee-validate` and `zod` are **optional peer dependencies** — install them yourself.
+
+### Drop-in `<Field v-slot="{ field, errors }">` pattern
+
+If you're already using VeeValidate's slot-style fields, **`v-bind="field"` just works**.
+ATelInput's default `v-model` is the E.164 string, and Vue auto-spreads
+`field.modelValue` + `field['onUpdate:modelValue']` + `field.name` + `field.onBlur`
+from the slot prop directly onto the component:
+
+```vue
+<script setup lang="ts">
+import { useForm, Field as VeeField } from 'vee-validate';
+import { toTypedSchema } from '@vee-validate/zod';
+import { z } from 'zod';
+import { ATelInput } from '@alikhalilll/a-tel-input';
+import { zPhone } from '@alikhalilll/a-tel-input/zod';
+
+const { handleSubmit } = useForm({
+  validationSchema: toTypedSchema(z.object({ phone: zPhone() })),
+});
+</script>
+
+<template>
+  <form @submit="handleSubmit(onSubmit)">
+    <VeeField v-slot="{ field, errors }" name="phone">
+      <label for="phone">Phone</label>
+      <ATelInput
+        id="phone"
+        v-bind="field"
+        :error="errors[0]"
+        :aria-invalid="!!errors.length"
+        default-country="SA"
+        show-validation
+      />
+    </VeeField>
+    <button type="submit">Submit</button>
+  </form>
+</template>
+```
+
+That's it — no `useTelField()`, no manual wiring, no `handleBlur` to forward. `field`
+provides everything; `:error="errors[0]"` surfaces the first error message in the
+existing error region.
+
+> Prefer `useTelField()` (below) when you also need async / server-side validation in
+> flight, or when you want the helper to manage `defaultCountry` for you.
+
+### VeeValidate + Zod (with useTelField)
+
+```bash
+# pnpm
+pnpm add vee-validate @vee-validate/zod zod
+
+# npm
+npm install vee-validate @vee-validate/zod zod
+
+# yarn
+yarn add vee-validate @vee-validate/zod zod
+
+# bun
+bun add vee-validate @vee-validate/zod zod
+```
+
+```ts
+import { useForm } from 'vee-validate';
+import { toTypedSchema } from '@vee-validate/zod';
+import { z } from 'zod';
+import { useTelField } from '@alikhalilll/a-tel-input/vee-validate';
+import { zPhone } from '@alikhalilll/a-tel-input/zod';
+
+const { handleSubmit } = useForm({
+  validationSchema: toTypedSchema(z.object({ phone: zPhone() })),
+});
+
+const { phone, country, error, handleBlur, fieldProps } = useTelField('phone', {
+  validateOn: 'blur',
+  defaultCountry: 'SA',
+});
+```
+
+```vue
+<form @submit="handleSubmit(onSubmit)">
+  <ATelInput
+    v-model:phone="phone"
+    v-model:country="country"
+    v-bind="fieldProps"
+    :error="error"
+    @blur="handleBlur"
+  />
+  <button type="submit">Submit</button>
+</form>
+```
+
+`useTelField` composes the digits-only `phone` + the dial-code `country` into an E.164
+string under the hood, and feeds **that** to VeeValidate's schema — so your Zod schema
+validates a single canonical value while the component still binds to two v-models.
+
+### Server-side validation ("is this phone already registered?")
+
+> **Important** — VeeValidate **ignores field-level `rules`** when `useForm` is given a
+> `validationSchema`. To run an async server check, chain it onto the schema itself via
+> `z.refine(async)`. `handleSubmit` awaits the schema, and `meta.pending` (which drives
+> `useTelField`'s `validating` ref → the in-field spinner) follows the schema's async work.
+
+```ts
+import { useForm } from 'vee-validate';
+import { toTypedSchema } from '@vee-validate/zod';
+import { z } from 'zod';
+import { useTelField } from '@alikhalilll/a-tel-input/vee-validate';
+import { zPhone } from '@alikhalilll/a-tel-input/zod';
+
+// Build the schema: sync zPhone() first (cheap — runs locally via libphonenumber-js),
+// then an async refine that hits your server. Refines run AFTER the parent passes, so
+// the server is only contacted when the value is syntactically valid.
+const phoneSchema = zPhone().refine(
+  async (value) => {
+    if (!value) return true;
+    const { exists } = await $fetch('/api/phone/exists', { query: { phone: value } });
+    return !exists;
+  },
+  { message: 'This phone number is already registered.' }
+);
+
+const { handleSubmit } = useForm({
+  validationSchema: toTypedSchema(z.object({ phone: phoneSchema })),
+});
+
+const { phone, country, error, handleBlur, fieldProps, validating } = useTelField('phone', {
+  validateOn: 'blur',
+});
+```
+
+```vue
+<ATelInput
+  v-model:phone="phone"
+  v-model:country="country"
+  v-bind="fieldProps"
+  :error="error"
+  :validating="validating"
+  show-validation
+  @blur="handleBlur"
+/>
+```
+
+- `error` displays the server message in the existing error region.
+- `validating` is `true` while the request is in flight — renders a small spinner inside
+  the field and sets `aria-busy="true"`. It does **not** disable the input.
+- `handleSubmit` awaits the async refine before invoking your callback, so a failing
+  server check blocks submission automatically.
+
+### Native HTML forms
+
+```vue
+<form>
+  <ATelInput v-model:phone="phone" v-model:country="country" name="phone" />
+</form>
+```
+
+`name` is forwarded to the inner `<input>` so `FormData` picks the value up. The submitted
+value is the digits-only national number — compose the E.164 with `usePhoneValidation()`
+in your submit handler if you want the international form.
+
+---
+
+## API reference
+
+### Props
+
+| Prop                   | Type                                   | Default    | Description                                                                                                                                         |
+| ---------------------- | -------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `modelValue`           | `string`                               | `''`       | Default `v-model` — full **E.164** string (`'+201066105963'`). Drops directly into VeeValidate's `<Field v-slot="{ field }">` via `v-bind="field"`. |
+| `phone`                | `string`                               | `''`       | `v-model:phone` — digits-only national number.                                                                                                      |
+| `country`              | `number \| null`                       | `null`     | `v-model:country` — selected dial-digit number (e.g. `20`).                                                                                         |
+| `name`                 | `string`                               | —          | Forwarded to the inner `<input name="">` for native form submission / form libraries.                                                               |
+| `error`                | `string \| null`                       | —          | Externally controlled error message. When non-empty, overrides internal validation.                                                                 |
+| `validating`           | `boolean`                              | `false`    | `true` while an async validation is in flight. Renders a spinner inside the field.                                                                  |
+| `validateOn`           | `'change' \| 'blur' \| 'eager'`        | `'change'` | When to surface validation in the UI.                                                                                                               |
+| `defaultCountry`       | `string`                               | —          | Initial country — ISO2 (`'EG'`) or dial code (`'20'` / `'+20'`).                                                                                    |
+| `detectCountry`        | `DetectionStrategy`                    | `'auto'`   | Silent country hint chain: IP → timezone → `navigator.language`.                                                                                    |
+| `detectFromInput`      | `boolean`                              | `true`     | Reveal the picker on first dial-code match while typing.                                                                                            |
+| `detectDebounceMs`     | `number`                               | `800`      | Debounce window for `detectFromInput`.                                                                                                              |
+| `allowedDialCodes`     | `string[]`                             | —          | Whitelist of dial codes; others render disabled.                                                                                                    |
+| `size`                 | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'` | `'md'`     | Control size — mirrors the shared `Size` scale.                                                                                                     |
+| `dir`                  | `'ltr' \| 'rtl' \| 'auto'`             | `'auto'`   | Text direction (inherits from the page by default).                                                                                                 |
+| `locale`               | `string`                               | —          | BCP-47 locale — localises country names + numerals in hints.                                                                                        |
+| `messages`             | `TelInputMessagesInput`                | —          | Bag of every UI string; merged onto English defaults.                                                                                               |
+| `showValidation`       | `boolean`                              | `false`    | Colour the field border + error line by validity.                                                                                                   |
+| `showValidationIcon`   | `boolean`                              | `false`    | Show the valid / error icon at the field end.                                                                                                       |
+| `disabled` / `loading` | `boolean`                              | `false`    | Field state.                                                                                                                                        |
+| `placeholder`          | `string`                               | derived    | Falls back to the country's `format_hint` when empty.                                                                                               |
+| `flagUrl`              | `(iso2, w) => string`                  | flagcdn    | Override the flag image source.                                                                                                                     |
+| `countries`            | `CountryOption[]`                      | REST API   | Provide your own country list (bypasses the REST Countries fetch).                                                                                  |
+| `searcher`             | `(q, c) => boolean`                    | substring  | Custom search predicate.                                                                                                                            |
+| `detector`             | `async (opts) => string \| null`       | built-in   | Fully custom country detection.                                                                                                                     |
+| `ipEndpoint`           | `string`                               | `ipapi.co` | Override the IP geolocation endpoint.                                                                                                               |
+| `scrollLock`           | `'events' \| 'body' \| 'none'`         | `'events'` | How page-scroll is blocked while the picker is open. Applies on both desktop and mobile.                                                            |
+| Class hooks            | `string`                               | —          | `class`, `fieldClass`, `inputClass`, `contentClass`, `popoverClass`, `drawerClass`, `hintClass`, `errorClass`.                                      |
+| Localised strings      | `string`                               | —          | `searchPlaceholder`, `emptyText`, `loadingText`, `errorMessages`.                                                                                   |
+
+> The full prop / type reference (with every default and every JSDoc note) lives in
+> [`src/types.ts`](./src/types.ts) and is published as part of the package types.
 
 ### Events
 
-| Event            | Payload          |
-| ---------------- | ---------------- |
-| `update:phone`   | `string`         |
-| `update:country` | `number \| null` |
+| Event               | Payload          | Fires when                                                 |
+| ------------------- | ---------------- | ---------------------------------------------------------- |
+| `update:modelValue` | `string`         | Composed E.164 string changed (the default `v-model`).     |
+| `update:phone`      | `string`         | Digits-only national number changed.                       |
+| `update:country`    | `number \| null` | Dial-code number changed.                                  |
+| `blur`              | `FocusEvent`     | Inner input lost focus (also flips internal `hasBlurred`). |
+| `focus`             | `FocusEvent`     | Inner input gained focus.                                  |
 
 ### Slots
 
-Every visual region is a slot, so you can recompose the field entirely:
-`prefix`, `suffix`, `trigger`, `chevron`, `flag`, `search`, `loading`, `empty`, `detecting`,
-`group-header`, `item`, `valid-icon`, `error-icon`, `hint`, `error`. Slots receive typed context —
-e.g. `error` gets `{ message, reason, validation }`, `flag` gets `{ country, context }`.
+Every visual region is a slot — the component is fully recomposable.
+
+| Slot           | Props                                       |
+| -------------- | ------------------------------------------- |
+| `prefix`       | —                                           |
+| `suffix`       | `{ validationState, validation }`           |
+| `trigger`      | `{ selectedCountry, open, sizeClasses }`    |
+| `chevron`      | `{ open }`                                  |
+| `flag`         | `{ country, context: 'trigger' \| 'item' }` |
+| `item`         | `{ country, selected, disabled, select }`   |
+| `group-header` | `{ label, group: 'suggested' \| 'all' }`    |
+| `search`       | `{ value, setValue, isSearching }`          |
+| `loading`      | —                                           |
+| `empty`        | `{ query }`                                 |
+| `detecting`    | — (during country detection)                |
+| `validating`   | — (during async form validation)            |
+| `valid-icon`   | —                                           |
+| `error-icon`   | `{ reason }`                                |
+| `hint`         | `{ country, formatHint, example }`          |
+| `error`        | `{ message, reason, validation }`           |
+
+### Exposed methods
+
+Reach these via `<ATelInput ref="tel" />` → `tel.value?.<method>()`:
+
+| Member                   | Type                                        | Notes                                           |
+| ------------------------ | ------------------------------------------- | ----------------------------------------------- |
+| `validation`             | `ComputedRef<PhoneValidationResult>`        | Full validation result.                         |
+| `required`               | `ComputedRef<PhoneRequiredInfo \| null>`    | Country format hint + example E.164.            |
+| `selectedDialCode`       | `ComputedRef<string \| null>`               | `+`-prefixed dial code of the selected country. |
+| `validationState`        | `ComputedRef<'idle' \| 'valid' \| 'error'>` | Raw state (no typing-pause gating).             |
+| `visibleValidationState` | `ComputedRef<'idle' \| 'valid' \| 'error'>` | UI-surfacing state (gated by `validateOn`).     |
+| `isDetecting`            | `Readonly<Ref<boolean>>`                    | `true` during the first debounce window.        |
+| `hasFinishedTyping`      | `Readonly<Ref<boolean>>`                    | Flips after the debounce settles.               |
+| `detectionAttempted`     | `Readonly<Ref<boolean>>`                    | `true` after at least one detection pass.       |
+| `focus(options?)`        | `() => void`                                | Focus the inner `<input>`.                      |
+| `blur()`                 | `() => void`                                | Blur the inner `<input>`.                       |
+| `select()`               | `() => void`                                | Select the inner `<input>`'s text.              |
+
+### Composables
+
+Re-exported from the main entry — compose your own field from the same primitives the
+component uses.
+
+| Symbol                    | Source path                             | Purpose                                                                                                                                                                     |
+| ------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `usePhoneValidation`      | `@alikhalilll/a-tel-input`              | The libphonenumber-js wrapper — `validate`, `getRequiredInfo`, `searchCountries`, `getCountryByValue`, `getCountriesByDial`.                                                |
+| `useCountryMatching`      | `@alikhalilll/a-tel-input`              | Longest-prefix dial-code matching with tier-3 NANP tie-break.                                                                                                               |
+| `detectCountry`           | `@alikhalilll/a-tel-input`              | The IP → timezone → locale → default chain (callable standalone).                                                                                                           |
+| `useTypingPhase`          | `@alikhalilll/a-tel-input`              | Debounced typing-pause state machine.                                                                                                                                       |
+| `useTelInputValidation`   | `@alikhalilll/a-tel-input`              | View-layer facade (visible state, error message, show flags).                                                                                                               |
+| `useCountrySelection`     | `@alikhalilll/a-tel-input`              | Picker selection state machine (`iso2` + `source` enum + `detectionLocked`). The single state machine the component uses internally — useful when composing your own field. |
+| `useSyncedModel`          | `@alikhalilll/a-tel-input`              | Generic bidirectional sync between a `defineModel` ref and internal state, with the echo-loop guard built in. Reusable in any v-model bridge.                               |
+| `useTelField`             | `@alikhalilll/a-tel-input/vee-validate` | VeeValidate adapter — see [Form integration](#form-integration).                                                                                                            |
+| `zPhone` / `zPhoneObject` | `@alikhalilll/a-tel-input/zod`          | Zod schema factories — see [Form integration](#form-integration).                                                                                                           |
+| `normalizeDigits`         | `@alikhalilll/a-tel-input`              | Fold Arabic-Indic / Persian / Devanagari / Bengali numerals → ASCII.                                                                                                        |
+| `defaultFlagUrl`          | `@alikhalilll/a-tel-input`              | Default flagcdn URL builder.                                                                                                                                                |
+
+---
+
+## Theming
+
+The component renders with neutral defaults and reads global design tokens — restyle from
+your app's stylesheet without touching the component itself.
+
+### CSS custom properties
+
+Set these on `:root` (or any ancestor) to retint the component:
+
+| Token                      | Used for                              |
+| -------------------------- | ------------------------------------- |
+| `--ak-ui-background`       | Field + popover/drawer background.    |
+| `--ak-ui-foreground`       | Field + popover/drawer text.          |
+| `--ak-ui-input`            | Field border.                         |
+| `--ak-ui-ring`             | Focus ring colour.                    |
+| `--ak-ui-muted-foreground` | Dial prefix, hint text, placeholder.  |
+| `--ak-ui-destructive`      | Error border / ring / icon / message. |
+| `--ak-ui-radius`           | Field corner radius.                  |
+
+Valid / error tints (green / red) read literal values — override via the class hooks below.
+
+### Class hooks
+
+Each visual region accepts a class prop you can target with utility classes (Tailwind,
+your own utility framework, or plain CSS):
 
-### Composables & helpers (also exported)
+| Prop           | Targets                                                                    |
+| -------------- | -------------------------------------------------------------------------- |
+| `class`        | The root wrapper (`.a-tel-input`).                                         |
+| `fieldClass`   | The field row that contains input + dial + picker (`.a-tel-input__field`). |
+| `inputClass`   | The actual `<input>` element.                                              |
+| `hintClass`    | The hint paragraph below the field.                                        |
+| `errorClass`   | The error paragraph below the field.                                       |
+| `popoverClass` | The desktop popover surface.                                               |
+| `drawerClass`  | The mobile drawer surface.                                                 |
+| `contentClass` | Both branches (applied alongside `popoverClass` / `drawerClass`).          |
 
-`usePhoneValidation`, `useCountryDetection`, `useCountryMatching`, `useTypingPhase`,
-`useTelInputValidation`, `normalizeDigits`, `LOCALE_DIGIT_RANGES`, `defaultFlagUrl`,
-`aTelInputVariants`, `DEFAULT_MESSAGES`, `resolveMessages` — compose your own field from the same
-primitives `ATelInput` uses (see `ACountrySelect` / `AInput`).
+### Stateful selectors
+
+- `[data-state="idle" | "valid" | "error"]` on the root and on `.a-tel-input__field`.
+- `[data-size="xs" | "sm" | "md" | "lg" | "xl"]` on the root.
+- `[data-show-validation]` on the root when `showValidation` is on.
+- `[aria-invalid="true"]` on the input when the surfaced state is error.
+- `[aria-busy="true"]` on the input when `validating` is true.
+
+### Dark mode
+
+Light / dark is driven entirely by the `--ak-ui-*` tokens — set them to dark values under
+`[data-theme="dark"]` (or however your app gates dark mode) and everything follows.
+
+---
+
+## Accessibility
+
+- `aria-label` on the inner `<input>` (overrideable via `messages.phoneInputLabel`).
+- `aria-invalid="true"` mirrors the surfaced error state.
+- `aria-describedby` points at the hint / error line whenever it has content; the line is
+  an `aria-live="polite"` region so screen readers announce new errors.
+- `aria-errormessage` points at the same line when the field is in error.
+- `aria-busy="true"` on the input while `validating` is on.
+- Country picker is keyboard-navigable — arrow keys, `/` to focus search, Enter to pick,
+  Esc to close.
+- Focus management is handled by the underlying popover/drawer — focus returns to the
+  trigger on close.
+
+---
 
 ## Auto-import
 
-**Nuxt:**
+### Nuxt
 
 ```ts
 export default defineNuxtConfig({
   modules: ['@alikhalilll/a-tel-input/nuxt'],
-  css: [
-    '@alikhalilll/a-popover/styles.css',
-    '@alikhalilll/a-drawer/styles.css',
-    '@alikhalilll/a-tel-input/styles.css',
-  ],
+  // The single tel-input stylesheet already bundles popover + drawer styles + design tokens.
+  css: ['@alikhalilll/a-tel-input/styles.css'],
 });
 ```
 
-**Vite:** register `@alikhalilll/a-tel-input/resolver` in `unplugin-vue-components`.
+### Vite + `unplugin-vue-components`
+
+Register `@alikhalilll/a-tel-input/resolver`:
+
+```ts
+import Components from 'unplugin-vue-components/vite';
+import { ATelInputResolver } from '@alikhalilll/a-tel-input/resolver';
+
+export default { plugins: [Components({ resolvers: [ATelInputResolver()] })] };
+```
+
+---
 
 ## SSR
 
-Country detection runs only in `onMounted` — the field renders immediately with `defaultCountry`
-(or empty), and IP/timezone/locale resolution patches in on hydration. No SSR network calls.
+Country detection runs **only inside `onMounted`** — the field renders immediately with
+`defaultCountry` (or empty) on the server, and the IP / timezone / locale chain patches
+in on hydration. There are no SSR network calls, and `useEventScrollLock` short-circuits
+when `document` is unavailable.
+
+If `default-country` is set, the picker is visible at first paint and hydration is a
+no-op visually. If you rely on `detect-from-input`, the picker stays hidden until the
+client-side parser sees a leading dial code — also hydration-safe.
+
+---
+
+## TypeScript
+
+Import the public types from the main entry:
+
+```ts
+import type {
+  ATelInputProps,
+  ATelInputEmits,
+  ATelInputSlots,
+  ATelInputSize,
+  ATelInputDir,
+  ATelInputValidateOn,
+  TelInputMessages,
+  TelInputMessagesInput,
+  PhoneValidationResult,
+  PhoneValidationReason,
+  PhoneRequiredInfo,
+  CountryOption,
+} from '@alikhalilll/a-tel-input';
+```
+
+Slot props are inferable in templates:
+
+```vue
+<ATelInput #suffix="{ validationState, validation }"> … </ATelInput>
+```
+
+Or in script:
+
+```ts
+type SuffixProps = Parameters<NonNullable<ATelInputSlots['suffix']>>[0];
+```
+
+---
+
+## Browser support
+
+Modern evergreen browsers — last two versions of Chrome, Edge, Firefox, Safari, and the
+matching mobile WebViews. Uses `Intl.DisplayNames` for localized country names (universal
+since 2020). No polyfills required.
+
+---
+
+## Troubleshooting
+
+**Why is the picker hidden until I type?**
+`detectFromInput` is on by default — the field starts as a single clean input and the
+picker reveals once a leading dial code is recognised. Pass `default-country="EG"` (or
+any ISO2 / dial-code string) to show it pre-selected, or `:detect-from-input="false"`
+for the legacy always-visible picker.
+
+**How do I show validation only after blur?**
+`validateOn="blur"`. Or use `useTelField()` — its `fieldProps` already includes that.
+
+**I want a single E.164 value out of the field.**
+Two options. From a form: `useTelField()` tracks the E.164 string as VeeValidate's value
+(see [Form integration](#form-integration)). Without a form: `tellRef.value?.validation.full_phone`.
+
+**My Zod schema rejects a valid number.**
+Check `allowedDialCodes` and `country` — `zPhone({ country: 'EG' })` expects the **national**
+digits (`'1066105963'`), while `zPhone()` (no `country`) expects the **E.164** form
+(`'+201066105963'`). Use `zPhoneObject()` if you want to pass `{ phone, country }` directly.
+
+**The page underneath the drawer scrolls.**
+That was a bug in versions < 1.1.0 — the event scroll-lock was desktop-only. Upgrade.
+If you need the legacy `body { overflow: hidden }` style instead, set `scroll-lock="body"`.
+
+**Country auto-detect didn't work.**
+The default `ipEndpoint` is `https://ipapi.co/json/` — it's free-tier rate-limited.
+Either provide your own endpoint (`ip-endpoint="/api/geo"` returning `{ country_code }`),
+swap the entire chain via the `detector` prop, or disable IP and fall through to timezone:
+`detect-country="locale"`.
+
+---
 
 ## License
 
-MIT
+[MIT](./LICENSE) © alikhalilll