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

@digital-butlers/accordions

v0.0.1

Published

A convenient library with accordions for everyday tasks

Downloads

70

Readme

Accordions

Usage

Create an HTML markup

<div data-role="accordion">
	<div data-role="accordion-item">
		<div data-role="accordion-summary">
			<h3 class="heading heading--l">Here's your first question</h3>
		</div>
		<div data-role="accordion-details">
			<div>
				<p class="paragraph paragraph--m">Here is the answer to your first question</p>
			</div>
		</div>
	</div>
	<div data-role="accordion-item">
		<div data-role="accordion-summary">
			<h3 class="heading heading--l">Here's your second question</h3>
		</div>
		<div data-role="accordion-details">
			<div>
				<p class="paragraph paragraph--m">Here is the answer to your second question</p>
			</div>
		</div>
	</div>
</div>

Create accordion instance

const componentElement = document.querySelector('[data-component-id="accordions"]'); //

const accordions = new Accordions({
	parentElement: componentElement, // Any node that is the parent of an accordion. It is advisable to specify the nearest parent
});

API

Config Properties

openClass

Type: string Default: 'js--open' Description: The class that will be added to the active accordion item

parentElement

Type: HTMLElement | Document Default: document Description: Any node that is the parent of an accordion. It is advisable to specify the nearest parent

accordionSelector

Type: string Default: '[data-role="accordion"]' Description: Css selector for wrapping all accordion elements

itemSelector

Type: string Default: '[data-role="accordion-item"]' Description: Css selector for creating a separate element inside the accordion, which will include "summary" and "details"

summarySelector

Type: string Default: '[data-role="accordion-summary"]' Description: Css selector for creating a "summary" inside a separate accordion item

detailsSelector

Type: string Default: '[data-role="accordion-details"]' Description: Css selector for creating a "details" inside a separate accordion item

breakpoint

Type: MediaQueryList Default: window.matchMedia('screen') Description: prevents changing the accordions if the breakpoint does not match the window.matchmedia

isSingle

Type: AccordionCallbacks Default: false Description: If set to 'true', then only one active accordion element can be turned on at a time

on

Type: object Description: Callbacks that can be initialized after some events with accordions

Events callback config object

detailsTransitionEnd

Type: function Default: undefined Description: Callback will be started after every transition end

open

Type: function Default: undefined Description: Callback will be started after every accordion open event

close

Type: function Default: undefined Description: Callback will be started after every accordion close event

toggle

Type: function Default: undefined Description: Callback will be started after every accordion changing event

beforeInit

Type: function Default: undefined Description: Callback will be started before accordion initialization

afterInit

Type: function Default: undefined Description: Callback will be started after accordion initialization