https://github.com/RounakTadvi/text_input_formatter_kit

A lightweight and utility-driven package offering custom TextInputFormatter implementations to enhance and standardize user input in Flutter forms.
https://github.com/RounakTadvi/text_input_formatter_kit

dart flutter textfield validation

Last synced: 3 months ago
JSON representation

A lightweight and utility-driven package offering custom TextInputFormatter implementations to enhance and standardize user input in Flutter forms.

• Host: GitHub
• URL: https://github.com/RounakTadvi/text_input_formatter_kit
• Owner: RounakTadvi
• License: mit
• Created: 2024-08-18T14:28:38.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-19T12:09:07.000Z (3 months ago)
• Last Synced: 2024-08-19T16:13:31.887Z (3 months ago)
• Topics: dart, flutter, textfield, validation
• Language: Dart
• Homepage:
• Size: 13.4 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🎨 Text Input Formatter Kit

[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]

[![codecov](https://codecov.io/gh/RounakTadvi/text_input_formatter_kit/branch/main/graph/badge.svg?token=74GHL9G2R1)](https://codecov.io/gh/RounakTadvi/text_input_formatter_kit)

[![License: MIT][license_badge]][license_link]

**text_input_formatter_kit** is a lightweight and utility-driven package offering custom TextInputFormatter implementations to enhance and standardize user input in Flutter forms.

## Features ✨

- **CapitalizeTextFormatter**: Capitalizes the first letter of each word in the input text. 🅰️

- **LowerCaseTextFormatter**: Converts all input text to lowercase. 🔠

- **NoEmojiTextInputFormatter**: Restricts input to exclude emojis. 🚫😊

- **ReplaceWhiteSpaceTextInputFormatter**: Replaces all spaces with a specified character. 🔄

- **RestrictDigitsAndSpecialCharactersTextInputFormatter**: Excludes digits and special characters. 🚫🔢

- **SpacerInputFormatter**: Adds a space after every specified number of characters. 🔢🔠

## Getting Started 💻

**❗ In order to start using Text Input Formatter Kit you must have the [Flutter SDK][flutter_install_link] installed on your machine.**

Install via `flutter pub add`:

```sh

dart pub add text_input_formatter_kit

```

```dart

import 'package:text_input_formatter_kit/text_input_formatter_kit.dart';

TextField(

  inputFormatters: [

    // Capitalizes the first letter of each word

    CapitalizeTextFormatter(), 

    // Converts all input text to lowercase

    LowerCaseTextFormatter(),  

    // Restricts input to exclude emojis

    NoEmojiTextInputFormatter(),  

    // Replaces spaces with underscore

    ReplaceWhiteSpaceTextInputFormatter(replacementChar: '_'), 

    // Excludes digits and special characters

    RestrictDigitsAndSpecialCharactersTextInputFormatter(),  

    // Adds a space after every 4 characters

    SpacerInputFormatter(spaceEvery: 4),  

  ],

);

```

See `example` folder for more examples.

## Demo

![Demo](https://raw.githubusercontent.com/RounakTadvi/text_input_formatter_kit/release/0.0.1/assets/demo.gif?raw=true)

## Contribution 🤝

Contributions are welcome! If you have suggestions for new formatters or improvements to existing ones, feel free to create an issue or submit a pull request.

[flutter_install_link]: https://docs.flutter.dev/get-started/install

[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg

[license_link]: https://opensource.org/licenses/MIT

[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg

[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis