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

@ryze-digital/accordion

v1.0.0-beta.2

Published

Enhances the <details> tag with animations and events

Downloads

10

Readme

RYZE Digital Accordion

Run linter(s) workflow status

Install

npm i @ryze-digital/accordion

Usage

HTML

Class names can be changed if necessary, as long as you include the mixins (see Scss) correctly. If you want to prevent multiple accordions from being opened at the same time, you must assign a name attribute with the same value to each <details> element.

<div class="accordion" data-accordion>
    <details class="item">
        <summary class="title" data-title>
            Your accordion title 1
        </summary>
        <div class="content" data-content>
            Your accordion content 1
        </div>
    </details>
    <details class="item">
        <summary class="title" data-title>
            Your accordion title 2
        </summary>
        <div class="content" data-content>
            Your accordion content 2
        </div>
    </details>
</div>

Scss

@use "@ryze-digital/accordion";

Use the provided configure mixin to define your accordion defaults.

@include accordion.configure(...);

| Option | Type | Default | Description | |------------------------|-----------------|------------------------------|-------------------------------------------------------------| | padding | Map | | The shared padding used for title and content | | padding.right | Number | 0 | | | padding.left | Number | 0 | | | title | Map | | Configuration options especially for the title | | title.padding | Map | | | | title.padding.top | Number | scss-utilities.rem-calc(8) | | | title.padding.bottom | Number | scss-utilities.rem-calc(8) | | | content | Map | | Configuration options especially for the content | | content.padding | Map | | | | content.padding.top | Number | scss-utilities.rem-calc(8) | | | content.padding.bottom | Number | scss-utilities.rem-calc(8) | | | icon | Map | | Configure which icons from your icon font should be used | | icon.position | String (Quoted) | "after" | Should the icons be inserted before or after the title | | icon.top | Number | null | Top value for absolute position | | icon.closed | String (Quoted) | null | The UTF-8 character of the icon used on a closed accordion | | icon.opened | String (Quoted) | null | The UTF-8 character of the icon used on an opened accordion | | icon.spacing | Number | null | The gap between icon and title |

Check out the actual configure mixin for better understanding.

There is a separate mixin for each element in the accordion so styles can be applied to any markup.

.accordion {
    .item {
        @include accordion.item();
    }
    .title {
        @include accordion.title();
        @include accordion.icon-closed();
    }
    [open] {
        .title {
            @include accordion.icon-opened();
        }
    }
    .content {
        @include accordion.content();
    }
}

JavaScript

import { Accordion } from '@ryze-digital/accordion';

new Accordion({...}).init();

| Option | Type | Default | Description | |---------------------|-------------|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------| | el | HTMLElement | document.querySelector('[data-accordion]') | Container to which the library should be bound | | allowDeepLink | boolean | true | Open and scroll to accordion item based on URL hash | | animation | object | {  duration: 400,  easing: 'ease-out'} | |

Demos

Checkout this repository and use the /demos folder as document root to see a running demo in the browser.