basic-collapsible-panel v0.8.0

API Documentation

CollapsiblePanel ⇐ ElementBase

A panel which can be expanded/collapsed with an animated transition.

This component combines the OpenClose mixin and a simple CSS height animation.

This component handles only the duties of collapsing and expanding. It does not provide a user interface for the user to trigger the change in state; you must provide that user interface yourself.

Kind: global class Extends: ElementBase
Mixes: OpenClose

• CollapsiblePanel ⇐ ElementBase
  • .close()
  • .closed : boolean
  • .open()
  • .render(closing)
  • .toggle()

collapsiblePanel.close()

Close the component.

This is equivalent to setting the closed property to true.

Kind: instance method of CollapsiblePanel. Defined by OpenClose mixin.

collapsiblePanel.closed : boolean

True if the component is curently closed.

Kind: instance property of CollapsiblePanel. Defined by OpenClose mixin. Default: false

collapsiblePanel.open()

Open the component.

This is equivalent to setting the closed property to false.

Kind: instance method of CollapsiblePanel. Defined by OpenClose mixin.

collapsiblePanel.render(closing)

Perform custom rendering of the close/open transition.

You can override this method to perform custom effects. If you do so, be sure to invoke super() in your implementation to get the baseline behavior.

Kind: instance method of CollapsiblePanel. Defined by OpenClose mixin.

collapsiblePanel.toggle()

Toggle the component's open/closed state.

Kind: instance method of CollapsiblePanel. Defined by OpenClose mixin.