77 lines
2.5 KiB
Markdown
77 lines
2.5 KiB
Markdown
# linkfy_text
|
|
|
|
A lightweight flutter package that linkifies a text containing urls, emails and hashtag like twitter does.
|
|
|
|
[](https://pub.dev/packages/linkfy_text)
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
To use this package, add `linkfy_text` as a [dependency in your pubspec.yaml file](https://pub.dev/packages/linkfy_text/).
|
|
|
|
Example:
|
|
|
|
```dart
|
|
// first import the package
|
|
import 'package:linkfy_text/linkify_text.dart';
|
|
|
|
Container(
|
|
child: LinkifyText(
|
|
"This text contains a url: https://flutter.dev",
|
|
linkStyle: TextStyle(color: Colors.blue, fontSize: 16),
|
|
onTap: (link) {
|
|
/// do stuff with `link`
|
|
},
|
|
);
|
|
)
|
|
```
|
|
|
|
Be default, The above snippet would linkify all urls in the string, you can choose what type of link to linkify by passing the `linkTypes` parameter
|
|
|
|
```dart
|
|
Container(
|
|
child: LinkifyText(
|
|
"This text contains a url: https://flutter.dev and #flutter",
|
|
linkStyle: TextStyle(color: Colors.blue, fontSize: 16),
|
|
linkTypes: [LinkType.url, LinkType.hashtag]
|
|
onTap: (link) {
|
|
/// do stuff with `link` like
|
|
/// if(link.type == Linktype.url) launchUrl(link.value);
|
|
},
|
|
);
|
|
)
|
|
```
|
|
|
|
|
|
## API Reference
|
|
|
|
#### LinkfyText
|
|
|
|
| Parameter | Type | Description |
|
|
| :-------- | :------- | :-------------------------------- |
|
|
| `textStyle` | `TextStyle` | style applied to the text |
|
|
| `linkStyle` | `TextStyle` | style applied to the linkified text. **defaults** to `textStyle` |
|
|
| `linkTypes` | `List<LinkType>` | a list of `LinkType` used to override the links to be linkified in a text either a url, hashtag or email. **defaults** to `[LinkType.url]`|
|
|
| `onTap` | `Function(Link)` | function called when a link is pressed |
|
|
|
|
|
|
#### Link
|
|
|
|
| Parameter | Type | Description |
|
|
| :-------- | :------- | :-------------------------------- |
|
|
| `type` | `LinkType` | the link type either url, email or hashtag |
|
|
| `value` | `String` | value this link holds |
|
|
|
|
# Contributions
|
|
|
|
Feel free to contribute to this project.
|
|
|
|
If you find a bug or want a feature, but don't know how to fix/implement it, please fill an [issue](https://github.com/Iamstanlee/linkfy_text/issues).
|
|
If you fixed a bug or implemented a feature, please send a [pull request](https://github.com/Iamstanlee/linkfy_text/pulls).
|
|
|
|
# TODO
|
|
|
|
- linkify "@" mention and "$" sign
|
|
- LinkifyTextField widget
|