Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hkk97/country_selector_widget

Country Selector Widget written by Dart and Fluter supports three locales with the country's name, achieved lazy loading, and animation FadeIn. This package provides CountrySelectorWidget and showCountrySelectorBottomSheet to fulfill the needed usage.
https://github.com/hkk97/country_selector_widget

country-selector-widget dart dart-library flutter flutter-library

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/hkk97/country_selector_widget
Owner: hkk97
License: mit
Created: 2022-11-11T08:22:55.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2024-03-22T19:59:57.000Z (10 months ago)
Last Synced: 2024-04-24T06:01:24.977Z (9 months ago)
Topics: country-selector-widget, dart, dart-library, flutter, flutter-library
Language: Dart
Homepage: https://hkk97.github.io/country_selector_widget/#/
Size: 23 MB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Country Selector Widget

Country Selector Widget written by Dart and Flutter supports three locales with the country's name, achieved lazy loading, and animation FadeIn. This package provides CountrySelectorWidget and showCountrySelectorBottomSheet to fulfill the needed usage.

| | Android | iOS | Linux | macOS | Web | Windows |
|-------------|---------|------|-------|--------|-----|-------------|
| **Support** | Any | Any | Any | Any | Any | Any |

To see examples of the following animations on a device or simulator:

```bash
cd example/
flutter run
```

## Usage

To use this plugin, add `country_selector_widget` as a [dependency in your pubspec.yaml file].

### Examples

Here are the examples that show you how to use the CountrySelectorWidget and showCountrySelectorBottomSheet.

#### Usage of CountrySelectorWidget

- the default locale is SelectedLocale.en, you would change to SelectedLocale.zhCH or SelectedLocale.zhHK
- once the country is selected and clicked the continue btn it will trigger the valueChangedCallback called onSelectedCountry and return the Country

```dart
CountrySelectorWidget(
onSelectedCountry: (Country country) async {
// selected country callback
},
)
```

#### Usage of showCountrySelectorBottomSheet

- the different between CountrySelectorWidget and showCountrySelectorBottomSheet are showCountrySelectorBottomSheet is wrap with the showModalBottomSheet
- showCountrySelectorBottomSheet will also do the Navigator.pop(context) for you once the continue button are clicked

```dart
showCountrySelectorBottomSheet(
context: context,
onSelectedCountry: (Country country) async {
// selected country callback
};
```

## Parameters

| Parameter | Description |
|---|---|
| `withDialCode` | Used to determine whether show the dialCode of country or not |
| `refCountryCode` | Sets the default selected country |
| `customAppBar` | Sets the Custom AppBar instead of using provided default AppBar |
| `bottomAppBarHeight` | Sets the height for the bottom `Continue Section` widget |
| `continueBtnPadding` | The Padding between the bottom `Continue Section` and `Continue Button` widget |
| `selectedLocale` | Uses to determine the default label with locale, there are three `SelectedLocale`. They are `SelectedLocale.en`, `SelectedLocale.zhCH` and `SelectedLocale.zhHK` |
| `showSelectedWidget` | Uses to determine wether show the `CountryCardWidget` or not when the country is selected in the ListView |
| `aniDuration` | Duration of the FadeIn Animation of `CountryCardWidget` |
| `onSelectedCountry` | Callback of onSelectedCountry when the country is selected from ListView and ContinueButton is Clicked |
| `appBarText` | Uses to replace the default text of the AppBar |
| `searchText` | Uses to replace the hintText of `TextField` |
| `selectedCountryText` | Uses to replcae the title of the `SelectedCountryCardWidget` |
| `withoutMatchText` | Uses to replace the hintText when there are does not country match with the search pattern |
| `continueBtnText` | Uses to replace the text of the `Continue Button` |
| `textFieldTextStyle` | Uses to determine the textStyle of the `TextField` |
| `appBarTextStyle` | Uses to determine the textStyle of the `AppBar` |
| `searchTextStyle` | Uses to determine the textStyle of the SearchText |
| `selectedCountryTextStyle` | Uses to determine the textStyle of the selectedCountry |
| `withoutMatchTextStyle` | Uses to determine the textStyle of the WitoutMatchText when there does not the match match with serach pattern |
| `continueBtnTextStyle` | Uses to determine the textStyle of Continue Button |
| `focusedBorderColor` | Uses to determine the borderColor of `TextField` when it is selected |
| `selectedCardColor` | Uses to determine the color of Card when the `CountryCardWidget` is selected |
| `continueBtnBgColor` | Uses to determine the background color of Contuinue Button |
| `continueBtnOverlayColor` | Uses to determine overlay color of Contuinue Button |
| `textFieldborderRadius` | Uses to determine borderRadius of `TextField` |
| `continueBtnRadius` | Uses to determine borderRadius of Continue Button |

## Demonstration of CountrySelectorWidget - Flutter Web

!["CountrySelectorWidget - SelectedLocale.zhCH"](example/demo_gifs/countrySelectorWidget_demo.gif)

## Demonstration of showCountrySelectorBottomSheet - Flutter Web

!["showCountrySelectorBottomSheet - SelectedLocale.en"](example/demo_gifs/showCountrySelectorBottomSheet.gif)

## Demonstration of CountrySelectorWidget - Android

!["Demonstration of showCountrySelectorBottomSheet - Android"](example/demo_gifs/android_demo.gif)

## Demonstration of CountrySelectorWidget - IOS

!["Demonstration of showCountrySelectorBottomSheet - IOS"](example/demo_gifs/ios_demo.gif)

## Demonstration of showCountrySelectorBottomSheet - MacOS

!["Demonstration of showCountrySelectorBottomSheet - MacOS"](example/demo_gifs/mac_os_demo.gif)

## MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```