easy_rich_text 1.0.3

The EasyRichText widget provides an easy way to use RichText. You do not have to split the string manually.

example/lib/main.dart

import 'package:flutter/gestures.dart';
import 'package:flutter/material.dart';
import 'package:easy_rich_text/easy_rich_text.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'EasyRichText Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'EasyRichText Demo'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key, this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Padding(
        padding: const EdgeInsets.all(8.0),
        child: Container(
          child: Center(
            child: SingleChildScrollView(
              child: Column(
                mainAxisAlignment: MainAxisAlignment.spaceEvenly,
                crossAxisAlignment: CrossAxisAlignment.center,
                children: <Widget>[
                  //trademark example
                  EasyRichText(
                    "ProductTM is a superscript trademark symbol. This TM is not a trademark.",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'TM',
                        superScript: true,
                        stringBeforeTarget: 'Product',
                        matchWordBoundaries: false,
                        style: TextStyle(color: Colors.blue),
                      ),
                    ],
                  ),
                  //simple example
                  EasyRichText(
                    "I want blue font. I want bold font. I want italic font.",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'italic',
                        style: TextStyle(fontStyle: FontStyle.italic),
                      ),
                      EasyRichTextPattern(
                        targetString: 'blue',
                        style: TextStyle(color: Colors.blue),
                      ),
                      EasyRichTextPattern(
                        targetString: 'bold',
                        style: TextStyle(fontWeight: FontWeight.bold),
                      ),
                    ],
                  ),

                  ///list of targetString have same text decoration.
                  EasyRichText(
                    "bold1 TEST bold2 TEST bold3",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: ['bold1', 'bold2', 'bold3'],
                        style: TextStyle(fontWeight: FontWeight.bold),
                      )
                    ],
                  ),

                  //default style
                  EasyRichText(
                    "This is a EasyRichText example with default grey font. I want blue font here.",
                    defaultStyle: TextStyle(color: Colors.grey),
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'blue',
                        style: TextStyle(color: Colors.blue),
                      ),
                      EasyRichTextPattern(
                        targetString: 'bold',
                        style: TextStyle(fontWeight: FontWeight.bold),
                      ),
                    ],
                  ),
                  //superscript and subscript
                  EasyRichText(
                    "I want superscript font here. I want subscript here",
                    patternList: [
                      EasyRichTextPattern(
                          targetString: 'superscript', superScript: true),
                      EasyRichTextPattern(
                          targetString: 'subscript', subScript: true),
                    ],
                  ),
                  //conditional match
                  EasyRichText(
                    "I want blue color here. I want no blue font here. I want blue invalid here.",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'blue',
                        stringBeforeTarget: 'want',
                        stringAfterTarget: "color",
                        style: TextStyle(color: Colors.blue),
                      ),
                    ],
                  ),
                  //matchOption can be a string or a list
                  //string: 'all', 'first', 'last'
                  //List<dynamic>:'first', 'last', and any integer index
                  //For example, [0, 1, 'last'] will match the first, second, and last one.
                  EasyRichText(
                    "blue 1, blue 2, blue 3, blue 4, blue 5",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'blue',
                        //matchOption: 'all'
                        matchOption: [0, 1, 'last'],
                        style: TextStyle(color: Colors.blue),
                      ),
                    ],
                  ),

                  //All RichText properties accessible
                  EasyRichText(
                    "TextOverflow.ellipsis, TextAlign.justify, maxLines: 1. TextOverflow.ellipsis, TextAlign.justify, maxLines: 1.",
                    textAlign: TextAlign.justify,
                    maxLines: 1,
                    overflow: TextOverflow.ellipsis,
                  ),

                  //regular expression
                  EasyRichText(
                    "Regular Expression. I want blue bluea blue1 but not blueA",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'bl[a-z0-9]*',
                        style: TextStyle(color: Colors.blue),
                      ),
                    ],
                  ),

                  //case insensitivity
                  EasyRichText(
                    "Case-Insensitive String Matching. I want both Blue and blue.",
                    caseSensitive: false,
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'Blue',
                        style: TextStyle(color: Colors.blue),
                      ),
                    ],
                  ),

                  //selectable.
                  EasyRichText(
                    "This paragraph is selectable...",
                    selectable: true,
                  ),

                  ///urls, will disable superscript and subscript
                  EasyRichText(
                    "Here is a website https://pub.dev/packages/easy_rich_text. Here is a email address [e-mail]. Here is a telephone number [phone].",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'https://pub.dev/packages/easy_rich_text',
                        urlType: 'web',
                        style: TextStyle(
                          decoration: TextDecoration.underline,
                        ),
                      ),
                      EasyRichTextPattern(
                        targetString: EasyRegexPattern.emailPattern,
                        urlType: 'email',
                        style: TextStyle(
                          decoration: TextDecoration.underline,
                        ),
                      ),
                      EasyRichTextPattern(
                        targetString: EasyRegexPattern.webPattern,
                        urlType: 'web',
                        style: TextStyle(
                          decoration: TextDecoration.underline,
                        ),
                      ),
                      EasyRichTextPattern(
                        targetString: EasyRegexPattern.telPattern,
                        urlType: 'tel',
                        style: TextStyle(
                          decoration: TextDecoration.underline,
                        ),
                      ),
                    ],
                  ),

                  ///GestureRecognizer, not working when superscript, subscript, or urlType is set.
                  ///TapGestureRecognizer, MultiTapGestureRecognizer, etc.
                  EasyRichText(
                    "Tap recognizer to print this sentence.",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'recognizer',
                        recognizer: TapGestureRecognizer()
                          ..onTap = () {
                            print("Tap recognizer to print this sentence.");
                          },
                        style: TextStyle(
                          decoration: TextDecoration.underline,
                        ),
                      ),
                    ],
                  ),

                  //if the targetString contains the following special characters \[]()^*+?
                  EasyRichText(
                    "Received 88+ messages. Received 99+ messages ()",
                    patternList: [
                      //set hasSpecialCharacters to true
                      EasyRichTextPattern(
                        targetString: '99+',
                        hasSpecialCharacters: true,
                        style: TextStyle(color: Colors.blue),
                      ),
                      //or if you are familiar with regular expressions, then use \\ to skip it
                      EasyRichTextPattern(
                        targetString: '88\\+',
                        style: TextStyle(color: Colors.blue),
                      ),
                    ],
                  ),

                  ///WhatsApp like text formatter
                  EasyRichText(
                    "what are *you* doing *and* hi ~hey~. _italic_ ",
                    defaultStyle: TextStyle(color: Colors.white),
                    patternList: [
                      ///bold font
                      EasyRichTextPattern(
                        targetString: '(\\*)(.*?)(\\*)',
                        matchBuilder:
                            (BuildContext context, RegExpMatch match) {
                          // print(match[0]);
                          return TextSpan(
                            text: match[0].replaceAll('*', ''),
                            style: TextStyle(fontWeight: FontWeight.bold),
                          );
                        },
                      ),

                      ///italic font
                      EasyRichTextPattern(
                        targetString: '(\_)(.*?)(\_)',
                        matchBuilder:
                            (BuildContext context, RegExpMatch match) {
                          // print(match[0]);
                          return TextSpan(
                            text: match[0].replaceAll('_', ''),
                            style: TextStyle(fontStyle: FontStyle.italic),
                          );
                        },
                      ),

                      ///strikethrough
                      EasyRichTextPattern(
                        targetString: '(\~)(.*?)(\~)',
                        matchBuilder:
                            (BuildContext context, RegExpMatch match) {
                          // print(match[0]);
                          return TextSpan(
                            text: match[0].replaceAll('~', ''),
                            style: TextStyle(
                                decoration: TextDecoration.lineThrough),
                          );
                        },
                      ),
                    ],
                  ),

                  //know issue
                  EasyRichText(
                    "This is a EasyRichText example. I want whole sentence blue. I want whole sentence bold.",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'blue',
                        style: TextStyle(color: Colors.blue),
                      ),
                      EasyRichTextPattern(
                        targetString: 'I want whole sentence blue',
                        style: TextStyle(fontWeight: FontWeight.bold),
                      ),
                      EasyRichTextPattern(
                        targetString: 'I want whole sentence bold',
                        style: TextStyle(fontWeight: FontWeight.bold),
                      ),
                    ],
                  ),

                  //Chinese Character
                  EasyRichText(
                    "I want 世界你好 here. I want not 世界你好 font here.",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: '世界',
                        stringBeforeTarget: 'want ',
                        style: TextStyle(color: Colors.blue),
                      ),
                    ],
                  ),

                  //Arabic Character
                  EasyRichText(
                    "الحياة أكثر من مجرد الحاضر",
                    patternList: [
                      EasyRichTextPattern(
                        targetString: 'من',
                        style: TextStyle(color: Colors.blue),
                      )
                    ],
                    defaultStyle: TextStyle(color: Colors.red),
                  ),
                ],
              ),
            ),
          ),
        ),
      ),
    );
  }
}