2.0.2 • Published 12 months ago

collapsible-react-component v2.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

Collapsible react component

Collapses and expands content with an animation.

NPM npm type definitions

screencast

Try interactive demo.

Install

npm install collapsible-react-component

Usage

import React from 'react'

import { Collapsible } from 'collapsible-react-component'
import 'collapsible-react-component/dist/index.css'

const Example = () => {
  const [open, setOpen] = React.useState(true)

  return (
    <>
      <button
        type='button'
        onClick={() => {
          setOpen(!open)
        }}
      >
        {open ? 'Close' : 'Open'}
      </button>
      <Collapsible
        open={open}
        onTransitionStart={(open) => {
          console.log('Collapsible box used to be', open ? 'open' : 'closed')
        }}
        onTransitionEnd={(open) => {
          console.log('Collapsible box is now', open ? 'open' : 'closed')
        }}
        revealType='bottomFirst'
      >
        Lorem ipsum dolor sit amet consectetur, adipisicing elit. Odio, sed
        labore? Autem laboriosam minima corrupti rem repellat odio reiciendis
        nihil! Eum natus dolorem atque blanditiis ipsam aperiam. Voluptatem,
        exercitationem fugit.
      </Collapsible>
    </>
  )
}

Props

NameRequiredDefaultTypeDescription
opennonebooleanDetermines wheter the children content should be visible.
childrennoneReactNodeCollapsible content.
onTransitionStartnoop(open: boolean) => voidCallback invoked when transition starts. open is the starting state.
onTransitionEndnoop(open: boolean) => voidCallback after content is fully expanded or fully closed. open is the final state.
revealTypebottomFirstbottomFirst \| topFirstType of transition animation.

Development

Run

npm ci
npm run dev

and

cd example
npm ci
npm run dev
2.0.2

12 months ago

2.0.1

12 months ago

1.1.2

1 year ago

2.0.0

1 year ago

1.1.1

1 year ago

1.1.0

1 year ago

1.0.0

1 year ago

0.0.7

1 year ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago