A cross-platform flutter package to convert your links into rich beautiful previews.

Last update: Oct 21, 2022

Overview

Link Preview Generator

A cross-platform flutter package to convert your links into rich beautiful previews.
This package is inspired from 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

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

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)	`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

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Contributors

License

MIT

A beautiful cross platform mobile web app use this and ENJOY (2 page) - Flutter UI from scratch

course_app A new Flutter project. Getting Started This project is a starting point for a Flutter application. A few resources to get you started if th

Feb 9, 2022

A JSON serialize class to convert 'to' and 'from' JSON format Enums, DateTime and any of your own classes.

A JSON serialize class to convert 'to' and 'from' JSON format Enums, DateTime and any of your own classes. Introduction Jsonize solves the problem of

Nov 17, 2022

A simple dart package to convert large numbers to a human readable format. 1278 to 1.2K instead, for example.

A simple dart package to convert large numbers to a human readable format. 1278 to 1.2K instead, for example. Features Represents large numbers in ter

Oct 8, 2022

A flutter plugin to get facebook deep links and log app events using the latest Facebook SDK to include support for iOS 14

Facebook Sdk For Flutter LinkedIn GitHub facebook_sdk_flutter allows you to fetch deep links, deferred deep links and log facebook app events. This wa

Dec 17, 2022

Flutter plugin which helps you to find links in String using NSDataDetector and Linkify

Flutter's Native Linkify native_linkify is a Flutter plugin. Use it to find links in plain-text. The plugin uses NSDataDetector for iOS and macOS; Lin

Nov 29, 2022

a small app with a collection to WhatsApp group links

linki A community based app for links to social media groups. Intro Linki is a simple app that shows an interactive list of links to social media grou

Sep 19, 2021

A cross-platform Flutter home workout app that respects your privacy. THIS IS A GITLAB MIRROR, file issues and contribute there.

Feeel Feeel is an open-source workout app for doing simple at-home exercises. This is a rewrite of the original app in Flutter, to make development ea

Dec 26, 2022

Portarius is a free, open-source, cross-platform mobile application that allows you to manage your Portainer sessions.

Portarius [Latin: Porta/Door Arius/Keeper] Features User management See running/stopped containers (and also start/stop and restart them) See containe

Jan 7, 2023

A rich, convenient, easy-to-use flutter page transition package

flutter_page_transition A rich, convenient, easy-to-use flutter page transition package. README in Chinese Some Demos Getting Started Add this to your

Sep 27, 2022

Comments

LinkPreviewGenerator not updating inside of a ListView

I have a list view of LinkPreviewGenerators but when I call setState and update the data that the list view is reading from the LinkPreviewGenerators don't refresh. I have confirmed that refreshing works with just Text widgets

opened by nico671 1

Warning: Operand of null-aware operation

this work well. but, warnings appear like this.

: Warning: Operand of null-aware operation '!' has type 'int' which excludes null.
..…rulesdefault.scrapper.dart:128
          if (img.naturalWidth! > img.naturalHeight!) {

                  ^
: Warning: Operand of null-aware operation '!' has type 'int' which excludes null.
../…/rules/default.scrapper.dart:128
          if (img.naturalWidth! > img.naturalHeight!) {
                                      ^
: Warning: Operand of null-aware operation '!' has type 'int' which excludes null.
../…/rules/default.scrapper.dart:130
            if (img.naturalWidth! / img.naturalHeight! > 3) {

                    ^
: Warning: Operand of null-aware operation '!' has type 'int' which excludes null.
../…/rules/default.scrapper.dart:130

            if (img.naturalWidth! / img.naturalHeight! > 3) {
                                        ^
: Warning: Operand of null-aware operation '!' has type 'int' which excludes null.
../…/rules/default.scrapper.dart:135
            if (img.naturalHeight! / img.naturalWidth! > 3) {
                    ^

opened by masahiro-kato 0

[ImgBot] Optimize images

Beep boop. Your images are optimized!

Your image file size has been reduced 🎉

Details

| File | Before | After | Percent reduction | |:--|:--|:--|:--| | /assets/demo-2.png | 874.34kb | 858.21kb | 1.85% | | /assets/demo-1.png | 859.12kb | 845.18kb | 1.62% | | | | | | | Total : | 1,733.46kb | 1,703.39kb | 1.73% |

📝 docs | :octocat: repo | 🙋🏾 issues | 🏪 marketplace

~Imgbot - Part of Optimole family

opened by imgbot[bot] 0

Releases(v1.2.0)

v1.2.0(Oct 18, 2021)
Bump minimum Flutter version.

Source code(tar.gz)
Source code(zip)
v1.1.0(Sep 9, 2021)
Added more customization properties - graphicFit, onTap, showBody, showDomain, showTitle.

Update UI of LinkPreviewStyle.large (LinkPreviewLarge).

Auto calculate bodyMaxLines based on screen height.

Update dependencies.

Source code(tar.gz)
Source code(zip)
v1.0.1(Jul 16, 2021)
Update documentation.

Source code(tar.gz)
Source code(zip)
v1.0.0(Jul 15, 2021)
Initial release.

Source code(tar.gz)
Source code(zip)