npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tb-link-preview

v1.0.3

Published

Preview link (meta) info on hover

Downloads

8

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

bikramlamabikramlama

Keywords

linkhoverurlpreviewmetascreenshotcard

Readme

Hover Link Preview

Overview

tb-link-preview is a JavaScript package that provides a simple and customizable link preview functionality. It fetches metadata for a given URL and displays a preview when a link is hovered over.

Installation

Install the package using npm:

npm install tb-link-preview

Usage

Import the package in your JavaScript file:

import { linkPreview } from "tb-link-preview";

// Initialize link preview with default options
linkPreview();

You can also customize the behavior by providing options:

linkPreview({
    cacheTtl: 60 * 60, // Cache time-to-live in seconds
    selector: "data-custom-preview", // Custom attribute for links
    defaultClass: "__lp-preview", // Custom class for rendered section
    rootClass: "", // Classes to apply to root div
    containerClass: "", // Classes to apply to container div
    imageClass: "", // Classes to apply to image div
    contentClass: "", // Classes to apply to content div (div containing title and description)
    titleClass: "", // Classes to apply to title
    descriptionClass: "", // Classes to apply to description
    zIndex: 100, // Custom z-index value for rendered section
    transitionInDelay: 50, // Min:1, delay the opacity-1 transition for animation (time in ms)
    transitionOutDelay: 350, // Min:1, delay the opacity-0 transition for animation (time in ms)
    debug: false, // Keep the rendered section visible at all time
});

Debugging

You can enable debugging where the rendered section stays visible until the page is refreshed. It is useful when trying to add classes to the section. Please note, the debug mode can introduce unwanted behaviors, and should only be used when testing. To enable debugging, you can pass in the debug parameter while initializing.

linkPreview({
    debug: false, // Keep the rendered section visible at all time
});

Dependencies

  • axios: Promise-based HTTP client.
  • cheerio: jQuery-like library for parsing HTML.

Example

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
        <title>Link Preview Example</title>
    </head>
    <body>
        <a href="https://example.com" data-tb-link-preview
            >Hover me for a preview</a
        >

        <script type="module">
            import { linkPreview } from "tb-link-preview";

            linkPreview();
        </script>
    </body>
</html>

Contributing

Contributions are welcome! Please follow our contribution guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.