Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbismut/react-soft-slider
Simple, fast and impartial slider
https://github.com/dbismut/react-soft-slider
carousel gesture react slider spring swipe
Last synced: 9 days ago
JSON representation
Simple, fast and impartial slider
- Host: GitHub
- URL: https://github.com/dbismut/react-soft-slider
- Owner: dbismut
- License: mit
- Created: 2019-04-21T22:14:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:52:23.000Z (almost 2 years ago)
- Last Synced: 2024-10-15T20:40:57.804Z (25 days ago)
- Topics: carousel, gesture, react, slider, spring, swipe
- Language: TypeScript
- Size: 2.94 MB
- Stars: 55
- Watchers: 3
- Forks: 4
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# react-soft-slider
  
React-soft-slider is a minimally-featured carousel. It focuses on providing the best user experience for manipulating slides. It doesn't try to implement additional features such as pagination dots, next and previous buttons, autoplay. If you're looking for a slider that has all this, there's [plenty](https://github.com/akiran/react-slick) of [alternatives](https://github.com/FormidableLabs/nuka-carousel) [out](https://github.com/express-labs/pure-react-carousel) [there](https://github.com/voronianski/react-swipe).
This allows react-soft-slider to be highly impartial when it comes to styling, so you shouldn't be fighting too hard to making the slider slider look the way you want.
- **Touch-gesture compatible:** handles swipe and drag on mobile and desktop devices
- **Spring animations:** driven by high-performance springs
- **Impartial styling:** you are responsible for the styling of your slides
- **Fully responsive:** as long as your slides styling is responsive as well!
- **Dynamic number of slides:** you can add or remove slides on the fly
React-soft-slider is powered by [react-spring](https://github.com/react-spring/react-spring) for springs animation and [react-use-gesture](https://github.com/react-spring/react-use-gesture) for handling the drag gesture.
## Installation
```
npm install react-soft-slider
```
> ⚠️ You also want to add the [intersection-observer](https://www.npmjs.com/package/intersection-observer) and [resize-observer](resize-observer-polyfill) polyfills for full browser support. Check out adding the [polyfills](#polyfills) for details about how you can include it.
## Usage
`` has a very limited logic, and essentially does two things:
1. it positions the slider to the slide matching the `index` you passed as a prop
2. when the user changes the slide, it will then fire `onIndexChange` that will pass you the new `index`. You will usually respond by updating the slider `index` prop:
```jsx
import { Slider } from 'react-soft-slider'
const slides = ['red', 'blue', 'yellow', 'orange']
const style = { width: 300, height: '100%', margin: '0 10px' }
function App() {
const [index, setIndex] = React.useState(0)
return (
{slides.map((color, i) => (
))}
)
}
```
As you can see from the example, any child of the `` component is considered as a slide. You are fully responsible for the appearance of the slides, and each slide can be styled independently.
> **Note:** although the above example uses hooks, react-soft-slider is compatible with Class-based components. However, since it internally uses hooks, it requires React `16.8+`.
### Props
The `` component accepts the following props:
| Name | Type | Description | Default Value |
| ----------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
| `children` | `node` | elements you should pass to the slider and that will be considered as slides | Required |
| `index` | `number` | the index of the slide that should be shown by the slider | Required |
| `onIndexChange()` | `(newIndex: number) => void` | function called by the slider when the slide index should change | Required |
| `indexRange` | `[number,number]` | sets the minimum and maximum index range the slider should slide through. If the maximum index is negative, then it's set relatively to the children length. [See example here](https://codesandbox.io/s/react-soft-slider-example-o7k0g). | |
| `enabled` | `boolean` | enables or disables the slider gestures | `true` |
| `vertical` | `boolean` | enables vertical sliding mode | `false` |
| `draggedScale` | `Number` | scale factor of the slides when dragged | `1.0` |
| `draggedSpring` | `object` | spring between the pointer and the dragged slide | `{ tension: 1200, friction: 40 }` |
| `trailingSpring` | `object` | spring of the other slides | `{ tension: 120, friction: 30 }` |
| `releaseSpring` | `object` | spring used when the slides rest (user releases the pointer) | `{ tension: 120, friction: 30 }` |
| `trailingDelay` | `Number` | delay of trailing slides (in ms) | `50` |
| `onDragStart()` | `(pressedIndex: number) => void` | function called when the drag starts, passing the index of the slide being dragged as an argument | |
| `onDragEnd()` | `(pressedIndex: number) => void` | function called when the drag ends, passing the index of the slide being dragged as an argument | |
| `className` | `string` | CSS class passed to the slider wrapper | |
| `style` | `object` | style passed to the slider wrapper | |
| `slideStyle` | `object` or `(i: number) => object` | style passed to the slides | |
| `slideClassName` | `string` | CSS class passed to the slides | |
| `slideAlign` | `string (align-items prop)` | slide alignment (`'center'`, `'flex-start'`, `'flex-end'`) | `'center'` |
### Springs configuration
React-soft-slider uses two springs, one for the dragged slide, and one for the other slides, that you can configure to your liking. It accepts any options supported by react-spring, including durations if you're not happy with how springs feel [see here for more info](https://www.react-spring.io/docs/hooks/api).
## Gotchas
**Sizing the slider**
The slider wrapper has a default width set to `100%`, so that it fills its container by default. You can override this behaviour by passing your own `style` or `className` props.
**Sizing your slides relatively to the slider**
If you want to size your slides relatively to the slider width (let's say `width: 80%`), you'll need to rely on `slideStyle` set to `{{ minWidth: '80%' }}` and styling your slide with `width` set to `100%`. The same logic applies for height when in vertical sliding mode.
**Don't use transform styling in slideStyle**
React-soft-slider uses the `transform` attribute to make slides move so transform attributes in `slideStyle` will get overriden.
**React-soft-slider is open to suggestions!**
React-soft-slider will probably never include slider peripheral features, but is open to suggestions to make handling your slides easier!
### Polyfills
You can import the
[IntersectionObserver polyfill](https://www.npmjs.com/package/intersection-observer) and [ResizeObserver polyfill](https://www.npmjs.com/package/resize-observer-polyfill) directly or use
a service like [polyfill.io](https://polyfill.io/v2/docs/) to add it when
needed.
```sh
yarn add intersection-observer resize-observer-polyfill
```
Then import it in your app:
```js
import 'intersection-observer'
import 'resize-observer-polyfill'
```
If you are using Webpack (or similar) you could use
[dynamic imports](https://webpack.js.org/api/module-methods/#import-), to load
the Polyfill only if needed. A basic implementation could look something like
this:
```js
/**
* Do feature detection, to figure out which polyfills needs to be imported.
**/
async function loadPolyfills() {
if (typeof window.IntersectionObserver === 'undefined') {
await import('intersection-observer')
}
if (typeof window.ResizeObserver === 'undefined') {
await import('resize-observer-polyfill')
}
}
```