4.1.2 • Published 4 months ago

react-collapsed v4.1.2

Weekly downloads
7,387
License
MIT
Repository
github
Last release
4 months ago

🙈 react-collapsed (useCollapse)

CI npm bundle size (version) npm version Netlify Status

A React hook for creating accessible expand/collapse components. Animates the height using CSS transitions from 0 to auto.

Features

  • Handles the height of animations of your elements, auto included!
  • You control the UI - useCollapse provides the necessary props, you control the styles and the elements.
  • Accessible out of the box - no need to worry if your collapse/expand component is accessible, since this takes care of it for you!
  • No animation framework required! Simply powered by CSS animations
  • Written in TypeScript

Demo

See the demo site!

CodeSandbox demo

Installation

$ npm i react-collapsed

Usage

Simple Usage

import React from 'react'
import { useCollapse } from 'react-collapsed'

function Demo() {
  const { getCollapseProps, getToggleProps, isExpanded } = useCollapse()

  return (
    <div>
      <button {...getToggleProps()}>
        {isExpanded ? 'Collapse' : 'Expand'}
      </button>
      <section {...getCollapseProps()}>Collapsed content 🙈</section>
    </div>
  )
}

Control it yourself

import React, { useState } from 'react'
import { useCollapse } from 'react-collapsed'

function Demo() {
  const [isExpanded, setExpanded] = useState(false)
  const { getCollapseProps, getToggleProps } = useCollapse({ isExpanded })

  return (
    <div>
      <button
        {...getToggleProps({
          onClick: () => setExpanded((prevExpanded) => !prevExpanded),
        })}
      >
        {isExpanded ? 'Collapse' : 'Expand'}
      </button>
      <section {...getCollapseProps()}>Collapsed content 🙈</section>
    </div>
  )
}

API

const { getCollapseProps, getToggleProps, isExpanded, setExpanded } =
  useCollapse({
    isExpanded: boolean,
    defaultExpanded: boolean,
    collapsedHeight: 0,
    easing: string,
    duration: number,
    onTransitionStateChange: func,
  })

useCollapse Config

The following are optional properties passed into useCollapse({ }):

PropTypeDefaultDescription
isExpandedbooleanundefinedIf true, the Collapse is expanded
defaultExpandedbooleanfalseIf true, the Collapse will be expanded when mounted
collapsedHeightnumber0The height of the content when collapsed
easingstringcubic-bezier(0.4, 0, 0.2, 1)The transition timing function for the animation
durationnumberundefinedThe duration of the animation in milliseconds. By default, the duration is programmatically calculated based on the height of the collapsed element
onTransitionStateChangefunctionno-opHandler called with at each stage of the transition animation
hasDisabledAnimationbooleanfalseIf true, will disable the animation
idstring | numberundefinedUnique identifier used to for associating elements appropriately for accessibility.

What you get

NameDescription
getCollapsePropsFunction that returns a prop object, which should be spread onto the collapse element
getTogglePropsFunction that returns a prop object, which should be spread onto an element that toggles the collapse panel
isExpandedWhether or not the collapse is expanded (if not controlled)
setExpandedSets the hook's internal isExpanded state

Alternative Solutions

  • react-spring - JavaScript animation based library that can potentially have smoother animations. Requires a bit more work to create an accessible collapse component.
  • react-animate-height - Another library that uses CSS transitions to animate to any height. It provides components, not a hook.

FAQ

The collapse works by manipulating the height property. If an element has vertical padding, that padding expandes the size of the element, even if it has height: 0; overflow: hidden.

To avoid this, simply move that padding from the element to an element directly nested within in.

// from
<div {...getCollapseProps({style: {padding: 20}})}
  This will do weird things
</div>

// to
<div {...getCollapseProps()}
  <div style={{padding: 20}}>
    Much better!
  </div>
</div>
4.1.0

5 months ago

4.1.2

4 months ago

4.1.1

5 months ago

4.0.4

8 months ago

4.0.3

9 months ago

4.0.1

1 year ago

4.0.2

12 months ago

3.8.0

1 year ago

3.7.0

1 year ago

3.6.0

1 year ago

3.5.0

1 year ago

4.0.0

1 year ago

3.4.0

2 years ago

3.3.2

2 years ago

3.3.1

2 years ago

3.3.0

2 years ago

3.2.2

2 years ago

3.2.1

2 years ago

3.2.0

2 years ago

3.1.0

2 years ago

3.0.2

3 years ago

3.0.1

4 years ago

3.0.0

4 years ago

3.0.0-6

4 years ago

3.0.0-5

4 years ago

3.0.0-3

4 years ago

3.0.0-4

4 years ago

3.0.0-1

4 years ago

3.0.0-2

4 years ago

3.0.0-0

4 years ago

2.2.3

4 years ago

2.2.2

5 years ago

2.2.1

5 years ago

2.2.0

5 years ago

2.1.1

5 years ago

2.1.0

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago

2.0.0-alpha.4

5 years ago

2.0.0-alpha.3

5 years ago

2.0.0-alpha.2

5 years ago

2.0.0-alpha.1

5 years ago

1.0.0

5 years ago

0.2.0

5 years ago

0.1.3

5 years ago

0.1.2

5 years ago

0.1.1

5 years ago

0.1.0

5 years ago