# PhoneInput Documentation

## Installation

```bash
jsrepo add ui/phone-input
```

## Components

### PhoneInput

The root component for the phone input.

#### Props

| Prop | Type | Default Value | Required | Bindable | Description |
|------|------|--------------|----------|----------|-------------|
| country | CountryCode | null | null | false | true | The selected country code. |
| defaultCountry | CountryCode | null | null | false | false | The default country code. |
| name | string | - | false | false | The name attribute for the input. |
| placeholder | string | - | false | true | The placeholder for the input. |
| disabled | boolean | false | false | true | Whether the input is disabled. |
| readonly | boolean | false | false | true | Whether the input is readonly. |
| class | string | - | false | false | Custom class for the input. |
| value | E164Number | null | null | false | true | The phone number value (E.164 format). |
| valid | boolean | false | false | true | Whether the current value is valid. |
| detailedValue | Partial<DetailedValue> | null | - | false | true | Detailed value object for the phone input. |
| options | TelInputOptions | defaultOptions | false | false | Options for the phone input. |
| order | (a: Country, b: Country) => number | - | false | false | Custom sort function for countries. |