https://github.com/interdev7/flutter_text_sniffer
https://github.com/interdev7/flutter_text_sniffer
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/interdev7/flutter_text_sniffer
- Owner: interdev7
- License: bsd-3-clause
- Created: 2024-10-10T18:54:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-11T19:47:02.000Z (over 1 year ago)
- Last Synced: 2024-12-11T20:32:46.734Z (over 1 year ago)
- Language: Dart
- Size: 136 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TextSniffer
`TextSniffer` is a powerful Flutter widget designed to detect and interact with specific text patterns. It allows developers to define custom patterns using regular expressions, apply unique styles to detected text, and handle user interactions such as taps on links or specific words.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Custom Builder](#custom-builder)
- [Defining Custom sniffers](#defining-custom-patterns)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Customizable Patterns**: Use regular expressions to define text patterns.
- **Interactive Text**: Make text segments interactive, responding to user taps.
- **Styling Options**: Apply styles to both matching and non-matching text.
- **Custom Match Builders**: Define how detected patterns appear.
- **Multiple Search Sniffers**: Supports for emails and links by default but you can create own Sniffers.
- **Individual Styling**: Style different types of matches individually.
## Installation
To use `TextSniffer`, add the following to your `pubspec.yaml`:
```dart
dependencies:
flutter_text_sniffer: ^latest_version
```
Then, run `flutter pub get` to install the package.
## Usage
### Basic Example
Here’s a simple example of how to use the `TextSniffer` widget:
```dart
TextSniffer(
text: "Contact us at support@example.com or visit https://example.com/product?name=iPhone",
snifferTypes: [
// They are built in sniffers
EmailSnifferType(),
LinkSnifferType(),
],
onTapMatch: (match, matchText, type, index, error) {
if (error == null) {
print('Tapped on: $matchText');
}
},
)
```
## Custom Builder
To customize how matched text is displayed, use the `matchBuilder` property:
```dart
final images = [
"assets/flutter.png",
"assets/google.png",
];
class CustomSnifferType extends SnifferType {
@override
RegExp get pattern => RegExp(r'\[(.*?)\]');
@override
TextStyle? get style => const TextStyle(color: Colors.indigoAccent, fontWeight: FontWeight.bold);
@override
String toString() => 'custom';
}
TextSniffer(
text: "Check out [Flutter] and [Google]!",
matchEntries: const ['https://flutter.dev', 'https://google.com'],
snifferTypes: [
CustomSnifferType(),
],
onTapMatch: (entry, match, type, index, error) {
if (error == null) {
showSnackBar(context, entry ?? "Not found");
}
},
matchBuilder: (match, index, type, entry) {
return Container(
padding: const EdgeInsets.only(left: 4.0, right: 4.0),
child: Row(
mainAxisSize: MainAxisSize.min,
children: [
Image.asset(
images[index],
width: 20,
height: 20,
),
Text(
match,
style: type.style,
),
],
),
);
},
)
```
## Defining Custom Patterns
You can define custom patterns using regular expressions. For example, to detect IP addresses, hashtag and custom:
```dart
// Custom sniffer. For example: [Example] => word in brackets => Example
class CustomSnifferType extends SnifferType {
@override
RegExp get pattern => RegExp(r'\[(.*?)\]');
@override
TextStyle? get style => const TextStyle(color: Colors.indigoAccent, fontWeight: FontWeight.bold);
@override
String toString() => 'custom';
}
// IP address sniffer
class IpAddressSnifferType extends SnifferType {
@override
RegExp get pattern => RegExp(r'\b' // Start of word (word borders)
r'(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)' // 1 octet
r'\.' // Dot
r'(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)' // 2 octet
r'\.' // Dot
r'(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)' // 3 octet
r'\.' // Dot
r'(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)' // 4 octet
r'\b' // End of word
);
@override
TextStyle? get style => const TextStyle(color: Colors.orange, fontStyle: FontStyle.italic);
@override
String toString() => 'ip_address';
}
// Hashtag sniffer
class HashtagSnifferType extends SnifferType {
@override
RegExp get pattern => RegExp(r'\B#\w\w+');
@override
TextStyle? get style => const TextStyle(color: Colors.purple, fontWeight: FontWeight.bold);
@override
String toString() => 'hashtag';
}
TextSniffer(
text: "Check out [Flutter] and [Google]!\nCheck out #Flutter and #Google! IP addresses: 192.168.0.1, 192.168.0.124",
snifferTypes: [
CustomSnifferType(),
HashtagSnifferType(),
IpAddressSnifferType(),
],
matchEntries: const [
'https://flutter.dev',
'https://google.com',
],
onTapMatch: (entry, matchText, type, index, error) {
if (error == null) {
print('Tapped on: $matchText');
}
},
)
```
## Contributing
We welcome contributions! To contribute to `TextSniffer`, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/AmazingFeature`).
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
4. Push to the branch (`git push origin feature/AmazingFeature`).
5. Open a Pull Request.
## License
This project is licensed under the BSD-3-Clause License. See the [LICENSE](LICENSE) file for more details.