use-link-preview

use-link-preview is a React custom hook that simply provides link-preview metadata by link-preview-server.

Document

- Installation
- How to use
- API options
- Demo

Installation

bash

npm install use-link-preview





How to use



$3

bash

npm install use-link-preview

$3

jsx

import useLinkPreview from "use-link-preview";



function LinkPreview({ url }) {

  const { metadata, isLoading, isError } = useLinkPreview(url);



  // Usage example

  return (

    <>

      {isLoading && }

      {isError && }

      {metadata && (

        <>

          {metadata.title}

          {metadata.description}

          {metadata.domain}

          

          {metadata.requestUrl}

        

      )}

    

  );

}





API options

js

const { metadata, isLoading, isError } = useLinkPreview(url);





$3



-

url

: url string to get link-preview metadata



$3



-

metadata

: Received link-preview metadata (or null)

-

isLoading

: Check if metadata is being parsed. true or false

-

isError`: error thrown by parsing metadata (or null)

$3

- metadata

- title: string | null;
- description: string | null;
- img: string | null;
- domain: string;
- requestUrl: string;

- isLoading: boolean

- isError: Error | null

Demo

link-preview-server