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

nested-accordion

v2.0.2

Published

Generates a series of accessible nested accordions from a json datafile.

Downloads

434

Readme

nested-accordion

npm version Build Status Coverage Status install size

Generates a series of nested accordions (using the details/summary elements) from a json datafile


Install

$ yarn add nested-accordion

Usage

Import:

const nestedAccordion = require('nested-accordion');

.create(data) gives a html string with a nested-accordion div to be inserted in a website

const nestedAccordionDiv = nestedAccordion.create(data)

Data should be an array of SectionData

Title is required, optional text and children. If both text and children are ommitted, that child accordion will be diabled

type SectionData = {
  title: string;
  text?: string;
  children?: Array<SectionData>;
};

`.styles()`` gives a string with the css you should add to your site

Optional colour parameters default to grey boxes

const styles = nestedAccordion.styles(
  activeColour: 'grey',
  inactiveColor: 'lightgrey',
  textColor: 'black')
export css = `<style>\n${styles}\n</style>`

Example

  const data = [
    {
      title: 'Grandparent 1',
      text: 'Grandparent 1 description.',
      children: [
        {
          title: 'Parent 1',
        },
        {
          title: 'Parent 1',
          children: [
            {
              title: 'First Child',
              text: 'I am the first child',
            },
            {
              title: 'Second Child',
              text: 'I am the first child',
            }
          ]}
      ]},
      {
      title: 'Grandparent 2',
      text: 'Grandparent 2 description.',
      children: [
        {
          title: 'Parent 3',
          children: [
            {
              title: 'First Child',
              text: 'I am the first child',
            },
            {
              title: 'Second Child',
              text: 'I am the first child',
            }
          ]}
      ]}
  ];

const css = `<style>${nestedAccordion.styles('cyan', 'lightcyan')}</style>`
const div = nestedAccordion.create(data)

Then when the css string is put in the body of the page, and the div where you want the accordion to appear, to looks like: demo gif

Live usage

This can be used to visualise large mind-map style datasets, for example on this site looking tinto university courses.


Bugs or updates

If you want to use this accordion for you project, but it isn't quite working, let me know and I'll see what I can do!

This was originally made for a specific purpose (visualisation of a json dataset for an eleventy-genreated website), so may not work in all scenarios yet!