4.4.9 • Published 8 months ago

@conectate/ct-collapse v4.4.9

Weekly downloads
2
License
BSD-3-Clause
Repository
github
Last release
8 months ago

Published on webcomponents.org

ct-collapse

A collapsible content component that can smoothly expand and collapse with animation.

Installation

# npm
npm i @conectate/ct-collapse

# yarn
yarn add @conectate/ct-collapse

# pnpm
pnpm i @conectate/ct-collapse

Usage

Basic Usage

import '@conectate/ct-collapse';

// Then use in your HTML
<ct-collapse>
  <div>This content can be expanded or collapsed</div>
</ct-collapse>

Examples

<!-- Basic collapsed content (default state) -->
<ct-collapse>
	<div>This content is collapsed by default</div>
</ct-collapse>

<!-- Initially expanded content -->
<ct-collapse opened>
	<div>This content is expanded by default</div>
</ct-collapse>

<!-- Multiple content elements should be wrapped in a container -->
<ct-collapse>
	<div>
		<h3>Collapsed Section Title</h3>
		<p>First paragraph</p>
		<p>Second paragraph</p>
	</div>
</ct-collapse>

Controlling from JavaScript

// Get reference to the element
const collapse = document.querySelector('ct-collapse');

// Toggle the collapse state
collapse.toggle();

// Or set directly
collapse.opened = true;  // expand
collapse.opened = false; // collapse

API

Properties

PropertyAttributeTypeDefaultDescription
openedopenedbooleanfalseControls whether content is expanded or collapsed

Methods

NameDescription
toggle()Toggles between expanded and collapsed state

Events

This component doesn't emit any custom events.

Slots

NameDescription
(default)Content to be collapsed/expanded. Only one direct child element is supported. To include multiple elements, wrap them in a container element.

Styling

CSS Custom Properties

The component uses internal styling but can be customized by wrapping in a container or styling the content within.

Internal styles

The collapse animation is handled automatically. The component:

  • Uses a 250ms transition for all properties
  • Calculates the appropriate height for the content
  • Manages overflow properties during transition

Notes

  • 🔔 Only ONE direct child element is supported. If you need to collapse multiple elements, wrap them in a container.
  • The component automatically calculates required heights for smooth animations.
  • The transition duration is fixed at 250ms.

Follow me

Herberth Obregón

https://x.com/herberthobregon

https://dev.to/herberthobregon

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

  • v1.0.0 Initial Release

License

See LICENSE

4.4.9

8 months ago

4.3.0

11 months ago

4.0.0

1 year ago

3.11.0

2 years ago

3.8.0

2 years ago

3.10.0

2 years ago

3.12.0

2 years ago

3.9.0

2 years ago

3.8.1

2 years ago

3.7.5

3 years ago

3.7.4

3 years ago

3.7.3

3 years ago

3.7.1

3 years ago

3.7.0

3 years ago

3.6.1

4 years ago

3.6.0

4 years ago

3.5.11

4 years ago

3.5.0

4 years ago

3.4.0

4 years ago

3.2.1

5 years ago

3.2.0

5 years ago

3.1.0

5 years ago

3.0.0

5 years ago

1.4.0

5 years ago