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

peekaboo-toggle

v2.0.1

Published

A jQuery plugin for accessible content toggles.

Downloads

1,253

Readme

peekaboo.js

A jQuery plugin for showing and hiding content in an accessible way.

View demos.

Features

  • Flexible for most cases where you need to show/hide stuff, such as menus, accordions, tabs.
  • Simple by default, and customizable for more complex uses.
  • Adds ARIA attributes and a <button> element (when necessary) for keyboard and screen reader accessibility.

Installation

With npm:

npm install --save peekaboo-toggle

With unpkg:

<script src="https://unpkg.com/peekaboo-toggle/lib/index.js"></script>

How to use

By default, a peekaboo toggle will show/hide the next element in the DOM. Let's say we have a button that should show/hide a menu when clicked:

<button class="peekaboo">Menu</button>
<nav>
  <ul>
    <li><a href="breakfast.html">Breakfast</a></li>
    <li><a href="lunch.html">Lunch</a></li>
    <li><a href="dinner.html">Dinner</a></li>
  </ul>
</nav>

We bind peekaboo to the button like this:

// If you're using npm
import $ from 'jquery';
import peekaboo from 'peekaboo-toggle';

$('.peekaboo').peekaboo();

Peekaboo will add the [hidden attribute] to the <nav>, so let's add some CSS to make sure hidden means hidden:

[hidden] {
  display: none !important;
}

Peekaboo will add the aria-expanded and aria-controls attributes to the <button> and will — since we didn't specify one — generate an ID for the <nav>. The nav will be hidden by default, and the DOM will look something like this:

<button class="peekaboo" aria-expanded="false" aria-controls="peekaboo-c4tlipic9">Menu</button>
<nav id="peekaboo-c4tlipic9" hidden="hidden">
  <ul>
    <li><a href="breakfast.html">Breakfast</a></li>
    <li><a href="lunch.html">Lunch</a></li>
    <li><a href="dinner.html">Dinner</a></li>
  </ul>
</nav>

Toggling some other element

You can specify the ID of the content you'd like to toggle using the data-toggle-target or aria-controls attributes. This is useful if the content doesn't immediately follow the toggle button in your document.

<button class="peekaboo" aria-controls="menu">Menu</button>
<h2>We have many beautiful things on our menus.</h2>
<nav id="menu">
  <ul>
    <li><a href="breakfast.html">Breakfast</a></li>
    <li><a href="lunch.html">Lunch</a></li>
    <li><a href="dinner.html">Dinner</a></li>
  </ul>
</nav>

Options

The following options are available, shown with the default values:

$('.peekaboo').peekaboo({
  // Prefix for generated IDs and namespace the event listener
  namespace: 'peekaboo',

  // Class name(s) added to generated button (if applicable)
  buttonClassname: 'button--transparent',

  // Called after the event.
  // Receives the event object as an argument.
  callback: () => {},

  // When true, the click event will be removed
  // If a <button> was generated, it'll also be removed
  destruct: false
});