bhrott/flutter-masked-text
A masked text for Flutter.
github 로 이동하여 다운로드flutter_masked_text
Masked text input for flutter.
Alert
Hi guys!
Unfortunately, I’m not developing mobile anymore. This repo will not receive updates.
Install
Follow this GUIDE
Usage
Import the library
import 'package:flutter_masked_text/flutter_masked_text.dart';
MaskedText
Create your mask controller:
var controller = new MaskedTextController(mask: '000.000.000-00');
Set controller to your text field:
return new MaterialApp(
title: 'Flutter Demo',
theme: new ThemeData(
primarySwatch: Colors.blue,
),
home: new SafeArea(
child: new Scaffold(
body: new Column(
children: <Widget>[
new TextField(controller: controller,) // <--- here
],
),
),
),
);
This is the result:
Mask Options
In mask, you can use the following characters:
0
: accept numbersA
: accept letters@
: accept numbers and letters*
: accept any character
Initial Value
To start a mask with initial value, just use text
property on constructor:
var controller = new MaskedTextController(mask: '000-000', text: '123456');
Update text programaticaly
If you want to set new text after controller initiatialization, use the updateText
method:
var controller = new MaskedTextController(text: '', mask: '000-000');
controller.updateText('123456');
print(controller.text); //123-456
Using custom translators
If you want to use your custom regex to allow values, you can pass a custom translation dictionary:
const translator = {
'#': new RegExp(r'my regex here')
};
var controller = new MaskedTextController(mask: '####', translator: translator);
If you want to use default translator but override some of then, just get base from getDefaultTranslator
and override what you want (here is a sample for obfuscated credit card):
var translator = MaskedTextController.getDefaultTranslator(); // get new instance of default translator.
translator.remove('*'); // removing wildcard translator.
var controller = new MaskedTextController(mask: '0000 **** **** 0000', translator: translator);
controller.updateText('12345678');
print(controller.text); //1234 **** **** 5678
Change the mask in runtime
You can use the updateMask
method to change the mask after the controller was created.
var cpfController = new MaskedTextController(text: '12345678901', mask: '000.000.000-00');
print(cpfController.text); //'123.456.789-01'
cpfController.updateMask('000.000.0000-0');
print(cpfController.text); //'123.456.7890-1'
Hook: beforeChange [v0.7.0+]
In some cases, you will want to validate the mask value to decide if it’s allowed to input or not.
It’s simple: you just need to set the beforeChange
and return true
or false
. If you return true
, it will accept the new value and will try to apply the mask. Otherwhise, it will reject the new value.
The function receives two parameters:
previous
: the previous text of the controller.next
: the next text that will be masked.
var controller = new MaskedTextController(mask: '(00) 0000-0000');
controller.beforeChange = (String previous, String next) {
// my logic here
return true;
};
Hook: afterChange [v0.7.0+]
This function will be called after setted in the controller.
The function receives two parameters:
previous
: the previous text of the controller.next
: the next text that will be masked.
var controller = new MaskedTextController(mask: '(00) 0000-0000');
controller.afterChange = (String previous, String next) {
print("$previous | $next");
};
Money Mask
To use money mask, create a MoneyMaskedTextController:
var controller = new MoneyMaskedTextController();
//....
new TextField(controller: controller, keyboardType: TextInputType.number)
Decimal and Thousand separator
It’s possible to customize decimal
and thousand
separators:
var controller = new MoneyMaskedTextController(decimalSeparator: '.', thousandSeparator: ',');
Set value programaticaly
To set value programaticaly, use updateValue
:
controller.updateValue(1234.0);
Get double value
To get the number value from masked text, use the numberValue
property:
double val = controller.numberValue;
Using decoration symbols
You can use currency symbols if you want:
// left symbol
var controller = new MoneyMaskedTextController(leftSymbol: 'R\$ ');
controller.updateValue(123.45);
print(controller.text); //<-- R$ 123,45
// right symbol
var controller = new MoneyMaskedTextController(rightSymbol: ' US\$');
controller.updateValue(99.99);
print(controller.text); //<-- 99,99 US$
// both
var controller = new MoneyMaskedTextController(leftSymbol: 'to pay:', rightSymbol: ' US\$');
controller.updateValue(123.45);
print(controller.text); //<-- to pay: 123,45 US$
hook: afterChange [v0.7.0+]
You can watch for mask and value changes. To do this, just set the afterChange
hook.
This function receives two parameters:
masked
: the masked text of the controller.raw
: the double value of the text.
var controller = new MoneyMaskedTextController();
controller.afterChange = (String masked, double raw) {
print("$masked | $raw");
};
Defining decimal places [v0.8.0+]
You can define the number of decimal places using the precision
prop:
var controller = new MoneyMaskedTextController(precision: 3);
controller.updateValue(123.45);
print(controller.text); //<-- 123,450
Using default TextEditingController
The MaskedTextController and MoneyMaskedTextController extends TextEditingController. You can use all default native methods from this class.
Samples
You can check some code samples in this repo: flutter-masked-text-samples
TODO
- [x] Custom translations
- [x] Money Mask
- [ ] Raw Text Widget
![](/images/banner-woo.jpg)
bhrott/flutter-masked-text 에 관련된 우수 프로젝트 추천 다운로드
AppFlowy
47859
AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
localsend
33797
An open-source cross-platform alternative to AirDrop
spotube
23772
🎧 Open source Spotify client that doesn't require Premium nor uses Electron! Available for both desktop & mobile!
revanced-manager
15035
💊 Application to use ReVanced on Android
gsy_github_app_flutter
14559
Flutter 超完整的开源项目,功能丰富,适合学习和日常使用。GSYGithubApp系列的优势:我们目前已经拥有Flutter、Weex、ReactNative、kotlin 四个版本。 功能齐全,项目框架内技术涉及面广,完成度高,持续维护,配套文章,适合全面学习,对比参考。跨平台的开源Github客户端App,更好的体验,更丰富的功能,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验Σ( ̄。 ̄ノ)ノ。同款Weex版本 : https://github.com/CarGuo/GSYGithubAppWeex 、同款React Native版本 : https://github.com/CarGuo/GSYGithubApp 、原生 kotlin 版本 https://github.com/CarGuo/GSYGithubAppKotlin
dio
12249
A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc.
gopeed
11832
A modern download manager that supports all platforms. Built with Golang and Flutter.
bloc
11441
A predictable state management library that helps implement the BLoC design pattern
getx
9899
Open screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.
flame
8846
A Flutter based game engine.
flutter_deer
7595
🦌 Flutter 练习项目(包括集成测试、可访问性测试)。内含完整UI设计图,更贴近真实项目的练习。Flutter practice project (including integration testing and accessibility testing). Contains complete UI design drawings for a more realistic practice project.
fish-redux
7343
An assembled flutter application framework.
fl_chart
6451
FL Chart is a highly customizable Flutter chart library that supports Line Chart, Bar Chart, Pie Chart, Scatter Chart, and Radar Chart.
pixez-flutter
6360
一个支持免代理直连及查看动图的第三方Pixiv flutter客户端
Flutter-Responsive-Admin-Panel-or-Dashboard
6355
Responsive Admin Panel or Dashboard using Flutter
aidea
6021
AIdea 是一款支持 GPT 以及国产大语言模型通义千问、文心一言等,支持 Stable Diffusion 文生图、图生图、 SDXL1.0、超分辨率、图片上色的全能型 APP。
riverpod
5828
A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
pikapika
5463
美观易用且无广告的漫画和游戏客户端,同时支持MacOS,Windows,Android,iOS。
provider
5029
InheritedWidgets, but simple
getwidget
4416
Most popular and easy to use open source UI library with 1000+ Widgets to build flutter app.