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

@squarespace/mercury

v1.1.6

Published

Simple, site-wide ajax loading

Downloads

11

Readme

Squarespace Mercury

A configurable, asynchronous, plug-and-play loader for your website. Intercepts clicks on <a> elements and performs an XHR to that href, and updates the DOM according to a config object you pass in.

NOTICE: This code is licensed to you pursuant to Squarespace’s Developer Terms of Use. See license section below.

Usage

npm install --save @squarespace/mercury;
const Mercury = require('@squarespace/mercury');

const instance = new Mercury({
  updateMatrix: [
    { selector: 'title', updateHTML: true },
    { selector: 'body', updateAttrs: true },
    { selector: '.content', updateHTML: true },
    { selector: 'script[data-name="static-context"]', updateScript: true }
  ]
});

Using ES6

If you prefer to handle transpiling and polyfilling on your own, you can import ES6 from Mercury:

import Mercury from '@squarespace/mercury/src';

Alternately, Mercury specifies a module property in package.json that points to the uncompiled src/index.js, so you may be able to simply import @squarespace/mercury if you're using one of the following bundlers:

Reference

new Mercury(config)

Params

  • config Object - Config object
  • config.updateMatrix Array - Array of selectors to update (required)
  • [config.enableCache] Boolean - Save markup in a cache object
  • [config.onClickExceptions] Array - Array of selectors to exclude from AJAX requests
  • [config.onRequestExceptions] Array - Array of selectors to exclude from AJAX requests
  • [config.onLoad] Function - Function to run after the AJAX request
  • [config.onUnload] Function - Function to run before the AJAX request
  • [config.timeout] Number - Timeout in milliseconds for AJAX request

Mercury.destroy()

Unbind all event listeners, including click, popstate, load, and unload.

Mercury.commitCacheEntry(url, selector)

Public method for the user of this class to pass in some HTML to commit to the class's cache. When the updateDOM call occurs, the method will check the cache first to see if there's a match for that URL with that selector, and use the cached HTML if there is.

The primary use case for this method is situations where other content is loaded asynchronously, and the user wishes for Mercury to use that content rather than whatever is on the server. Consider – infinite scrolling blogs may call commitCacheEntry each time a new load occurs.

Params

  • url String - Current URL for committed cache entry
  • selector String - Current selector for committed cache entry

License

Portions Copyright © 2016 Squarespace, Inc. This code is licensed to you pursuant to Squarespace’s Developer Terms of Use, available at http://developers.squarespace.com/developer-terms-of-use (the “Developer Terms”). You may only use this code on websites hosted by Squarespace, and in compliance with the Developer Terms. TO THE FULLEST EXTENT PERMITTED BY LAW, SQUARESPACE PROVIDES ITS CODE TO YOU ON AN “AS IS” BASIS WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED.