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/controller

v1.0.5

Published

A lightweight control assigner for DOM elements

Downloads

16

Readme

Squarespace Controller

Controller is a lightweight control assigner for DOM elements. Controller binds functions to elements, and does the management work of making sure they are relevant, handling lifecycle after asynchronous content load.

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

Basic Usage:

A controller function is associated with a string through the method register. The string can then be set as the data-controller attribute of an element in the DOM, in order to bind the controller to the element.

Inside the controller function, the DOM element is passed in as an argument.

HTML

<div data-controller="MyController"></div>

JavaScript

import controller from '@squarespace/controller';

function MyController(element) {
  const handleClick = () => {
    element.toggleClass('clicked');
  };
  element.addEventListener('click', handleClick);
}

controller.register('MyController', MyController);

Advanced Usage

Ajax

Controller also exports a method refresh. If you use Ajax loading on your site, refresh should be called whenever an asynchronous load occurs.

Controller functions can return an object with sync and destroy methods. When refresh is called, the Controller manager will take stock of DOM elements, run destroy on any elements that no longer exist on the page, run sync on elements that remain on the page, and run the controller function for elements that are newly added to the page.

Ajax Example

HTML

<div data-controller="MyController"></div>

JavaScript

const controller = require('@squarespace/controller');

function MyController(element) {
  const handleClick = () => {
    element.toggleClass('clicked');
  };
  element.addEventListener('click', handleClick);
  return {
    sync: () => {
      element.removeClass('clicked');
    },
    destroy: () => {
      element.removeEventListener('click', handleClick);
    }
  };
}

controller.register('MyController', MyController);

// Assuming this event is dispatched on ajax load
window.addEventListener('ajax:load', controller.refresh);

Using ES6

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

import controller from '@squarespace/controller/src';

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

Reference

register(name, controller)

Register a function to a given name string, so that setting data-controller attribute to that string will bind that element to the controller function.

Params

  • name string
  • controller function

refresh()

Refresh all controllers. To be called after the DOM has been mutated.

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.