mask_input_formatter

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

Um pacote Flutter que fornece um TextInputFormatter para TextField e TextFormField para formatar automaticamente a entrada do usuário de acordo com uma máscara especificada. Ajuda os usuários a inserir dados como números de telefone, datas ou IDs de forma estruturada, inserindo espaços reservados e caracteres de formatação dinamicamente enquanto digitam. O formatador suporta máscaras personalizadas e manipula corretamente o backspace e o movimento do cursor em todas as plataformas. Ideal para melhorar a precisão da entrada e a experiência do usuário em formulários que exigem formatos específicos.

Casos de uso

Entrada de número de telefone com código do país
Entrada de data com separadores
Formatação de número de cartão de crédito
Padrões numéricos ou alfanuméricos personalizados
Validação de formulário por meio da estrutura de entrada
Formatação de campo dinâmico

Principais recursos

Suporta máscaras personalizáveis
Gerencia o backspace e a posição do cursor
Compatibilidade multiplataforma
Formatação de entrada em tempo real
Integração fácil com TextField e TextFormField
Configuração flexível de espaço reservado e separador

Indicado para

Entradas de formulário que exigem dados estruturados
Aplicações móveis e web com validação de entrada
Interfaces de entrada de dados amigáveis ao usuário
Desenvolvedores procurando soluções simples de mascaramento
Aplicativos que precisam de padrões de entrada consistentes

Considerações

Pode exigir uma definição cuidadosa da máscara para evitar conflitos
Suporte limitado a máscaras dinâmicas complexas
Impacto no desempenho em entrada de alta frequência
Não adequado para tipos de entrada não-texto
Requer manipulação manual de casos especiais como operações de colagem

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

The package provides TextInputFormatter for TextField and TextFormField which format the input by a given mask.

Demo

Usage

Add dependency.

Run this command:

With Flutter:

$ flutter pub add mask_input_formatter

or add following package in your pubspec.yaml file inside the dependencies: section.

dependencies:
  mask_input_formatter: ^0.0.3

Importing the library:

import 'package:mask_input_formatter/mask_input_formatter.dart';

Create a mask formatter:

MaskInputFormatter myFormatter =  MaskInputFormatter(mask: '(AA) #####');

Set with TextField/TextFormField:

TextFormField(
    inputFormatters: [myFormatter],
    decoration: InputDecoration(
        hintText: "(AB) 12345",
    )
) // TextFormField

Result

// Input  --> JK75757
// Output --> (JK) 75757 set formatted text on TextField

Other Mask

You can use the mask whatever you defined in formatter:

MaskInputFormatter dateFormatter =  MaskInputFormatter(mask: '##/##/####');
// --> 26/05/2021
MaskInputFormatter phoneFormatter =  MaskInputFormatter(mask: '+# (###) ###-####');
// --> +1 (234) 567-8901
MaskInputFormatter numberFormatter =  MaskInputFormatter(mask: 'AAA-###', textAllCaps: true);
// --> XYZ-789

Check example folder for code sample

Note

In last example. --> (AAA-###)

'A' character will allow only letters from A-Z.
'#' character will allow only numbers.
And other characters and symbols will be added as mask.

Contributing

Suggestions and Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Developer Team:

Amjad Jamali & team members ( Kamran Khan, Hina Hussain, Faiza Farooqui ) :tada:

License

Apache 2.0

Buscar pacotes, repositórios e categorias de apps