A simple and easy to use flutter package to add a passwordfield to your Flutter project.
Getting Started #
- Add the dependency
dependencies: passwordfield: ^0.0.5 flutter:
- Import the package
- Voila! use the Widget
Note : The widget must be included in a Material Widget normally in a Scaffold,Card,Drawer etc
Now Supports adding constraints on the Password #
return Scaffold( backgroundColor: Colors.green, body: Padding( padding: EdgeInsets.symmetric(horizontal: 20, vertical: 20), child: Center( child: PasswordField( color: Colors.green, hasFloatingPlaceholder: true, pattern: r'.*[@$#.*].*', border: OutlineInputBorder( borderRadius: BorderRadius.circular(2), borderSide: BorderSide(width: 2, color: Colors.green)), focusedBorder: OutlineInputBorder( borderRadius: BorderRadius.circular(10), borderSide: BorderSide(width: 2, color: Colors.green)), errorMessage: 'must contain special character either . * @ # \$', ), )));
refer: for more examples
bool autoFocus: if autofocus is true keyboard pops up as soon as the widget is rendered on screen defaults to false
InputBorder border: Input Border for the password field when not in focus
Color color:changes the primary color of the PasswordField
TextEditingController controller:A controller for an editable passwordfield.
InputBorder errorFocusedBorder:Input Border for the password Field when in Focus and has an error
String errorMessage:custom message to show if the input password does not match the pattern.
InputBorder focusedBorder: Input Border for the password Field when in Focus
bool hasFloatingPlaceholder:whether the placeholder can float to left top on focus
final TextStyle hintStyle: styling the hint defaults to same as inputStyle if not specified
final String hintText:hint to show if the placeholder is false
TextStyle inputStyle:styling the passwordfield Text;
int maxLength: the max number of characters the password field can support
Function onSubmit:function triggerred when the submit button on keyboard is pressed
String pattern:pattern for the input password
Icon suffixIcon:Icon used to unhide the password when touch in Contact with the icon
bool suffixIconEnabled:suffix Icon can be removed by setting suffixIconEnabled to false,defaults to true
you are welcome to contribute to this package All you need to do is
- send a pull request
- request a feature
- or Create Issues
[0.0.1]- 25 Aug 2019
- Initial Release of the Package with basic functionality.
[0.0.2]- 26 Aug 2019
- updated readme file with examples and explanation
[0.0.3]- 03 Sep 2019
- minor changes and added support for border for the passwordfield
[0.0.4]- 06 Sep 2019
- added focusedBorder and border for the passwordField that allows more fexibility to decorate the passwordfield's border- color,width,radius & style.
[0.0.5]- 11 Jan 2020
- passwordfield now supports adding constraints on password in the form of regex pattern which is fully customisable.
- removed onchanged method.
- minor improvements and changes.
A new Flutter project.
Getting Started #
This project is a starting point for a Flutter application.
A few resources to get you started if this is your first Flutter project:
For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: passwordfield: ^0.0.5
2. Install it
You can install packages from the command line:
$ 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:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Feb 12, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.7.1
- pana: 0.13.5
- Flutter: 1.12.13+hotfix.7
The package description is too short. (-20 points)
Add more detail to the
description field of
pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.
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.