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

ux

v0.3.0

Published

website user preference API

Downloads

56

Vulnerabilities

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

Links

Git

Maintainers

ryanveryanve

Keywords

uxpreferencestoragebrowserender

Readme

ux

website user preference API

ux uses localStorage to remember features such as user preferences or display modes.

API

Methods

Notes

  • feature can be any string
  • features are either enabled, disabled, or unknown

ux.enabled(feature?)

  • ux.enabled(): Get an array containing the names of all enabled features
  • ux.enabled(feature): Test if feature is enabled. Return boolean

ux.disabled(feature?)

  • ux.disabled(): Get an array containing the names of all disabled features
  • ux.disabled(feature): Test if feature is disabled. Return boolean

ux.known(feature?)

  • ux.known(): Get an array containing the names of all known features
  • ux.known(feature): Test if feature is known. Return boolean

ux.enable(feature)

  • Enable feature, and trigger associated listeners

ux.disable(feature)

  • Disable feature, and trigger associated listeners

ux.toggle(feature)

  • Toggle (either enable or disable) feature, and trigger associated listeners

ux.forget(feature)

  • Forget feature, and trigger associated listeners

ux.forget()

  • Forget all features

Emitters have emitter methods

  • .on(feature, listener)
  • .off(feature?, listener?)
  • .once(feature, listener)
  • .emit(feature, ...args)

Emitter syntax

  • ux.enable.on(feature, listener)
  • ux.disable.on(feature, listener)
  • ux.forget.on(feature, listener)
  • ux.enable.off(feature?, listener?)
  • ux.disable.off(feature?, listener?)
  • ux.forget.off(feature?, listener?)
  • etc.

Emitter example

// Listen for when 'crazycolors' is enabled
ux.enable.on('crazycolors', function(feature) {
  document.querySelector('html').classList.add(feature)
  console.log(feature + ' enabled')
})

// Enable 'crazycolors'
ux.enable('crazycolors')

You normally would want to also listen for when the same feature is disabled and do an opposing action. You're also likely to have multiple (and maybe related) features. ux doesn't care what your features do. It only provides the API for enabling, disabling, and remembering them. Do what makes sense for your features and users :)