@nextindex/vue-simple-accordion

vue-simple-accordion

Accordion component in vue

To be as flexible as possible, it contains only Accordion Items. You have to wrap it in a container and add your own styling. Title and content will be set over slots, to provide a maximum flexebility for the accordion content.

Install

npm i @nextindex/vue-simple-accordion

Usage

import AccordionItem from 'vue-simple-accordion'

export default {
  components: {
    AccordionItem
  }
}

Templates & Slots

<accordion-item variant="Accordion__item--small">
    <div slot="title">Hello</div>
    <div slot="icon"> <svg> .... </svg> </div>
    <div slot="content">
      <p>I am a hidden content</p>
    </div>
</accordion-item>

In addition you can use the variant prop to pass additional classes.

Styling

Only a very basic styling is included. So you can style it yourself to match your style. Some preset stylings will be included later.

BEM Styles

.Accordion__item {}
.Accordion__heading {}
  .Accordion__title {}
  .Accordion__icon {
    &.is-open {}
  }
.Accordion__content {
  &.is-open {}
}

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# run unit tests
npm run unit

# run e2e tests
npm run e2e

# run all tests
npm test

For detailed explanation on how things work, checkout the guide and docs for vue-loader.