Merge upstream

.gitignore

@@ -31,6 +31,7 @@
 .pub/
 /build/
 build/
+pubspec.lock
 
 # Web related
 lib/generated_plugin_registrant.dart

CHANGELOG.md

@@ -1,7 +1,43 @@
-## [1.0.1] 
-- Remove debug statements 
+## [3.1.0]
+
+Contributed by [@maRci002](https://github.com/maRci002) - see PR [#59](https://github.com/jonataslaw/readmore/pull/59).
+
+- Added `ReadMoreText.rich` constructor for rich text formatting and interactivity, enhancing text presentation with customizable styles and interactive elements.
+
+## [3.0.0]
+
+Contributed by [@maRci002](https://github.com/maRci002) - see PR [#54](https://github.com/jonataslaw/readmore/pull/54).
+
+**Breaking Changes**:
+
+- Upgraded to **Dart 3.0.0**
+- **`textScaleFactor`** replaced with **`textScaler`**
+- Removed **`callback`** in favor of the **`isCollapsed`** controller
+
+**Features**:
+
+- Introduced **`Annotation`** functionality for custom styling and interactions with text patterns like hashtags, URLs, and mentions, enhancing text interactivity and usability.
+
+- This version also has minor contributions from the following users: (@zeeshanhussain), (@sm2017), (@andreaselia), (@amereii), (@govindmaheshwari2),(@olisaemekaejiofor), (@epynic), (@webdastur), (@Siqlain-Hanif), (@unger1984),
+
+## [2.2.0]
+
+- Update to Flutter 3.
+
+## [2.1.0]
+
+- add RTL support
+
+## [2.0.0]
+
+- nullsafety
+
+## [1.0.1]
+
+- Remove debug statements
 - Add delimiter span && style for trimExpandedText & trimCollapsedText
 - Fix linkSize on ListView
 
-## [1.0.0] 
+## [1.0.0]
+
 - initial release

README.md

@@ -1,30 +1,100 @@
 # readmore
 
-A Flutter plugin than allow expand and collapse text.
+A Flutter plugin that allows for expanding and collapsing text with the added capability to style and interact with specific patterns in the text like hashtags, URLs, and mentions using the `Annotation` feature.
 
 ![](read-more-text-view-flutter.gif)
 
-## usage:
-add to your pubspec
+## Usage:
 
+Add the package to your pubspec.yaml:
+
+```yaml
+readmore: ^3.0.0
 ```
-readmore: ^1.0.0
-```
-and import:
-```
+
+Then, import it in your Dart code:
+
+```dart
 import 'package:readmore/readmore.dart';
 ```
 
+### Basic Example
+
 ```dart
 ReadMoreText(
   'Flutter is Google’s mobile UI open source framework to build high-quality native (super fast) interfaces for iOS and Android apps with the unified codebase.',
+  trimMode: TrimMode.Line,
   trimLines: 2,
   colorClickableText: Colors.pink,
-  trimMode: TrimMode.Line,
   trimCollapsedText: 'Show more',
   trimExpandedText: 'Show less',
   moreStyle: TextStyle(fontSize: 14, fontWeight: FontWeight.bold),
 );
 ```
 
+### Rich Text Example
+
+With the `ReadMoreText.rich` constructor, you can create text with rich formatting, including different colors, decorations, letter spacing, and interactive elements within a single widget.
+
+```dart
+ReadMoreText.rich(
+  TextSpan(
+    style: const TextStyle(color: Colors.black),
+    children: [
+      const TextSpan(text: 'Rich '),
+      const TextSpan(
+        text: 'Text',
+        style: TextStyle(
+          color: Colors.blue,
+          decoration: TextDecoration.underline,
+          letterSpacing: 5,
+          recognizer: TapGestureRecognizer()..onTap = () {
+            // Handle tap
+          },
+        ),
+      ),
+    ],
+  ),
+  trimMode: TrimMode.Line,
+  trimLines: 2,
+  colorClickableText: Colors.pink,
+  trimCollapsedText: '...Read more',
+  trimExpandedText: ' Less',
+);
+```
+
+### Using Annotations
+
+The `Annotation` feature enhances the interactivity and functionality of the text content. You can define custom styles and interactions for patterns like hashtags, URLs, and mentions.
+
+```dart
+ReadMoreText(
+  'This is a sample text with a #hashtag, a mention <@123>, and a URL: https://example.com.',
+  trimMode: TrimMode.Line,
+  trimLines: 2,
+  colorClickableText: Colors.pink,
+  annotations: [
+    Annotation(
+      regExp: RegExp(r'#([a-zA-Z0-9_]+)'),
+      spanBuilder: ({required String text, required TextStyle textStyle}) => TextSpan(
+        text: text,
+        style: textStyle.copyWith(color: Colors.blue),
+      ),
+    ),
+    Annotation(
+      regExp: RegExp(r'<@(\d+)>'),
+      spanBuilder: ({required String text, required TextStyle textStyle}) => TextSpan(
+        text: 'User123',
+        style: textStyle.copyWith(color: Colors.green),
+        recognizer: TapGestureRecognizer()..onTap = () {
+          // Handle tap, e.g., navigate to a user profile
+        },
+      ),
+    ),
+    // Additional annotations for URLs...
+  ],
+  moreStyle: TextStyle(fontSize: 14, fontWeight: FontWeight.bold),
+);
+```
 
+_Note: This feature is not available with the `ReadMoreText.rich` constructor, as `TextSpan` gives you total control over styling and adding interactions to parts of the text._

example/.gitignore

@@ -0,0 +1,47 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+pubspec.lock
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release

example/.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: f4abaa0735eba4dfd8f33f73363911d63931fe03
+  channel: stable
+
+project_type: app

example/README.md

@@ -0,0 +1,16 @@
+# example
+
+A new Flutter project.
+
+## Getting Started
+
+This project is a starting point for a Flutter application.
+
+A few resources to get you started if this is your first Flutter project:
+
+- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
+- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
+
+For help getting started with Flutter, view our
+[online documentation](https://flutter.dev/docs), which offers tutorials,
+samples, guidance on mobile development, and a full API reference.

example/android/.gitignore

@@ -0,0 +1,11 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties

example/android/app/build.gradle

@@ -0,0 +1,59 @@
+def localProperties = new Properties()
+def localPropertiesFile = rootProject.file('local.properties')
+if (localPropertiesFile.exists()) {
+    localPropertiesFile.withReader('UTF-8') { reader ->
+        localProperties.load(reader)
+    }
+}
+
+def flutterRoot = localProperties.getProperty('flutter.sdk')
+if (flutterRoot == null) {
+    throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
+}
+
+def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
+if (flutterVersionCode == null) {
+    flutterVersionCode = '1'
+}
+
+def flutterVersionName = localProperties.getProperty('flutter.versionName')
+if (flutterVersionName == null) {
+    flutterVersionName = '1.0'
+}
+
+apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android'
+apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
+
+android {
+    compileSdkVersion 31
+
+    sourceSets {
+        main.java.srcDirs += 'src/main/kotlin'
+    }
+
+    defaultConfig {
+        // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
+        applicationId "com.example.example"
+        minSdkVersion flutter.minSdkVersion
+        targetSdkVersion 30
+        versionCode flutterVersionCode.toInteger()
+        versionName flutterVersionName
+    }
+
+    buildTypes {
+        release {
+            // TODO: Add your own signing config for the release build.
+            // Signing with the debug keys for now, so `flutter run --release` works.
+            signingConfig signingConfigs.debug
+        }
+    }
+}
+
+flutter {
+    source '../..'
+}
+
+dependencies {
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+}

example/android/app/src/debug/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.example.example">
+    <!-- Flutter needs it to communicate with the running application
+         to allow setting breakpoints, to provide hot reload, etc.
+    -->
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>

example/android/app/src/main/AndroidManifest.xml

@@ -0,0 +1,41 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.example.example">
+   <application
+        android:label="example"
+        android:icon="@mipmap/ic_launcher">
+        <activity
+            android:name=".MainActivity"
+            android:launchMode="singleTop"
+            android:theme="@style/LaunchTheme"
+            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
+            android:hardwareAccelerated="true"
+            android:windowSoftInputMode="adjustResize">
+            <!-- Specifies an Android theme to apply to this Activity as soon as
+                 the Android process has started. This theme is visible to the user
+                 while the Flutter UI initializes. After that, this theme continues
+                 to determine the Window background behind the Flutter UI. -->
+            <meta-data
+              android:name="io.flutter.embedding.android.NormalTheme"
+              android:resource="@style/NormalTheme"
+              />
+            <!-- Displays an Android View that continues showing the launch screen
+                 Drawable until Flutter paints its first frame, then this splash
+                 screen fades out. A splash screen is useful to avoid any visual
+                 gap between the end of Android's launch screen and the painting of
+                 Flutter's first frame. -->
+            <meta-data
+              android:name="io.flutter.embedding.android.SplashScreenDrawable"
+              android:resource="@drawable/launch_background"
+              />
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN"/>
+                <category android:name="android.intent.category.LAUNCHER"/>
+            </intent-filter>
+        </activity>
+        <!-- Don't delete the meta-data below.
+             This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
+        <meta-data
+            android:name="flutterEmbedding"
+            android:value="2" />
+    </application>
+</manifest>

example/android/app/src/main/kotlin/com/example/example/MainActivity.kt

@@ -0,0 +1,6 @@
+package com.example.example
+
+import io.flutter.embedding.android.FlutterActivity
+
+class MainActivity: FlutterActivity() {
+}

example/android/app/src/main/res/drawable-v21/launch_background.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Modify this file to customize your launch splash screen -->
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
+    <item android:drawable="?android:colorBackground" />
+
+    <!-- You can insert your own image assets here -->
+    <!-- <item>
+        <bitmap
+            android:gravity="center"
+            android:src="@mipmap/launch_image" />
+    </item> -->
+</layer-list>

example/android/app/src/main/res/drawable/launch_background.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Modify this file to customize your launch splash screen -->
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
+    <item android:drawable="@android:color/white" />
+
+    <!-- You can insert your own image assets here -->
+    <!-- <item>
+        <bitmap
+            android:gravity="center"
+            android:src="@mipmap/launch_image" />
+    </item> -->
+</layer-list>