flutter_otp_text_field 0.0.1+1

  • Readme
  • Changelog
  • Installing
  • 82

flutter_otp_text_field #

pub package License: MIT GitHub top language

flutter_otp_text_field #

Flutter_Otp_Text_Field is a TextField widget to help display different style pin. It supports all the platforms flutter supports.

Feature 👇👇 #

  • allows you to customize the shape of textField in any way you want
  • built-in 2 commonly used pin styles of shape
  • obscure support
  • input decoration support
  • support all the textField properties support
  • Flutter web support

Installing 🔧 #

Install the latest version from pub.

Installing #

Use this package as a library #

1. Depend on it #

Add this to your package's pubspec.yaml file:

dependencies:
  flutter_otp_text_field: ^0.0.1

2. Install it #

You can install packages from the command line: with Flutter:

$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it #

Now in your Dart code, you can use:

import 'package:flutter_otp_text_field/flutter_otp_text_field.dart';

Usage #

        OtpTextField(
            numberOfFields: 5,
            borderColor: Color(0xFF512DA8),
            showFieldAsBox: true, //set to true to show as box or false to show as dash
            onCodeChanged: (String code) {
                //handle validation or checks here           
            },
            onSubmit: (String verificationCode){
              showDialog(
                  context: context,
                  builder: (context){
                    return AlertDialog(
                      title: Text("Verification Code"),
                      content: Text('Code entered is $verificationCode'),
                    );
                  }
              );
            }, // end onSubmit
          ),

Attributes #

Customizable attributes for PinInputTextField

Attribute Name Example Value Description
numberOfFields 4 The default is 4
fieldWidth 40 allows to change the width of the textField
showFieldAsBox true changes the default decoration of the textFields to a box with borderRadius of 4.0
hasCustomInputDecoration true set this to true if you want to pass your own decoration
decoration InputDecoration set hasCustomInputDecoration to true and pass your own input decoration the way you see fit
filled false set to true if you want to pass a fillColor
fillColor Colors.red pass fillColor and set filled to true
borderRadius BorderRadius.all(Radius.circular(4.0)) pass BorderRadius to customise textField when showFieldAsBox is set to true
margin EdgeInsets.only(right: 8.0) customize the margin between each textField
textStyle TextStyle(fontSize: 20, color: Colors.green); Add custom textStyle
borderWidth 2.0 Default value is 2.0, allows you to customize the width of the border
cursorColor Colors.blue Change color of textFields cursor. Defaults to [ThemeData.cursorColor] or [CupertinoTheme.primaryColor] depending on [ThemeData.platform].
mainAxisAlignment MainAxisAlignment.center Defaults to MainAxisAlignment.center
crossAxisAlignment CrossAxisAlignment.center Defaults to CrossAxisAlignment.center
onSubmit (String pin){} The callback will execute when user is done inputting the verification code.
keyboardType TextInputType.number Just like TextField's keyboardType, the default is TextInputType.number
autoFocus false Same as TextField's autoFocus, the default is false
enabled true Same as TextField's enabled, the default is true
obscureText false Defaults to false
onCodeChanged (String code){} Executes every time a value is entered into the textField. Same as TextField's onChanged

[0.0.1] - 2020/04/19 #

  • added customizable input decoration
  • added customizable borderRadius
  • added customizable borderColor and borderWidth for focused and disabled border
  • added onChanged to observe the text changed
  • added OnSubmit to handle submits, validation and navigation after text changed

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_otp_text_field: ^0.0.1+1

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_otp_text_field/flutter_otp_text_field.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
67
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
82
Learn more about scoring.

We analyzed this package on Jul 7, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.14
  • Flutter: 1.17.5

Analysis suggestions

Package not compatible with SDK dart

Because:

  • flutter_otp_text_field that is a package requiring null.

Health issues and suggestions

Document public APIs. (-0.03 points)

29 out of 30 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/flutter_otp_text_field.dart.

Run flutter format to format lib/flutter_otp_text_field.dart.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and flutter_otp_text_field.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8 1.2.1
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8
Dev dependencies
flutter_test