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

embdr-client

v0.0.12

Published

A JavaScript Client to embed Embdr resources in a browser.

Downloads

7

Readme

# Embdr client

A JavaScript Client to embed Embdr resources in a browser.

## Installation

From npm

npm install embdr-client --save

From bower

bower install embdr

Manual

Embdr is a dependency-free project so you can simple copy embdr.js into your own project.

Usage

Basic example

Using Embdr is extremely simple. Simply include the embdr.js source, add a div where the previews should be embedded and pass along the id and embed key of the resource you wish to embed.

<script type="text/javascript" src="embdr.js"></script>

<div id="embed-preview"></div>

<script type="text/javascript">
  var resourceId = 103041;
  var resourceEmbedKey = '9ChJDmb8HH4rfn9GJB1yUO4CU2ejmNrs';
  embdr('embed-preview', resourceId, resourceEmbedKey);
</script>

Callbacks

You can specify a set of optional callbacks that allow you to react to the status of the resource. The following callbacks are currently supported:

  • pending - The resource is still being processed
  • complete - The resource has been fully processed
  • unsupported - The Embdr client can't embed the resource as it's either of an unknown type or processing failed

For example,


<div id="embed-preview" style="display: none;"></div>
<div id="embed-preview-pending" style="display: none;"></div>
<div id="embed-preview-unsupported" style="display: none;"></div>
var options = {
  'complete': function(resource) {
    showView('complete');
  },
  'pending': function() {
      showView('pending');
  },
  'unsupported': function() {
      showView('unsupported');
  }
};
embdr('embed-preview', resourceId, resourceEmbedKey, options);

function showView(view) {
  // Hide each view
  document.getElementById('embed-preview').style.display = 'none';
  document.getElementById('embed-preview-pending').style.display = 'none';
  document.getElementById('embed-preview-unsupported').style.display = 'none';

  // Show the correct view
  if (view === 'complete') {
      document.getElementById('embed-preview').style.display = 'none';
  } else if (view === 'pending') {
      document.getElementById('embed-preview-pending').style.display = 'none';
  } else if (view === 'unsupported') {
      document.getElementById('embed-preview-unsupported').style.display = 'none';
  }
};

Specify your own logo

When embedding a document and loading pages, Embdr pulsates the Embdr logo to indicate that data is being loaded. You can pass in your own logo or image in the options. Make sure that you include the full domain as the embdr HTML is loaded from a different domain.

var options = {
    'loadingIcon': '//' + window.location.host + '/assets/my-logo.png'
};
embdr('embed-preview', resourceId, resourceEmbedKey, options);