Cellphone Validator

A powerful and easy-to-use Flutter package for validating and formatting international phone numbers. Includes a customizable country code picker and provides detailed information for hundreds of countries.

Features

• Real-time Validation: Instantly check if a phone number is valid as the user types.
• Automatic Formatting: Applies the correct formatting mask to the phone number automatically.
• Integrated Country Picker: A clean UI widget that combines a country code dropdown with the phone number input field.
• Reactive Controller: Built with a ValueNotifier-based controller to easily listen for changes to the phone number's validity and value.
• Rich Country Data: Includes country names (with translations), ISO codes, dial codes, and flag emojis.

Getting Started

To start using the package, add the cellphone_validator dependency to your pubspec.yaml file:

dependencies:
  flutter:
    sdk: flutter
  cellphone_validator: ^<latest-version> # Replace with the latest version

Then, run flutter pub get in your terminal to install the package.

Features

🌐 Supported Languages

ar, de, en, es, fr, hi, id, it, ja, ko, pt, ru, ur — and more coming soon.

🧩 Widgets

Export List

How to Use

1. Initialize

• import the main package:

  • import 'package:cellphone_validator/cellphone_validator.dart';
    

2. Set Up Your App Widget

Create your main app widget as usual:

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

3. Create a PhoneValidator Controller in Your Stateful Widget

Create a PhoneValidator to manage phone validation and state.

 PhoneValidator phoneValidator = PhoneValidator(lang: 'en');

4. Build the UI Using Provided Widgets

Use the package’s widgets like PhoneInputSelectorView, PhoneSummaryView, and PhoneAutoDetectView to build your UI. For example:

/**
 *  How to use PhoneInputSelectorView
 * **/
PhoneInputSelectorView(phoneValidator: phoneValidator),

/**
 *  How to use PhoneSummaryView
 * **/
PhoneSummaryView(phoneValidator: phoneValidator, fullPhoneNumber: phoneValidator.phone.replaceAll('+', ''),)

/**
 *  How to use PhoneAutoDetectView
 * **/
 
PhoneAutoDetectView(phoneValidator: phoneValidator.value, fullPhoneNumber: ''),

• How to check if some value is true or false

    ListenableBuilder(
      listenable: phoneValidator.isValidPhoneNotifier,
      builder: (context, _) {
      return phoneValidator.isValidPhoneNotifier.value
        ? 'trueAction'
          :'false action' 
      },
    ),

You can listen to the isValidPhoneNotifier within the controller to react to changes in the phone number's validity in real-time.

Summary

• No need to load countries manually: The package handles it internally as a singleton.
• Just initialize once with CellPhoneValidator.init().
• Use the widgets with your PhoneValidator controller.
• Switch languages on the fly using your language dropdown.

Additional Information

• Found a Bug or Have a Feature Request? Please file an issue on our GitHub repository.
• Want to Contribute? We welcome pull requests! Feel free to fork the repository and submit your changes.
• License: This package is licensed under the Apache 2.0 License. See the LICENSE file for more details.

Help this project

If you find this package helpful and want to support its development, consider making a donation. Thank you for your support!

Badges