v1.0.1

Merge pull request #1 from Daniel-Ioannou/v1.0.2
Daniel-Ioannou · Aug 12, 2020 · d7ae4a8 · d7ae4a8
2 parents 8dea02d + ea68dcd
commit d7ae4a8
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
 ## [1.0.0] - 11 Aug 2020
 
 * Initial developers preview release.
+
+## [1.0.1] - 12 Aug 2020
+
+* Add documentation.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ A flutter package to select a country from a list of countries.
  Add the package to your pubspec.yaml:
 
  ```yaml
- country_picker: ^1.0.0
+ country_picker: ^1.0.1
  ```
  
  In your dart file, import the library:

diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -56,7 +56,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.0.1"
+    version: "1.0.0"
   crypto:
     dependency: transitive
     description:

diff --git a/lib/country_picker.dart b/lib/country_picker.dart
@@ -7,6 +7,15 @@ import 'src/country_list_bottom_sheet.dart';
 
 export 'src/country.dart';
 
+/// Shows a bottom sheet containing a list of countries to select one.
+///
+/// The callback function [onSelect] call when the user select a country.
+/// The function called with parameter the country that the user has selected.
+/// If the user cancels the bottom sheet, the function is not call.
+///
+/// The `context` argument is used to look up the [Scaffold] for the bottom
+/// sheet. It is only used when the method is called. Its corresponding widget
+/// can be safely removed from the tree before the bottom sheet is closed.
 void showCountryPicker({
   @required BuildContext context,
   @required ValueChanged<Country> onSelect,

diff --git a/lib/src/country_list_view.dart b/lib/src/country_list_view.dart
@@ -1,8 +1,8 @@
-import 'package:country_picker/res/country_codes.dart';
 import 'package:country_picker/src/utils.dart';
 import 'package:flutter/material.dart';
 
 import 'country.dart';
+import 'res/country_codes.dart';
 
 class CountryListView extends StatefulWidget {
   /// Called when a country is select.

diff --git a/lib/res/country_codes.dart → lib/src/res/country_codes.dart b/lib/res/country_codes.dart → lib/src/res/country_codes.dart
@@ -1,4 +1,4 @@
-List<Map<String, dynamic>> countryCodes = [
+final List<Map<String, dynamic>> countryCodes = [
   {
     "e164_cc": "93",
     "iso2_cc": "AF",

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,7 +1,7 @@
 name: country_picker
 description: A flutter package to select a country from a list of countries.
 
-version: 1.0.0
+version: 1.0.1
 homepage: https://github.com/Daniel-Ioannou
 repository: https://github.com/Daniel-Ioannou/flutter_country_picker