Add custom styling and interactions for mentions, hashtags, and URLs

[maRci002]

closes #53

closes #42

https://github.com/jonataslaw/readmore/assets/8436039/f821568d-69ee-4ad3-a074-b5607b4ca463

https://github.com/jonataslaw/readmore/assets/8436039/3c7fc530-e550-4636-8de7-367cfe6ba9bd

Summary

This pull request introduces the ability to apply custom styling and define tap actions for special text elements such as mentions, hashtags, and URLs within the ReadMoreText widget. By leveraging a flexible annotation system, developers can now enhance the interactivity and visual appeal of text content, providing a richer user experience.

Features

• Custom Styling and Tap Actions: Developers can specify custom styles and tap actions for different types of text patterns. This is achieved through a new annotations parameter in ReadMoreText, which accepts a list of Annotation objects. Each Annotation object contains a regular expression to match specific text patterns and a builder function to customize the resulting TextSpan.
• Enhanced User Interaction: This feature enables interactive text elements within the ReadMoreText widget, allowing users to tap on mentions, hashtags, and URLs to perform actions like navigating to a user profile or displaying related content.
• Flexible Text Transformations: The system supports transforming matched text patterns into more readable forms (e.g., converting <@userId> to a user's name) while retaining custom styles and interactions.
• Note: this PR also includes the ability to control isCollapsed programmatically.

Implementation Details

• Introduced a new Annotation class to represent each customizable text pattern. This class includes a RegExp for pattern matching and a TextSpan Function for styling and interaction definition.
• Extended the ReadMoreText widget to accept an optional annotations parameter, enabling the application of the defined Annotation objects to the widget's text content.
• Implemented logic in ReadMoreTextState to apply the specified annotations to the text, transforming matches based on the provided RegExp and builder function within each Annotation.

Example Usage

ReadMoreText(
  'This is a sample text with a #hashtag, a mention <@123>, and a URL: https://example.com.',
  annotations: [
    Annotation(
      regExp: RegExp(r'<@(\d+)>'),
      spanBuilder: ({required String text, TextStyle? textStyle}) => TextSpan(
        text: 'User123',
        style: textStyle?.copyWith(color: Colors.blue),
        recognizer: TapGestureRecognizer()..onTap = () { /* Navigate to user profile */ },
      ),
    ),
    // Additional annotations for hashtags and URLs...
  ],
)

[jonataslaw]

It is awesome!!! Thank you for your contribution!

[maRci002]

Should I update the changelog?

There are some breaking changes:

• Flutter 2.0 -> 3.0 (textScaleFactor has been replaced with textScaler)
• Removed: callback has been replaced by the isCollapsed controller
• Removed (but never released): onLinkPressed and linkTextStyle

[jonataslaw]

That would be amazing! I will upload the new version to pub.dev today Thanks for your effort

[maRci002]

I think there aren't any breaking changes:

• textScaleFactor can still be used but is marked with @Deprecated.
• callback can still be called but is also marked as deprecated.

Soon I will update PR

[jonataslaw]

LGTM

[maRci002]

I am going to push one more commit to update the README, Changelog, and the flagship video. The code is ok which was merged.