Skip to content
This repository was archived by the owner on Dec 19, 2024. It is now read-only.

Repository files navigation

Published on NPMBuild statusPublished on webcomponents.org

<iron-collapse>

iron-collapse creates a collapsible block of content. By default, the content will be collapsed. Use opened or toggle() to show/hide the content. The aria-expanded attribute should only be set on the button that controls the collapsable area, not on the area itself. See https://www.w3.org/WAI/GL/wiki/Using_aria-expanded_to_indicate_the_state_of_a_collapsible_element#Description

iron-collapse adjusts the max-height/max-width of the collapsible element to show/hide the content. So avoid putting padding/margin/border on the collapsible directly, and instead put a div inside and style that.

<style>
.collapse-content {
padding:15px;
border:1px solid #dedede;
}
</style><iron-collapse><divclass="collapse-content"><div>Content goes here...</div></div></iron-collapse>

Styling

The following custom properties and mixins are available for styling:

Custom propertyDescriptionDefault
--iron-collapse-transition-durationAnimation transition duration300ms

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/iron-collapse

In an html file

<html><head><scripttype="module">import'@polymer/iron-collapse/iron-collapse.js';</script></head><body><iron-collapseid="collapse"><div>Content goes here...</div></iron-collapse></body></html>

In a Polymer 3 element

import{PolymerElement,html}from'@polymer/polymer';import'@polymer/iron-collapse/iron-collapse.js';classSampleElementextendsPolymerElement{staticgettemplate(){returnhtml`<iron-collapseid="collapse"><div>Content goes here...</div></iron-collapse> `;}}customElements.define('sample-element',SampleElement);

Contributing

If you want to send a PR to this element, here are the instructions for running the tests and demo locally:

Installation

git clone https://github.com/PolymerElements/iron-collapse
cd iron-collapse
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm

About

Adds collapsible behavior to a target element

Resources

Contributing

Stars

27 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages