Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ashhitch/expaaand

Expand Anything
https://github.com/ashhitch/expaaand

javascript typescript

Last synced: about 2 months ago
JSON representation

Expand Anything

Awesome Lists containing this project

README

        

[![CircleCI](https://circleci.com/gh/ashhitch/expaaand.svg?style=svg)](https://circleci.com/gh/ashhitch/expaaand)

# expaaand

Expand Anything, a simple JavaScript Library that will will allow you to add an active class (defaults is-active) to a target element on click.

## Features Include:

- Simple API
- Data attribute overrides
- Grouping of elements (e.g for accordions)
- Optional toggling
- Optional additional close button
- Responsive toggling
- Event system

## Some use cases

- Menus
- Accordions
- Popups
- Modals

## Docs

First import the module

`import { Expaaand } from 'expaaand';`

Initialise Expaaand

```js
const myButtonElm = document.querySelector('.js-my-button');
new Expaaand(myButtonElm);
```

Add markup to button

```html
Toggle


Target elm

```

More docs coming soon...

## Examples

See [example.html](example.html) for more examples (note the example is using R for module loading)

## TODO

- Write tests
- Update docs
- import examples
- Demo site