Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kunukn/react-slide-toggle
React component re-implementation for jQuery.slideToggle feature
https://github.com/kunukn/react-slide-toggle
animation collapsible ease react toggle
Last synced: 30 days ago
JSON representation
React component re-implementation for jQuery.slideToggle feature
- Host: GitHub
- URL: https://github.com/kunukn/react-slide-toggle
- Owner: kunukn
- License: mit
- Created: 2017-12-16T13:47:26.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T16:51:26.000Z (about 2 years ago)
- Last Synced: 2024-11-11T18:54:57.583Z (about 2 months ago)
- Topics: animation, collapsible, ease, react, toggle
- Language: JavaScript
- Homepage:
- Size: 3.52 MB
- Stars: 42
- Watchers: 2
- Forks: 7
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## about
React version of jQuery.slideToggle. JavaScript animation where height is set on every requestAnimationFrame.
The toggle direction can be reversed during the movement.
[](https://www.npmjs.com/package/react-slide-toggle)
[](https://www.npmjs.com/package/react-slide-toggle)
[](https://bundlephobia.com/result?p=react-slide-toggle)
[](https://github.com/kunukn/react-slide-toggle/blob/master/LICENSE)
If you are looking for a CSS transition based alternative, then use this instead
https://github.com/kunukn/react-collapse
## Supported React versions
- React version 16.0+
## demo
- https://codepen.io/kunukn/full/wpepGz/ - cdn example
- https://codesandbox.io/s/react-slide-toggle-y3tpn - npm example
## size
- UMD minified size ~7.8Kb (gzipped ~2.5Kb)
## setup / local demo
- git clone or download
- npm install
- npm start
## info
Default easing is cubicInOut. You can reverse the toggle before the movement completes. Ease in-out works best visually when reverse toggling is to be used.
This should be A11Y friendly, you can test the tabindex by tabbing. The collapsed items should be skipped due to usage of display:none (inert functionality)
JS animation is used for best animation control and possibility of adding interpolation or using advanged easing configuration which you can't with CSS alone. This triggers browser reflows on every requestAnimationFrame. If you have a very long page this might not be the best option to use.
## usage example
Look in App component for inspiration. Apply the styling as needed.
### component example, simple - render prop
```js
import SlideToggle from "react-slide-toggle";
// or
// const SlideToggle = require("react-slide-toggle");
// Apply optional padding to .my-collapsible__content-inner
(
toggle
Collapsible content
)}
/>;
```
### component example, simple - function as child
```js
import SlideToggle from "react-slide-toggle";
// Apply optional padding to .my-collapsible__content-inner
{({ toggle, setCollapsibleElement }) => (
toggle
Collapsible content
)}
;
```
### toggle state from outside example
```js
import SlideToggle from "react-slide-toggle";
class MyComponent extends React.Component {
state = { toggleEvent: 0 };
onToggle = () => {
this.setState({ toggleEvent: Date.now() });
};
render() {
return (
Toggle
{({ setCollapsibleElement }) => (
Collapsible content
)}
);
}
}
```
### component usage example with all options
```js
import SlideToggle from "react-slide-toggle";
import BezierEasing from "bezier-easing"; // optional
const bezierEaseInOutQuart = BezierEasing(0.77, 0, 0.175, 1);
{
/* optional event hook */
}}
onExpanding={({ range, progress, hasReversed }) => {
/* optional event hook */
}}
onCollapsed={({ hasReversed }) => {
/* optional event hook */
}}
onCollapsing={({ range, progress, hasReversed }) => {
/* optional event hook */
}}
onMount={({ toggleState, toggle }) => {
/* optional event hook */
}}
onUnmount={({ toggleState }) => {
/* optional event hook */
}}
expandEvent /* default undefined */
collapseEvent /* default undefined */
toggleEvent /* default undefined */
render={({
toggle,
setCollapsibleElement,
toggleState,
isMoving,
hasReversed,
range /* linear value between [0 and 1] */,
progress /* easing result value between [0 and 1] */
}) => {
/* optional logic here */
/*
markup example
where setCollapsibleElement, toggle and progress are used
*/
return (
toggle
Collapsible content
);
}}
/>;
```
## properties
- duration - movement duration in milli seconds
- easeCollapse - function which generates a value between [0 and 1]
- easeExpand - function which generates a value between [0 and 1]
- collapsed - start in collapsed mode
- irreversible - you can't reverse direction during movement
- noDisplayStyle - skip adding display:none on collapsed
- noOverflowHidden - skip adding overflow:hidden on the collapsible element
- bestPerformance - don't apply setState for every frame update. Disables range and progress update
- whenReversedUseBackwardEase - play backwards on reverse toggling
- interpolateOnReverse - avoid jumpy height changes when easeCollapse and easeExpand gives far different height position on reverse toggling.
- onExpanded - event hook
- onExpanding - event hook
- onCollapsed - event hook
- onCollapsing - event hook
- onMount - event hook
- onUnmount - event hook
- render - render callback
- children - render callback
- offsetHeight - use offsetHeight HTML element calculation
- expandEvent - update value to `Date.now()` to invoke a controlled expand
- collapseEvent - update value to `Date.now()` to invoke a controlled collapse
- toggleEvent - update value to `Date.now()` to invoke a controlled toggle
## cdn
https://unpkg.com/react-slide-toggle/
```html
<script>
<script>
var SlideToggle = window.ReactSlideToggle;
```
## npm
https://www.npmjs.com/package/react-slide-toggle
## provide your own markup
The component provides the functionality.
Minimum requirement is to bind the collapsible element with `setCollapsibleElement`.
Use the `toggle` function to toggle the collapsible element.
## provide your own easing functions
Look for examples in the App component
```js
import eases from "eases";
import BezierEasing from "bezier-easing";
```
To minimize the component size, no default easing library has been added.
You can see examples of JS-easing library usage here
- eases https://codepen.io/kunukn/full/mpVJOm/
- BezierEasing https://codepen.io/kunukn/full/YYNqyj/
## design goals
- flexible - provide your own markup, styling and easing
- interruptible - can be reversed during movement
- simple api with event hooks
- inert - when collapsed you should tab over the collapsed component
- minimal in size
- availability - from cdn or npm install
- generate range and progress [0;1] values which can be used for further custom animation
- JS is used over CSS transition on purpose to enable possible interpolation or other custom math calculations
## library implementation details
- Used life-cycle are `componentWillUnmount` and `render`
- Extends `React.Component`
- Uses `setState`
## local development
- git clone or download
- npm install
- npm run build
- The build files are now in the dist folder