Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

collapsible-react-component

Package Overview
Dependencies
Maintainers
0
Versions
24
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

collapsible-react-component

Collapses and expands content with an animation.

  • 3.0.6
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
99
decreased by-34%
Maintainers
0
Weekly downloads
 
Created
Source

Collapsible react component

Collapses and expands content with an animation.

NPM npm type definitions

screencast

Install

npm install collapsible-react-component

Usage

Try CodeSandbox interactive demo or see Storybook examples.

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

const Example = () => {
	const [open, setOpen] = 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
openbooleanDetermines whether the children content should be visible.
childrenReactNodeCollapsible 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.
alwaysKeepChildrenMountedfalsebooleanIf true then children won't be unmounted when collapsed.

Development

Run

npm ci
npm run dev

and

cd example
npm ci
npm run dev

Keywords

FAQs

Package last updated on 11 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc