패키지, 저장소 및 앱 카테고리 검색

fl_country_code_picker 표지
패키지 상세v0.1.9+1

fl_country_code_picker

국가 전화 번호 코드를 포함하는 모달을 표시하기 위한 플러터 패키지입니다. 사용자는 사용 가능한 코드를 검색하고 모달에서 바로 선택할 수 있습니다.

AndroidiOSWebmacOSWindowsLinux
30일 다운로드
797
좋아요
117
Pub 점수
160

패키지 설치

flutter pub add fl_country_code_picker

패키지 개요

공개 정보를 바탕으로 생성한 선택 가이드입니다.

국가와 각각의 통화 코드를 표시하는 모달 대화 상자를 제공하는 플러터 패키지입니다. 사용자는 목록을 검색하여 빠르게 국가를 찾고 선택할 수 있어 국제 전화번호 입력 필드에 이상적입니다. 이 패키지는 안드로이드, iOS, 웹, 맥OS, 윈도우, 리눅스 등 여러 플랫폼을 지원하며 기기 간 일관된 동작을 보장합니다. 가볍고 쉽게 통합 가능하며, 국가 코드 선택을 단순화함으로써 사용자 경험을 향상시킵니다.

사용 사례

  • 국제 전화번호 입력
  • 사용자 프로필 국가 선택
  • 다중 지역 앱 로컬라이제이션
  • 국가 데이터가 필요한 온보딩 흐름
  • 국가 전화 번호 코드가 필요한 폼 필드

주요 기능

  • 검색 가능한 국가 목록
  • 모달 대화 상자 인터페이스
  • 모든 주요 플랫폼을 지원합니다
  • 텍스트 필드와의 간편한 통합
  • 사전 정의된 국가 전화 코드
  • 사용자 정의 가능한 외관

적합한 대상

  • 국제 전화번호 입력이 필요한 앱
  • 글로벌 사용자 등록 시스템
  • 여행 또는 통신 앱
  • 크로스 플랫폼 모바일 애플리케이션
  • 국가 선택이 필요한 UI 컴포넌트

고려 사항

  • 폼 로직 내에서 선택된 코드를 수동으로 처리해야 합니다
  • 기본 스타일링을 초과한 제한된 사용자 정의
  • 전화번호에 대한 내장 검증 없음
  • 영어 이외의 사용자를 위해 추가적인 로컬라이제이션이 필요할 수 있습니다
  • 국가 목록에 대한 외부 데이터 소스에 의존합니다

원본 README

연결된 소스 저장소의 README 원문 스냅샷입니다. 최신 내용은 저장소에서 확인하세요.

fl_country_code_picker

style: very good analysisLicense: MIT

A Flutter package for showing a modal that contains country dial code. The user can search for the available codes and select right from the modal. Also, it has an automatic scrolling feature that points at current device's locale. Supports localizations!

Where do the data come from? Check the references for more information about the data.

📌 Examples

🕹️ Usage

Instantiate FlCountryCodePicker class to access the package's functionalities and properties. You can also pass some optional parameters to customize the picker's view.

/// Default.
final countryPicker = const  FlCountryCodePicker();

/// With custom params.
final countryPickerWithParams = const FlCountryCodePicker(
      localize: true,
      showDialCode: true,
      showSearchBar: true,
      favoritesIcon: _yourIcon,
      favorites: _yourFavorites,
      title: _yourModalTitleWidget,
      filteredCountries: _yourFilters,
      countryTextStyle: _yourCountryTextStyle,
      dialCodeTextStyle: _yourdialCodeTextStyle,
      searchBarDecoration: _yourInputDecoration,
    );

Call the modal for country code picker.

    GestureDetector(
    onTap: () async {
        // Show the country code picker when tapped.
        final picked= await countryPicker.showPicker(context: context);
        // Null check
        if (picked!= null) print(picked);
    },
    child: Container(
        padding: const  EdgeInsets.symmetric(
        horizontal: 8.0, vertical: 4.0),
        margin: const  EdgeInsets.symmetric(horizontal: 8.0),
        decoration: const  BoxDecoration(
        color: Colors.blue,
        borderRadius: BorderRadius.all(Radius.circular(5.0))),
        child: Text('Show Picker', style: const  TextStyle(color: Colors.white)),
        ),
    ),

To enable localization, add the following lines in your MaterialApp.

import  'package:fl_country_code_picker/fl_country_code_picker.dart' as flc;
MaterialApp(
	title: 'Your App',
	// Supported locales at the moment.
	// Cannot find your locale? Please make a request.
	supportedLocales: flc.CountryLocalizations.supportedLocales.map(Locale.new),
	localizationsDelegates: const [
	    // Package's localization delegate.
        // You can still add other delegates from your app.
		CountryLocalizations.delegate,
	],
	// ... some omitted values
);

🆕 What's New?

  • Added i18n support for Burmese (Myanmar)

  • Improved documentation by adding data references.

  • Added support for National Significant Numbers (NSN) per country.

    • Check the example for default view to use NSN.

FlCountryCodePicker

FlCountryCodePicker class contains all of the functionalities of this package. This contains (optional) properties that can be supply to achieve customization at picker's view or appearance.

Fields Type Description
title Widget? An optional argument for modal's title customization.
defaultAppbarBackgroundColor Color An optional argument to set the background color of default appbar. Its default value is white.
defaultAppbarForegroundColor Color An optional argument to set the foreground color of default appbar. It is the color of icon and text in the default appbar. Its default value is black.
defaultAppbarCloseIconBackgroundColor Color An optional argument to set the background color of the close icon on the appbar. Its default value is Color.fromARGB(255, 224, 224, 224).
defaultAppbarText String An optional argument to change the title default appbar. Its default value is Select Country Code.
defaultAppbarCloseIcon IconData An optional argument to change the close icon of the default appbar. Its default value is Icons.clear_rounded.
localize bool An optional argument for localizing the country names based on device's current selected Language (country/region). Make sure to add the required delegates to your MaterialApp. Defaults to true.
horizontalTitleGap double? An optional argument for horizontal space between flag, country name, and trailing icon.
searchBarDecoration InputDecoration? An optional argument for appearance customization of modal's search bar.
showDialCode bool An optional argument for showing dial code at each tile. Defaults to true.
showSearchBar bool An optional argument for showing search bar. Defaults to true.
favorites List<String>? Favorite countries that can be shown at the top of the list. Should supply the 2 character ISO code of the country e.g. ['US', 'PH', 'AU']
filteredCountries List<String>? Filters all of the [CountryCode]s available and only show the codes that are existing in this list. Should supply the 2 character ISO code of the country e.g. ['US', 'PH', 'AU']
favoritesIcon Icon Custom icon of favorite countries. Defaults to ❤️.
countryTextStyle TextStyle? An optional argument for country name text customization.
dialCodeTextStyle TextStyle? An optional argument for phone code text customization.
searchBarTextStyle TextStyle? An optional argument for search bar text customization.

showPicker

showPicker is a method under the FlCountryCodePicker that can be used to show and customize the country code picker modal.

Fields Type Description
context BuildContext A handle to the location of a widget in the widget tree. Required.
isFullScreen bool Shows the modal in full screen mode. Defaults to false.
shape ShapeBorder The shape of the modal. Defaults to RoundedRectangleBorder with rounded top corners.
pickerMinHeight double Picker modal constraints for minimum height. Defaults to 150.
pickerMaxHeight double Picker modal constraints for maximum height. Defaults to 500.
scrollToDeviceLocale bool Property to automatically scroll at device's locale within the picker. Defaults to false.
initialSelectedLocale String? The 2 character ISO code of the country where the scrollController will automatically scroll to.
barrierColor Color Color of the modal barrier. Defaults to black with low opacity.
clipBehavior Clip? Can be passed in to customize the appearance of modal. Defaults to Clip.hardEdge.
backgroundColor Color? Can be passed in to customize the appearance of modal. Defaults to white.

CountryCode

CountryCode model can be used to manipulate the selected country code by the user.

Fields Parameter Returns Description
name n/a String The name of the country
code n/a String The 2 character ISO code of the country
dialCode n/a String The country dial code. By convention, international telephone numbers are represented by prefixing the country code with a plus sign (+). e.g. +1 for US
nationalSignificantNumber n/a int? The number of digits that allow to uniquely identify a number within the country. It excludes the country code and any trunk code or access code. It includes the mobile prefix towards the total number of digits.
Returns null if country doesn't have concrete value for NSN.
flagImage n/a Widget Widget that can be used on retrieving the selected country flag's image.
flagUri n/a String Uri of this CountryCode located at package's directory to supply at Image widget if you're going to get the raw flag image.
flagImagePackage n/a String Package to supply at Image widget if you're going to get the raw flag image.
localize n/a String Convenient getter for localized version of this country code.
fromDialCode String? CountryCode Static method that gets CountryCode based on the given dial code. Returns null if not found. e.g. CountryCode.fromDialCode('+63')
fromCode String? CountryCode Static method that gets CountryCode based on the given country code. Returns null if not found. e.g. CountryCode.fromCode('PH')
fromName String? CountryCode Static method that gets CountryCode based on the given country name. Returns null if not found. e.g. CountryCode.fromName('Philippines')

❓ FAQ:
  • How to use country code's flag directory in Image widget?
Image.asset(
       fit: fit,
       width: width,
       countryCode.flagUri,
       alignment: alignment,
       package: countryCode.flagImagePackage,
);
  • How to change modal's title?

First, Create your title Widget.

	const Widget title = Padding(
		padding: EdgeInsets.all(16),
		child: Text(
		'My Title',
		style: TextStyle(fontSize: 20, fontWeight: FontWeight.bold),
		),
	);

Then pass it to FlCountryCodePicker's title parameter.

countryPicker = const  FlCountryCodePicker(title: title);

📚 References

  • Internationalization Codes: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
  • Country Codes: https://countrycode.org
  • International Call Prefixes: https://www.globalcallforwarding.com/international-call-prefixes
  • National Significant Number https://en.wikipedia.org/wiki/List_of_mobile_telephone_prefixes_by_country

🐞 Bugs/Requests

If you encounter any problems feel open an issue. If you feel the library is missing a feature, please raise a ticket on Github and we'll look into it. Pull request are also welcome.

📃 License

MIT License

카테고리

의존성

의존성 목록 1 개

소스 저장소

이 패키지를 사용하는 프로젝트

아직 데이터가 없습니다.