diff --git a/CHANGELOG.md b/CHANGELOG.md index c795952..e98dc56 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## 1.0.4 + +- updated documentation ## 1.0.3 - fix gif display on pub.dev diff --git a/README.md b/README.md index 0654013..ba4d6b5 100644 --- a/README.md +++ b/README.md @@ -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` | 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 diff --git a/example/pubspec.lock b/example/pubspec.lock index 075c4e4..64825df 100644 --- a/example/pubspec.lock +++ b/example/pubspec.lock @@ -115,7 +115,7 @@ packages: path: ".." relative: true source: path - version: "1.0.3" + version: "1.0.4" matcher: dependency: transitive description: diff --git a/pubspec.yaml b/pubspec.yaml index f243f2c..3d9adfd 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -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: