@alcatraz-components/accordion

An accordion web component

latest

Source

npm

Version: 1.0.3

Version published: 6 years ago

Maintainers: 1

Created: 5 years ago

Source

@alcatraz-components/accordion

A keyboard-accessible accordion component.

Usage

In HTML:

<!DOCTYPE html>
<html lang="en">
  <head>
    <!-- Use a JS module to add the component to your page -->
    <script type="module" src="index.js"></script>

    <!-- Use CSS custom properties to alter styles within the component. -->
    <style>
      :root {
        --alcatraz-accordion-border: 2px solid #ddd;
        --alcatraz-accordion-border-radius: 4px;
      }
    </style>
  </head>
  <body>
    <alcatraz-accordion>
      <alcatraz-accordion-panel label="K2" expanded="true">
        <p>Age: 13</p>
        <p>Color: gray</p>
      </alcatraz-accordion-panel>
      <alcatraz-accordion-panel label="Whitney">
        <p>Age: 13</p>
        <p>Color: orange</p>
      </alcatraz-accordion-panel>
      <alcatraz-accordion-panel label="Minnie Mitzie">
        <p>Age: 4</p>
        <p>Color: gray</p>
      </alcatraz-accordion-panel>
      <alcatraz-accordion-panel label="Paul">
        <p>Age: 3</p>
        <p>Color: orange</p>
      </alcatraz-accordion-panel>
    </alcatraz-accordion>
  </body>
</html>

In a JavaScript application:

npm install @alcatraz-components/accordion

import '@alcatraz-components/accordion';

If you are using webpack, you can instead include the component in your entry array:

module.exports = {
  entry: ['@alcatraz-component/accordion', './index.js']
};

Component properties

The main component, alcatraz-accordion, has one optional, configurable property: multiPanel.

Setting multiPanel="true" allows the user to open several panels at once. The default behavior closes the previous panel when the user clicks on a new panel.

<!-- Default: allows one panel to be open -->
<alcatraz-accordion></alcatraz-accordion>

<!-- Allows multiple panels to be open. -->
<alcatraz-accordion multiPanel="true"></alcatraz-accordion>

The alcatraz-accordion-panel has two configurable properties:

label: This is the text that displays as the panel title.
expanded: This is an optional property that expands a panel upon load.

<!-- This panel will be open upon load. -->
<alcatraz-accordion-panel label="K2" expanded="true">
  <p>Age: 13</p>
  <p>Color: gray</p>
</alcatraz-accordion-panel>

Configurable styles

Use the CSS custom properties outlined below to customize the look of the accordion from your stylesheet.

:root {
  /* Accordion */
  --alcatraz-accordion-border: 1px solid #ddd;
  --alcatraz-accordion-border-radius: 0;

  /* Item */
  --alcatraz-accordion-item-padding: 1rem;
  --alcatraz-accordion-button-bg-color: #fff;
  --alcatraz-accordion-button-font-size: 20px;
  --alcatraz-accordion-button-text-align: left;
  --alcatraz-accordion-panel-margin-top: 1rem;
}

Keywords

web-component

FAQs

What is @alcatraz-components/accordion?

Is @alcatraz-components/accordion well maintained?

Package last updated on 30 Mar 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install