1. Plugins
  2. Collapse

Plugins

Tailwind CSS Collapse

Toggle the visibility of content.

Collapse

Installation

To get started, install Collapse plugin via npm, else you can skip this step if you are already using Preline UI as a package.

                      
                        npm i @preline/collapse

Example

Click the buttons below to show and hide another element:

Basic usage

Prefer to create your own style? Here is a completely unstylized example.

                      
                        <button type="button" class="hs-collapse-toggle" id="hs-unstyled-collapse" aria-expanded="false" aria-controls="#hs-unstyled-collapse-heading" data-hs-collapse="#hs-unstyled-collapse-heading">
                          Collapse
                        </button>
                        <div id="hs-unstyled-collapse-heading" class="hs-collapse hidden w-full overflow-hidden transition-[height] duration-300" aria-labelledby="hs-unstyled-collapse">
                          This is a collapse body. It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions.
                        </div>

Data Options

Name Description Options Default value
data-hs-collapse Collapse container. Valid selector. Should be added to the button (trigger). string null

Selectors

Name Description
hs-collapse Collapse container.
hs-collapse-toggle Collapse toggle.

Tailwind Modifiers

Name Description
hs-collapse-open:* Collapse open.

Methods

The HSCollapse object is contained within the global window object

Method Description
Public methods
show() Open collapsed item.
hide() Collapse item.
destroy() Destroys the instance, removes generated markup (if any), removes added classes and attributes.
Static methods
HSCollapse.getInstance(target) Returns the element associated to the target.
  • target should be a Node or string (valid selector)
HSCollapse.show(target) Open collapsed item.
HSCollapse.hide(target) Collapse item.

Open item (public method).

                      
                        const collapse = new HSCollapse(document.querySelector('#collapse'));
                        const showBtn = document.querySelector('#show-btn');

                        showBtn.addEventListener('click', () => {
                          collapse.show();
                        });

Open item (static method).

                      
                        const showBtn = document.querySelector('#show-btn');

                        showBtn.addEventListener('click', () => {
                          HSCollapse.show('#collapse');
                        });

Open item (mixed).

                      
                        const { element } = HSCollapse.getInstance('#collapse', true);
                        const showBtn = document.querySelector('#show-btn');

                        showBtn.addEventListener('click', () => {
                          element.show();
                        });

Events

Method Description
on:open Called when any item is opened.
on:hide Called when any item is closed.

Open any item event example.

                      
                        const el = HSCollapse.getInstance('#collapse');

                        el.on('open', (el) => {...});

Demo examples

Looking for prebuilt UI components based on the Tailwind CSS? Preline UI packs hundreds of component examples for all your website needs.

Plugins UI Mockups
Check out Preline UI Components