htz-collapsibles/changeState

Module: htz-collapsibles/changeState

Members

Methods

Methods

changeState.js:97

(inner) collapse(wrapper, contentElem, toggleElem, labelExpand, labelCollapse, collapsedClass, expandedClass, bpsSelector, isExpandedopt) → {Boolean}

Collapse a collapsible element

Parameters
Name Type Attributes Description
wrapper HTMLElement

The element wrapper
contentElem HTMLElement

The element containing the collapsible content.
toggleElem HTMLElement

The clickable element used for toggling.
labelExpand String

The label used to describe the toggle button when the element is collapsed and it is used expanding.
labelCollapse String

The label used to describe the toggle button when the element is expanded and it is used collapsing.
collapsedClass String

The label to attach to the wrapper when it is collapsed.
expandedClass String

The label to attach to the wrapper when it is expanded.
bpsSelector String

A selector for the element to which the active breakpoint data is attached. See htz-parse-bps-state
isExpanded Boolean <optional>

Indicates if the collapsible is currently collapsed (false) or expanded (true`).
Fires:
Returns

Returns false to indicate the element has been collapsed.

Type
Boolean
changeState.js:192

(inner) expand(wrapper, contentElem, toggleElem, labelExpand, labelCollapse, collapsedClass, expandedClass, bpsSelector, isExpandedopt) → {Boolean}

Expand a collapsible element

Parameters
Name Type Attributes Description
wrapper HTMLElement

The element wrapper
contentElem HTMLElement

The element containing the collapsible content.
toggleElem HTMLElement

The clickable element used for toggling.
labelExpand String

The label used to describe the toggle button when the element is collapsed and it is used expanding.
labelCollapse String

The label used to describe the toggle button when the element is expanded and it is used collapsing.
collapsedClass String

The label to attach to the wrapper when it is collapsed.
expandedClass String

The label to attach to the wrapper when it is expanded.
bpsSelector String

A selector for the element to which the active breakpoint data is attached. See htz-parse-bps-state
isExpanded Boolean <optional>

Indicates if the collapsible is currently collapsed (false) or expanded (true`).
Fires:
Returns

Returns true to indicate the element has been expanded.

Type
Boolean
changeState.js:268

(inner) isCollapsed(elem) → {Boolean}

Check if an element is collapsed

Parameters
Name Type Description
elem HtmlElement

The elemnt to test
Returns
Type
Boolean
changeState.js:37

(inner) toggle(wrapper, contentElem, toggleElem, labelExpand, labelCollapse, collapsedClass, expandedClass, bpsSelector, isExpandedopt) → {Boolean}

Toggle an element's state between collapsed or expanded

Parameters
Name Type Attributes Description
wrapper HTMLElement

The element wrapping
contentElem HTMLElement

The element containing the collapsible content.
toggleElem HTMLElement

The clickable element used for toggling.
labelExpand String

The label used to describe the toggle button when the element is collapsed and the button is used for expanding.
labelCollapse String

The label used to describe the toggle button when the element is expanded and the button is used for collapsing.
collapsedClass String

The label to attach to the wrapper when it is collapsed.
expandedClass String

The label to attach to the wrapper when it is expanded.
bpsSelector String

A selector for the element to which the active breakpoint data is attached. See htz-parse-bps-state
isExpanded Boolean <optional>

Indicates if the collapsible is collapsed (false) or expanded (true`).
Fires:
Returns

The collapsible's state after toggling (true if expanded, false if collapsed).

Type
Boolean