j3g
/
lum_linkify_text
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: updated

This commit is contained in:
iamstanlee 2021-06-25 22:36:48 -07:00
parent e087e774e5
commit 7e54777385
4 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -1,3 +1,6 @@
## 1.0.4
- updated documentation
## 1.0.3
- fix gif display on pub.dev

25
README.md
View File

@ -43,12 +43,25 @@ Container(
)
```
| Parameters | Default | Description |
| ----------- | -------------- | ------------------------------------------------------------------------------------------------------------ |
| `textStyle` | `null` | Style applied to the text |
| `linkStyle` | `null` | Style applied to the linkified text, defaults to the textStyle |
| `linkTypes` | `LinkType.url` | A list of `LinkTypes` used to override the links to be linkified in the text either a hashtag, email or url. |
| `onTap` | `null` | Callback function with a `Link` paramater called when a link is pressed |
## 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

2
example/pubspec.lock
View File

@ -115,7 +115,7 @@ packages:
path: ".."
relative: true
source: path
version: "1.0.3"
version: "1.0.4"
matcher:
dependency: transitive
description:

4
pubspec.yaml
View File

@ -1,6 +1,6 @@
name: linkfy_text
description: A lightweight flutter package to linkify texts containing urls, emails and hashtags.
version: 1.0.3
description: A lightweight flutter package to linkify texts containing urls, emails and hashtags like twitter does.
version: 1.0.4
homepage: https://github.com/Iamstanlee/linkfy_text
environment: