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

@wedgekit/accordion

v3.0.2

Published

## Purpose

Downloads

19

Readme

Accordion

Purpose

An accordion is an area that can be collapsed and opened. The component consists of a title bar and children that will be revealed when the accordion is open.

Terms for understanding accordions include:

Accordion Header: Label for or thumbnail representing a section of content that also serves as a control for showing, and in some implementations, hiding the section of content.

Accordion Panel: Section of content associated with an accordion header.

More on the Accordion here.

Usage

import styled from 'styled-components';

import Accordion from '@wedgekit/accordion';
import Card from '@wedgekit/card';
import { Text } from '@wedgekit/core';

const StyledCard = styled(Card)`
  display: flex;
  flex-direction: row;
  justify-content: space-between;
  padding: 8px;
  margin: 8px 32px;
`;

const Example = () => {
  const [open, setOpen] = React.useState(false);

  return (
    <Accordion
      open={open}
      header={<Text style={{ margin: 'auto 0px' }}>This is the Accordion Header</Text>}
      onToggle={() => setOpen(!open)}
    >
      <>
        <StyledCard>
          <Text>Task Title</Text>
          <Text>01/02/21</Text>
          <Text>01/02/21</Text>
        </StyledCard>
        <StyledCard>
          <Text>Task Title</Text>
          <Text>01/02/21</Text>
          <Text>01/02/21</Text>
        </StyledCard>
      </>
    </Accordion>
  );
};

render(<Example />);

Props

children

Type: JSX.Element

Required: ✅

Children is the panel content of the Accordion. Panel content will be shown if open is true and hidden if open is false.

className

Type: string

required: ❌

This is exposed but is only here so that styled-components will be able to style components correctly. Please do not use this unless you really know what you are doing.

header

Type: JSX.Element

Required: ✅

JSX that renders as the header of the Accordion. Header will be displayed if Accordion is open or collapsed.

open

Type: boolean

Required: ✅

Determines whether or not the accordion children are displayed or not.

onToggle

Type: (e: React.SyntheticEvent) => void

Required: ✅

Event notifying the intent of the Accordion to toggle between open and closed.

Further Reading