https://github.com/ghpranav/link_preview_generator
A cross-platform flutter package to convert your links into rich beautiful previews.
https://github.com/ghpranav/link_preview_generator
cards dart flutter flutter-package link link-preview link-scrapper parser preview scrapper
Last synced: 3 months ago
JSON representation
A cross-platform flutter package to convert your links into rich beautiful previews.
- Host: GitHub
- URL: https://github.com/ghpranav/link_preview_generator
- Owner: ghpranav
- License: mit
- Created: 2021-07-08T05:47:46.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-18T02:37:16.000Z (over 1 year ago)
- Last Synced: 2025-06-09T15:09:28.746Z (4 months ago)
- Topics: cards, dart, flutter, flutter-package, link, link-preview, link-scrapper, parser, preview, scrapper
- Language: Dart
- Homepage: https://pub.dev/packages/link_preview_generator
- Size: 6.05 MB
- Stars: 22
- Watchers: 1
- Forks: 35
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Link Preview Generator
[](https://pub.dev/packages/link_preview_generator)
[](https://github.com/ghpranav/link_preview_generator/actions?query=workflow%3Abuild)
[](https://www.codefactor.io/repository/github/ghpranav/link_preview_generator)
[](https://opensource.org/licenses/MIT)
[](https://upayi.ml/bedrepranav@okhdfcbank)
A cross-platform flutter package to convert your links into rich beautiful previews.
This package is inspired from [Any Link Preview](https://pub.dartlang.org/packages/any_link_preview) package, but the entire parsing & scrapping logic has been re-written to be more robust & to support more links. It also provides control over complete customization of the widget.
## Usage
### Widget Example
```dart
import 'package:link_preview_generator/link_preview_generator.dart';
/// Generate a beautiful link preview card widget
LinkPreviewGenerator(
bodyMaxLines: 3,
link: 'https://github.com/ghpranav/link_preview_generator',
linkPreviewStyle: LinkPreviewStyle.large,
showGraphic: true,
)
```
### Function Example
```dart
import 'package:link_preview_generator/link_preview_generator.dart';
/// Pass the URL to be parsed/scraped
/// to build your own custom widget with parsed data
final WebInfo info = await LinkPreview.scrapeFromURL('https://github.com/ghpranav/link_preview_generator');
/// Description of the page.
final String description = info.description;
/// Domain name of the link.
final String domain = info.domain;
/// Favicon of the page.
final String icon = info.icon;
/// Image URL, if present any in the link.
final String image = info.image;
/// Title of the page.
final String title = info.title;
/// Link preview type of the rule used for scrapping the link.
/// Returns [LinkPreviewType.error] if the scrapping is failed.
final LinkPreviewType type = info.type;
/// Video URL, if present any in the link.
final String video = info.video;
```
## Props & Methods
### LinkPreviewGenerator
| PropName | Description | PropType | value | required |
| --------------------- | ----------------------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -------- |
| **link** | URL to display as preview | String | | `true` |
| **backgroundColor** | Customize the background colour of widget | Color | default(`Color.fromRGBO(248, 248, 248, 1.0)`) | `false` |
| **bodyMaxLines** | Maximum number of description body lines | int | default(`auto`) | `false` |
| **bodyStyle** | Customize the description body style | TextStyle | N.A | `false` |
| **bodyTextOverflow** | Overflow type for description body text | TextOverflow | default(`TextOverflow.ellipsis`) | `false` |
| **borderRadius** | Border radius for the widget card | double | default(`12.0`) | `false` |
| **boxShadow** | Box shadow for the widget card | List<`BoxShadow`> | | `false` |
| **cacheDuration** | Cache the parsed result for a certain duration | Duration | default(`Duration(days: 7)`) | `false` |
| **errorBody** | Body that need to be shown if parsing fails | String | default(`Oops! Unable to parse the url.`) | `false` |
| **errorImage** | Image URL that will be shown if parsing fails | String | default([A crying semi-soccer ball image](https://raw.githubusercontent.com/ghpranav/link_preview_generator/main/assets/giphy.gif)) | `false` |
| **errorTitle** | Title that need to be shown if parsing fails | String | default(`Something went wrong!`) | `false` |
| **errorWidget** | Widget shown if parsing fails. Defaults to plain container | Widget | | `false` |
| **graphicFit** | Adjust the box fit of the image | BoxFit | default(`BoxFit.cover`) | `false` |
| **linkPreviewStyle** | Link Preview card display style | LinkPreviewStyle | default(`large`) `small`,`large` | `false` |
| **onTap** | Function that needs to be called when user taps on the card | Function() | default(`launchURL(link)`) | `false` |
| **placeholderWidget** | Widget shown when parsing the link | Widget | | `false` |
| **proxyUrl** | Proxy URL to pass that resolve CORS issues on web | String | example(`https://cors-anywhere.herokuapp.com/`) | `false` |
| **removeElevation** | To remove the widget card elevation | bool | default(`false`) `true`,`false` | `false` |
| **showBody** | Show or Hide body text (Description) | bool | default(`true`) `true`,`false` | `false` |
| **showDomain** | Show or Hide domain name | bool | default(`true`) `true`,`false` | `false` |
| **showGraphic** | Show or Hide the image after parsing, if available | bool | default(`true`) `true`,`false` | `false` |
| **showTitle** | Show or Hide title | bool | default(`true`) `true`,`false` | `false` |
| **titleStyle** | Customize the title style | TextStyle | N.A | `false` |
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Contributors
## License
[MIT](LICENSE)