this is auto generated from API :)
Go to file
minhtritc97 cb709ec7cd fix: update url regex 2025-10-06 14:48:40 -07:00
.github/workflows Update flutter to v3.19.3 and overrall improvements (#15) 2024-04-02 07:56:20 +01:00
example Update flutter to v3.19.3 and overrall improvements (#15) 2024-04-02 07:56:20 +01:00
lib fix: update url regex 2025-10-06 14:48:40 -07:00
screenshots Update flutter to v3.19.3 and overrall improvements (#15) 2024-04-02 07:56:20 +01:00
test Update flutter to v3.19.3 and overrall improvements (#15) 2024-04-02 07:56:20 +01:00
.gitignore initial commit 2021-06-03 13:00:21 -07:00
.metadata initial commit 2021-06-03 13:00:21 -07:00
CHANGELOG.md docs: updates CHANGELOG 2021-09-02 20:14:59 -07:00
LICENSE initial commit 2021-06-03 13:00:21 -07:00
README.md Update flutter to v3.19.3 and overrall improvements (#15) 2024-04-02 07:56:20 +01:00
analysis_options.yaml Update flutter to v3.19.3 and overrall improvements (#15) 2024-04-02 07:56:20 +01:00
pubspec.lock Update flutter to v3.19.3 and overrall improvements (#15) 2024-04-02 07:56:20 +01:00
pubspec.yaml Bump version 2024-04-02 08:14:59 +01:00

README.md

linkfy_text

Lightweight flutter package that detects linkable patterns(urls, emails, hashtags, etc) in a text and makes them clickable. It also allows you to customize the style of the linkified text and the link itself. It also allows you to choose what type of link to linkify in a text.¬

pub package CI coverage Status

Usage

To use this package, add linkfy_text as a dependency in your pubspec.yaml file.

Example:

// 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),
    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

Container(
    child: LinkifyText(
    "This text contains a url: https://flutter.dev and #flutter",
    linkStyle: TextStyle(color: Colors.blue),
    LinkTypes: [LinkType.url, LinkType.hashtag]
    onTap: (link) {
        /// do stuff with `link` like
        /// if(link.type == Link.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 [LinkTypes.url]
onTap Function(Link) function called when a link is pressed

LinkType

Parameter Type Description
type Link the link type either url, email or hashtag, @mention
value String value the 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.
If you fixed a bug or implemented a feature, please send a pull request.

TODO

  • LinkifyTextField widget