rich_text_controller 3.0.1 copy "rich_text_controller: ^3.0.1" to clipboard
rich_text_controller: ^3.0.1 copied to clipboard

An extended text editing controller that supports different inline styles for custom regex patterns.

rich_text_controller #

Pub Version License Pub Points

rich_text_controller is an extended text editing controller for Flutter that supports applying different inline styles based on custom regex patterns. This package simplifies text styling and interaction in Flutter applications, making it easy to create feature-rich text inputs.


Table of Contents #

  1. Demo
  2. Features
  3. Installation
  4. Usage
  5. Contributing
  6. License

Demo #

Demo GIF

Features #

  • Custom Regex Styling: Apply styles dynamically to text patterns.
  • Interactive Callbacks: Define actions for user interactions with matched text.
  • Dynamic Updates: Modify regex patterns on the fly without recreating the controller.
  • IME Composition Support: Smooth handling for languages like Japanese and Chinese.
  • Performance Optimizations: Cached regex for better performance.
  • RichWrapper Widget: A widget for seamless integration with the controller.
  • Fine-grained Configuration: Control deletion behavior, styles, and tap actions for specific matches.

Installation #

  1. Add the package to your pubspec.yaml file:
dependencies:
  rich_text_controller: ^[latest_version]
copied to clipboard
  1. Run the following command to install the package:
flutter pub get
copied to clipboard
  1. Import the package into your Dart file:
import 'package:rich_text_controller/rich_text_controller.dart';
copied to clipboard

Usage #

Here's a quick example of how to use RichTextController to style specific patterns in a TextField:

Example #

import 'package:flutter/material.dart';
import 'package:rich_text_controller/rich_text_controller.dart';

defaultTextStyle(BuildContext context) => TextStyle(color: Colors.black);

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('RichTextController Example')),
        body: Center(
          child: Padding(
            padding: const EdgeInsets.all(16.0),
            child: TextField(
              controller: RichTextController(
                text: '',
                onMatch: (match, target) {
                  print('Match found: \$match');
                },
                targetMatches: [
                  MatchTargetItem(
                    textStyle: TextStyle(color: Colors.blue, fontWeight: FontWeight.bold),
                    regex: RegExp(r'#[a-zA-Z0-9_]+'),
                  ),
                  MatchTargetItem(
                    textStyle: TextStyle(color: Colors.green),
                    regex: RegExp(r'@[a-zA-Z0-9_]+'),
                  ),
                ],
              ),
              decoration: InputDecoration(border: OutlineInputBorder()),
            ),
          ),
        ),
      ),
    );
  }
}
copied to clipboard

Contributing #

Contributions are always welcome! Here’s how you can help:

  1. Report bugs or request features via GitHub Issues.
  2. Submit pull requests with well-documented code and examples.
  3. Share your thoughts and ideas to improve the package.

License #

Licensed under the MIT License. You are free to use, modify, and distribute this package. See the LICENSE.md file for details.

89
likes
160
points
10.8k
downloads

Publisher

verified publishermicazi.dev

Weekly Downloads

2024.08.10 - 2025.02.22

An extended text editing controller that supports different inline styles for custom regex patterns.

Repository (GitHub)

Documentation

API reference

License

MIT (license)

Dependencies

flutter, flutter_test

More

Packages that depend on rich_text_controller