@dhaiwat10/react-link-preview

React Link Preview

A React component that renders beautiful, fully-customizable link previews.

Demo

How to use

Install the package:

yarn add @dhaiwat10/react-link-preview

npm install @dhaiwat10/react-link-preview

Import and render the preview:

import { LinkPreview } from '@dhaiwat10/react-link-preview';

const Home = () => {
  return <LinkPreview url='https://www.youtube.com/watch?v=dQw4w9WgXcQ' width='400px' />;
};

If the component renders nothing, it means that no metadata could be scraped for the URL. Provide a fallback component if you don't want to render null.

Important

This package uses a Heroku proxy to get around CORS issues. Feel free to go through the source code of the proxy here.

I highly recommend forking both this repo and the proxy repo, and deploying your own copy of the project if you plan to use this package in a production app.

API (Available props)

You can pass the following props to the LinkPreview component.

url (string)

The URL for which you want to generate the link preview.

---

fallback (JSX.Element / any valid JSX)

A fallback component which will be rendered if a link preview could not be generated.

---

showLoader (boolean)

Whether you want to display the default loading skeleton or not.

---

customLoader (JSX.Element / any valid JSX)

Custom loader that will be displayed in place of the default loader.

---

backgroundColor (string)

Background color of the card.

---

primaryTextColor (string)

Color of the primary text (title).

---

secondaryTextColor (string)

Color of the secondary text (description, URL, domain name).

---

borderColor (string)

Color of the border of the card.

---

className (string)

Any custom CSS class that you want to apply to the card.

---

width (string or number)

Width of the card.

---

height (string or number)

Height of the card.

---

margin (string or number)

Margin around the card.

---

descriptionLength (number)

Length of the description in the card. (number of characters)

---

borderRadius (string or number)

Border radius of the card.

---

imageHeight (string or number)

Height of the image.

---

textAlign ( left, right or center)

Alignment of the text.

---

Props marked with ? are optional.

Changelog

1.7.2 (2021-06-02)

Performance Improvements

• improve perf, add tests (3ec4236)