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

react-simple-accordion-ui

v1.0.4

Published

A flexible and customizable accordion component for React applications.

Downloads

10

Readme

React Simple Accordion UI

A flexible and customizable accordion component for React applications.

Features

  • Easy to use and integrate
  • Supports single or multiple open items
  • Customizable styling
  • Accessible (follows WAI-ARIA practices)
  • Typescript support

Installation

Install the package using npm:

npm install react-simple-accordion-ui

Or using yarn:

yarn add react-simple-accordion-ui

Usage

Here's a basic example of how to use the Accordion component:

import { Accordion } from 'react-simple-accordion-ui';

const App = () => {
  const items = [
    {
      title: "Simple Title",
      content: <p>This is a simple content with a React component.</p>,
      action: (isActive) => (
        <button>{isActive ? "Hide" : "Show"}</button>
      ),
    },
    {
      title: (
        <p>
          This title is a React component title
        </p>
      ),
      content: (
        <div>
          <p>This content is also a React component.</p>
          <p>It can contain multiple elements and even other components.</p>
          <a href="https://www.google.com">Another link to Google</a>
        </div>
      ),
    },
    {
      title: "Title with Default Toggle",
      content: (
        <p>
          This item uses the default toggle button instead of a custom action.
          The content can be as complex as you need.
        </p>
      ),
    },
  ];

  return (
    <Accordion
      items={items}
      allowMultiple={true}
      duration={300}
      easing="ease-in-out"
    />
  );
};

export default App;

Here are some basic styles for the component.

.RSA__AccordionWrapper {
  &__Item {
    border-radius: 6px;
    background-color: #fff;
    border: 1px solid #e5e5e5;

    &:not(:last-child) {
      margin-bottom: 20px;
    }

    &__Header {
      display: flex;
      align-items: center;
      padding: 20px;
      overflow: hidden;
      color: #333;

      > span {
        margin-left: auto;
      }
    }

    &__Content {
      border-top: 1px solid #ccc;

      &__ContentContainer {
        &__Wrapper {
          padding: 20px;
        }
      }
    }
  }
}

Props

The Accordion component accepts the following props:

| Prop | Type | Default | Description | |-----------------|---------|----------|-----------------------------------------------------------------------------------------------------------------| | allowMultiple | boolean | true | If true, multiple accordion items can be expanded at once. If false, only one item can be expanded at a time. | | className | string | | Specify a custom className for the wrapper. | | duration | number | | The duration of the expand/collapse animation in milliseconds. If not provided, no transition is applied. | | easing | string | | The easing function for the expand/collapse animation. Any valid CSS transition timing function can be used. | | items | Array | Required | An array of objects representing the accordion items. Each object should have a title and content property. |

Item Object Properties

Each item in the items array should be an object with the following properties:

| Property | Type | Description | |-----------|-----------|-------------------------------------------------------------------------------------------------------------------------| | title | ReactNode | The title of the accordion item. Can be a string or a React component. | | content | ReactNode | The content of the accordion item. Can be a string or a React component. | | action | function | (Optional) A custom function to render the expand/collapse action. If provided, it overrides the default toggle button. |

Styling

The component uses CSS modules for styling. You can override the default styles by targeting the following classes:

  • .RSA__AccordionWrapper: The main wrapper for the accordion
  • .RSA__AccordionWrapper__Item: Each accordion item
  • .RSA__AccordionWrapper__Item__Header: The header of each accordion item
  • .RSA__AccordionWrapper__Item__Content: The content wrapper of each accordion item
  • .RSA__AccordionWrapper__Item__Content__ContentContainer: The inner content container
  • .RSA__AccordionWrapper__Item__Content__ContentContainer__Wrapper: The innermost content wrapper

Additionally, the following modifier class is applied to active items:

  • .active: Applied to the accordion item when it's expanded

Accessibility

This component follows WAI-ARIA practices for accordions:

  • The accordion header buttons are keyboard accessible
  • aria-expanded is used to indicate the expanded state
  • aria-hidden is used to hide the content when collapsed

TypeScript

This component is written in TypeScript and includes type definitions. The main types you might need are:

interface IAccordionProps {
  allowMultiple?: boolean;
  duration?: number;
  easing?: string;
  items: Array<{
    title: ReactNode;
    content: ReactNode;
    action?: (isActive: boolean) => ReactNode;
  }>;
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.