https://github.com/skybrud/sky-reveal
Module for collapsing content
https://github.com/skybrud/sky-reveal
Last synced: 10 months ago
JSON representation
Module for collapsing content
- Host: GitHub
- URL: https://github.com/skybrud/sky-reveal
- Owner: skybrud
- License: mit
- Created: 2017-03-14T09:51:14.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-01-28T07:42:56.000Z (over 7 years ago)
- Last Synced: 2025-08-09T16:21:28.452Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 271 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sky-reveal
> Simple js module that collapses content
## Installation
```bash
npm install sky-reveal
```
or
```bash
yarn add sky-revel
```
## Usage
Begin by importing and installing the SkyReveal Vue plugin:
```js
import Vue from 'vue';
import SkyReveal from 'sky-reveal';
// If you want to use the baseline scss add the following line
import '${YOUR-PROJECT-ROOT-PATH}/node_modules/sky-reveal/src/SkyReveal.scss';
Vue.use(SkyReveal);
```
There are two ways to use `sky-reveal`. The first one is as a stand-alone module where you provide a toggle button (`sky-reveal-trigger`) for the content to be revealed.
Here you need to to use the attribute `reveal-id` with the same value on both `sky-reveal` and `sky-reveal-trigger`
``` html
Ullamco enim eiusmod nisi exercitation occaecat do culpa. Elit dolore nulla aliqua sunt. Ex id eu ea et quis ex pariatur veniam mollit amet laborum. Magna elit aute non est. Ullamco enim eiusmod nisi exercitation occaecat do culpa. Elit dolore nulla aliqua sunt. Ex id eu ea et quis ex pariatur veniam mollit amet laborum. Magna elit aute non est.
(optional)
Show more
Show less
```
The other way to use `sky-reveal` is as a sub component which are provided with a bool in the `open` attribute like this. This will open / close `sky-reveal`
``` html
Ullamco enim eiusmod nisi exercitation occaecat do culpa. Elit dolore nulla aliqua sunt. Ex id eu ea et quis ex pariatur veniam mollit amet laborum. Magna elit aute non est. Ullamco enim eiusmod nisi exercitation occaecat do culpa. Elit dolore nulla aliqua sunt. Ex id eu ea et quis ex pariatur veniam mollit amet laborum. Magna elit aute non est.
```
By default `sky-reveal` animates with a duration om 500ms. You can change this via the `duration` attribute.
``` html
...
```
Furthermore, `sky-reveal` emits a few callbacks you can utilize.
``` html
...
```
## How it works
`Sky-reveal` uses animeJs as animation engine which handles initial state and animations from and to height. If the animation is to open `sky-reveal` it calculate auto height in pixel and animate towards this value and on completion set `height: auto` which will make the container responsive.
if closing it will use the computed property `min-height` on `.sky-reveal`.
# Credits
This module is made by the Frontenders at [skybrud.dk](http://www.skybrud.dk/). Feel free to use it in any way you want. Feedback, questions and bugreports should be posted as issues. Pull-requests appreciated!