Reveal

A flexible modern reveal js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/reveal

NPM

npm i @pluginjs/reveal

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/reveal/dist/reveal.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/reveal/dist/reveal.css">

Production:

<script src="https://unpkg.com/@pluginjs/reveal/dist/reveal.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/reveal/dist/reveal.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import Reveal from "@pluginjs/reveal"
import "@pluginjs/reveal/dist/reveal.css"

Reveal.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/reveal/dist/reveal.css")
const Reveal = require("@pluginjs/reveal")

Reveal.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/reveal/dist/reveal.css">
<script src="https://unpkg.com/@pluginjs/reveal/dist/reveal.js"></script>
<script>
  Pj.reveal('.element', options)
</script>

API

Options

Options are called on reveal instances through the reveal options itself. You can also save the instances to variable for further use.

Name | Description | Default --|--|-- "animation" | Animation name | fadeIn "duration" | Animation duration | 400 "easing" | Animation easing | ease "delay" | Animation delay | 0 "count" | Animation count, Numbers or infinite | 1 "mode" | Animation mode, Always or once | always "mobile" | Whether to support the mobile | false "tablet" | Whether to support the tablet | false "anchor" | You can set the trigger anchor, Enter the element selector | ``

Events

Events are called on reveal instances through the reveal events itself. You can also save the instances to variable for further use.

Name | Description --|-- "ready" | Gets fired when plugin is ready "destroy" | Gets fired when plugin is destroy "enter" | Gets fired when element in view "exit" | Gets fired when element out view "disable" | Gets fired when plugin is disabled "enable" | Gets fired when plugin is enabled "animationEnd" | Gets fired When stopped animation

Methods

Methods are called on reveal instances through the reveal method itself. You can also save the instances to variable for further use.

Name | Description --|-- "destroy" | Destroy plugin "enable" | Enabled plugin if plugin is disabled "disable" | Disable plugin "isVisible" | Return is in view

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-reveal "DISABLED" | Announce plugin is disabled | {namespace}-disabled

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/reveal is Licensed under the GPL-v3 license.

If you want to use @pluginjs/reveal project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.