A Flutter package for beautifully displaying web URL previews with full customization options, perfect for enhancing chat applications. 🤓🤓
- Utilizes four distinct parsers (HTML, JSON LD, Open Graph, and Twitter Cards) to fetch metadata, with more enhancements planned.
- Offers extensive customization to seamlessly integrate with your app's design.
- Includes a placeholder widget for loading states and an error widget for handling errors, both fully customizable.
- Supports opting in or out of displaying media (images, icons, etc.) in the preview.
- Supports multiple display orientations (Horizontal and Vertical).
- Caches URL metadata for faster subsequent loads.
- Includes an example app to demonstrate usage.
- Open for suggestions and collaborations. Contact me here.
- If you find this package useful and it saves you development time, consider buying me a coffee.
- Contributions are welcome!
- Can be utilized both as a Widget and as a Method (function).
- Use
AnyLinkPreview.isValidLink()to validate URLs before usage.
- Fork the repository.
- Create your feature or fix branch (
git checkout -b my-new-feature). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Submit a Pull Request.
/// Display direction. Either [UIDirection.uiDirectionVertical] or
/// [UIDirection.uiDirectionHorizontal]. Defaults to vertical direction.
final UIDirection displayDirection;
/// Represents the mechanism used to open URLs via [launchUrl]. Defaults to
/// [LaunchMode.platformDefault]
final LaunchMode urlLaunchMode;
/// URL represented in string. For IOS & Web, only HTTP and HTTPS are
/// supported. For Android, all URLs are supported.
final String link;
/// Customize background color. Defaults to `Color.fromRGBO(235, 235, 235, 1)`
final Color? backgroundColor;
/// Placeholder widget that is shown while the metadata request is pending.
/// If not present, the default loading widget will be shown.
final Widget? placeholderWidget;
/// Error widget that will be shown in case of an error. Defaults to a plain
/// [Container] with a given [backgroundColor]. If the issue is known, i.e.
/// either a title or a description of the error is present, [errorTitle] and
/// [errorBody] are used instead, with fallback to their default values.
final Widget? errorWidget;
/// Error title message that will be shown in case of an error. Defaults to
/// "Something went wrong!".
final String? errorTitle;
/// Error body message that will be shown in case of an error. Defaults to
/// "Oops! Unable to parse the url. We have sent feedback to our developers &
/// we will try to fix this in our next release. Thanks!"
final String? errorBody;
/// Image that will be shown in case of an error when [showMultimedia] is set
/// to `true` and no metadata could be parsed. Defaults to
/// "A semi-soccer ball image that looks like crying".
final String? errorImage;
/// Sets the overflow type for body text (description) of the link.
/// Deaults to [TextOverflow.ellipsis].
final TextOverflow bodyTextOverflow;
/// Sets the limit to body text (description) of the link. Defaults to `3`.
final int bodyMaxLines;
/// TTL of metadata cache. Defaults to 1 day. Pass `null` to disable caching
/// and always make a request for latest metadata.
final Duration cache;
/// Customize body [TextStyle].
final TextStyle? titleStyle;
/// Customize body [TextStyle].
final TextStyle? bodyStyle;
/// Whether to show metadata image if it's present. Defaults to `true`.
final bool showMultimedia;
/// [BorderRadius] for the card. Deafults to `12`.
final double? borderRadius;
/// If set to true, removes card widget's elevation. Defaults to `false`.
final bool removeElevation;
/// Box shadow for the card. Deafults to
/// `[BoxShadow(blurRadius: 3, color: Colors.grey)]`.
final List<BoxShadow>? boxShadow;
/// Proxy URL that is used to resolve CORS issues on web.
/// For example, `https://cors-anywhere.herokuapp.com/` .
final String? proxyUrl;
/// Headers to be added in the HTTP request to the link
final Map<String, String>? headers;
/// Function that is called on card tap. If not provided, then [launchUrl]
/// will be used with the provided link. To disable calling [launchUrl] and
/// instead do nothing on tap, pass an empty function: `() {}`.
final VoidCallback? onTap;
/// Height of the preview card. Defaults to
/// `(MediaQuery.sizeOf(context).height) * 0.15` for the horizontal preview
/// and `(MediaQuery.sizeOf(context).height) * 0.25` for the vertical preview.
final double? previewHeight;
/// Builder function that is used only in [AnyLinkPreview.builder] and
/// allows building a custom [Widget] from the [Metadata], with either of
/// the optional [ImageProvider] or [SvgPicture] fetched.
final Widget Function(BuildContext, Metadata, ImageProvider?, SvgPicture?)?
itemBuilder;
Example of AnyLinkPreview widget:
AnyLinkPreview(
link: "https://vardaan.app/",
displayDirection: UIDirection.uiDirectionHorizontal,
showMultimedia: false,
bodyMaxLines: 5,
bodyTextOverflow: TextOverflow.ellipsis,
titleStyle: TextStyle(
color: Colors.black,
fontWeight: FontWeight.bold,
fontSize: 15,
),
bodyStyle: TextStyle(color: Colors.grey, fontSize: 12),
errorBody: 'Show my custom error body',
errorTitle: 'Show my custom error title',
errorWidget: Container(
color: Colors.grey[300],
child: Text('Oops!'),
),
errorImage: "https://google.com/",
cache: Duration(days: 7),
backgroundColor: Colors.grey[300],
borderRadius: 12,
removeElevation: false,
boxShadow: [BoxShadow(blurRadius: 3, color: Colors.grey)],
onTap: () {}, // This disables tap event
)Example of using AnyLinkPreview as a method/function:
// We will use this to build our own custom UI
Metadata? _metadata = await AnyLinkPreview.getMetadata(
link: "https://google.com/",
cache: const Duration(days: 7),
proxyUrl: "https://corsproxy.org/", // Need for web
);
print(_metadata?.title);Example of using AnyLinkPreview's validation method/function:
// Method to check if the url is valid or not before passing to the previewer
final bool _isUrlValid = AnyLinkPreview.isValidLink(
"https://google.com/",
protocols: ['http', 'https'],
hostWhitelist: ['https://youtube.com/'],
hostBlacklist: ['https://facebook.com/'],
);
print('_isUrlValid => $_isUrlValid');
Display Direction can be among these 2 types:
enum UIDirection { uiDirectionVertical, uiDirectionHorizontal }
Thanks to all the contributors
Copyright (c) 2020-2024 Konakanchi Venkata Suresh Babu
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
