Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fayeed/flutter_parsed_text
A Flutter package to parse text and make them into linkified text widget
https://github.com/fayeed/flutter_parsed_text
flutter hastags linkify-text mentionsedittext parsedtext
Last synced: 7 days ago
JSON representation
A Flutter package to parse text and make them into linkified text widget
- Host: GitHub
- URL: https://github.com/fayeed/flutter_parsed_text
- Owner: fayeed
- License: mit
- Created: 2019-06-22T09:02:55.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-11T16:32:40.000Z (about 1 year ago)
- Last Synced: 2024-08-01T19:37:51.316Z (3 months ago)
- Topics: flutter, hastags, linkify-text, mentionsedittext, parsedtext
- Language: Dart
- Homepage: https://pub.dev/packages/flutter_parsed_text
- Size: 110 KB
- Stars: 218
- Watchers: 3
- Forks: 68
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-list - flutter_parsed_text
README
🔗 Flutter Parsed text
A Flutter package to parse text and extract parts using predefined types like url, phone and email and also supports Regex.
## Usage 💻
To use this package, add `flutter_parsed_text` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
```dart
import 'package:flutter_parsed_text/flutter_parsed_text.dart';
```
## Working ⚙️
ParsedText can receive this paramters & all the RichText parameters:
`text`: Text that will be parsed and rendered.
`style`: It takes a `TextStyle` object as it's property to style all the non links text objects.
`parse`: Array of `MatchText` object - used for defining structure for pattern matching .
```dart
MatchText(
type: ParsedType.EMAIL, // predefined type can be any of this ParsedTypes
style: TextStyle(
color: Colors.red,
fontSize: 24,
), // custom style to be applied to this matched text
onTap: (url) {
// do something here with passed url
}, // callback funtion when the text is tapped on
),
```
>You can also define a custom pattern like this:
```dart
MatchText(
pattern: r"\B#+([\w]+)\b", // a custom pattern to match
style: TextStyle(
color: Colors.pink,
fontSize: 24,
), // custom style to be applied to this matched text
onTap: (url) async {
// do something here with passed url
}, // callback funtion when the text is tapped on
)
```
>You can also set RegexOption for the custom regex pattern like so:
```dart
MatchText(
pattern: r"\B#+([\w]+)\b", // a custom pattern to match
regexOptions: RegexOptions(
multiLine : false,
caseSensitive : false,
unicode : false,
dotAll : false
),
style: TextStyle(
color: Colors.pink,
fontSize: 24,
), // custom style to be applied to this matched text
onTap: (url) async {
// do something here with passed url
}, // callback funtion when the text is tapped on
)
```
A boolean that show a diffrent text and passes a diffrent text to the callback
eg: Your str is `"Mention [@michel:5455345]"` where `5455345` is ID of this user which will be passed as parameter to the callback funtion and `@michel` the value to display on interface. Your pattern for ID & username extraction : `/\[(@[^:]+):([^\]]+)\]/i`
>Displayed text will be : `Mention ^^@michel^^`
```dart
MatchText(
pattern: r"\[(@[^:]+):([^\]]+)\]",
style: TextStyle(
color: Colors.green,
fontSize: 24,
),
// you must return a map with two keys
// [display] - the text you want to show to the user
// [value] - the value underneath it
renderText: ({String str, String pattern}) {
Map map = Map();
RegExp customRegExp = RegExp(pattern);
Match match = customRegExp.firstMatch(str);
map['display'] = match.group(1);
map['value'] = match.group(2);
return map;
},
onTap: (url) {
// do something here with passed url
},
),
```
## Example ✍🏻
Find the complete example wiring in the [Flutter_Parsed_Text example application](https://github.com/fayeed/flutter_parsed_text/blob/master/example/lib/main.dart).
A small example of the ParsedText widget.
```dart
ParsedText(
text:
"[@michael:51515151] Hello this is an example of the ParsedText, links like http://www.google.com or http://www.facebook.com are clickable and phone number 444-555-6666 can call too. But you can also do more with this package, for example Bob will change style and David too. [email protected] And the magic number is 42! #react #react-native",
parse: [
MatchText(
type: ParsedType.EMAIL,
style: TextStyle(
color: Colors.red,
fontSize: 24,
),
onTap: (url) {
launch("mailto:" + url);
},
),
],
)
```
## Found this project useful? ❤️
If you found this project useful, then please consider giving it a ⭐️ on Github and sharing it with your friends via social media.
## API details 👨🏻💻
See the [flutter_parsed_text.dart](https://github.com/fayeed/flutter_parsed_text/blob/master/lib/flutter_parsed_text.dart) for more API details
## License ⚖️
- [MIT](https://github.com/fayeed/dash_chat/blob/master/LICENSE)
## Issues and feedback 💭
If you have any suggestion for including a feature or if something doesn't work, feel free to open a Github [issue](https://github.com/fayeed/flutter_parsed_text/issues) for us to have a discussion on it.