@pluginjs/collapse

Collapse

A flexible modern collapse js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/collapse

NPM

npm i @pluginjs/collapse

Getting Started

CDN:

Development:

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

Production:

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

Initialize

HTML:

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

ECMAScript Module:

import Collapse from "@pluginjs/collapse"
import "@pluginjs/collapse/dist/collapse.css"

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

CommonJS:

require("@pluginjs/collapse/dist/collapse.css")
const Collapse = require("@pluginjs/collapse")

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

Browser:

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

API

Options

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

Name	Description	Default
"theme"	Add plugin theme option	null
"instructions"	Add plugin instructions option	false
"collapsed"	Set plugin is collapsed or not	false

Events

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

Name	Description
"update"	Gets fired when plugin is destroy
"ready"	Gets fired when plugin is ready
"enable"	Gets fired when plugin is enabled
"disable"	Gets fired when plugin is disabled
"destroy"	Gets fired when plugin is destroy
"expand"	Gets fired when plugin is expand
"expanded"	Gets fired when plugin is expanded
"collapse"	Gets fired when plugin is collapse
"collapsed"	Gets fired when plugin is collapsed

Methods

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

Name	Description
"enable"	Enabled plugin if plugin is disabled
"disable"	Disable plugin
"destroy"	Destroy plugin
"toggle"	Toggle plugin
"collapse"	Set collapse with plugin
"expand"	Set expand with plugin

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-collapse "THEME" | Declare plugin theme | {namespace}--{theme} "CONTAINER" | Declare plugin range | {namespace} "COLLAPSED" | Declare plugin collapsed | {namespace}-collapsed "COLLAPSING" | Declare plugin is collapsing | {namespace}-collapsing "EXPANDED" | Declare plugin is expanded | {namespace}-expanded "EXPANDING" | Declare plugin is expanding | {namespace}-expanding "HEADER" | Declare header element | {namespace}-header "CONTENT" | Declare content node | {namespace}-content "ACTIVE" | Announce plugin is actived | {namespace}-active "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/collapse is Licensed under the GPL-v3 license.

If you want to use @pluginjs/collapse 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 [e-mail].

Copyright

Copyright (C) 2022 Creation Studio Limited.