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

link-summoner

v1.3.1

Published

![npm](https://img.shields.io/npm/v/link-summoner?style=flat-square)

Downloads

15

Readme

Link Summoner

npm

A script that you can embed in your website to easily enable live link previews for a whitelisted set of websites.

Usage

Script tag

The simplest option is to add the following tag to your page (update the version number if necessary):

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/browser.js" type="module"></script>

Using as a library (via NPM)

See example usage in examples/bundling

  1. npm install link-summoner
  2. In the files/pages you want to have live link previews:
import {initPreviews} from "link-summoner"

initPreviews()

Customization

See an extensive customization example in Transclude Me extension which is using this library as a foundation.

Styling

Links that can be previewed get the link-with-preview CSS class. You can specify styling for that class to indicate presence of the preview. For example, the following snippet would add τ after each link with preview:

.link-with-preview::after {
	text-decoration: none;
	content: 'τ';
	margin-left: 0.2em;
	color: #4f5c68;
}

Whitelisting more websites/adding custom preview types

initPreviews function accepts a configuration object with the following properties:

  • linkPreviewClass: string — CSS class that will be added to links that have the preview.
    • Default: link-with-preview
  • renderers: LinkRenderer[] - a list of renderers for live previews.
    • Default: defaultRenderers
    • Each renderer must define
      • canRender(url: URL): Promise<boolean> and
      • render(url: URL): Promise<HTMLElement> methods.
    • There is also a set of pre-defined renderers you can reuse.
  • tippyOptions - options for the tippy.js library which is used to show popups.

Example: add an iframe preview for example.com, while keeping all the default preview options:

import {initPreviews, defaultRenderers, iframeRenderer} from "link-summoner"

initPreviews({
  renderers: [
      iframeRenderer(/example\.com/),
      ...defaultRenderers, 
  ]
})

Supported websites

For the list of supported websites see files in src/rendering

Usage in the wild: