👏 PinEntryTextField

A fully customizable Pin Entry TextField.

The source code is 100% Dart, and everything resides in the /lib folder.

Show some ❤️ and star the repo to support the project

GIF

💻 Installation

In the dependencies: section of your pubspec.yaml, add the following line:

pin_entry_text_field: <latest_version>

Current Version : ^0.1.3

❔ Usage

Import this class

import 'package:pin_entry_text_field/pin_entry_text_field.dart';

use the widget anywhere you need to retrieve PIN or OTP, the only required attribute is the onSubmit callback

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: PinEntryTextField(
            onSubmit: (String pin){
              showDialog(
                context: context,
                builder: (context){
                  return AlertDialog(
                    title: Text("Pin"),
                    content: Text('Pin entered is $pin'),
                  );
                }
              ); //end showDialog()

            }, // end onSubmit
          ),
    );
  }

🎨 Customization and Attributes

All customizable attributes for PinEntryTextField

Attribute Name Example Value Description
fields 4 Specifies the number of TextField to generate, the default is 4
onSubmit (String returnedPin){} The onSubmit callback returns the entered pin, where the user types in the last pin or hit done key
fieldWidth 40.0 The size of each TextField, the default is 40.0
fontSize 20.0 TextField font size, the default is 20.0
isTextObscure false Determines if the text in the PinEntryTextField is bbscured or not. The default is false
showFieldAsBox false Determines if the TextField should have an OutlineInputBorder at the 4 edges, or just a bottom underline

👍 How to Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

📃 License

Copyright (c) 2018 Godson Ositadinma

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.

Getting Started

For help getting started with Flutter, view our online documentation.

For help on editing package code, view the documentation.

Libraries

pin_entry_text_field