# react-reslide

> A react slider component

Latest version **0.0.2** (published 2017-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-reslide
pnpm add react-reslide
yarn add react-reslide
bun add react-reslide
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-10-17 |
| First published | 2017-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Markus Willems |
| Maintainers | mrkswllms |
| Keywords | slider, slideshow, react |

## Links

- npm: https://www.npmjs.com/package/react-reslide
- Repository: https://github.com/markus-willems/react-reslide
- Issues: https://github.com/markus-willems/react-reslide/issues
- npm.io page: https://npm.io/package/react-reslide

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2017-10-17
- 0.0.1 — 2017-10-15

## README

# react-reslide

A slider component for React. Click [here](https://taboo-trucks.surge.sh/) for a demo.

## Installation

### npm

```sh
npm install react-reslide --save
```

### yarn

```sh
yarn add react-reslide
```

## Usage

### Basic 

```jsx
import React from 'react'
import { render } from 'react-dom'

import {
  Reslide,
  Slides,
  Slide,
  Controls,
  PrevButton,
  NextButton
} from 'react-reslide'

const App = () => {
  return (
    <Reslide>
      <Slides>
        <Slide>
          <img src="https://farm9.staticflickr.com/8666/15944458013_1a100cc8e0_z_d.jpg" />
        </Slide>
        <Slide>
          <img src="https://farm2.staticflickr.com/1069/1243141435_eb6bf658f4_z_d.jpg" />
        </Slide>
        <Slide>
          <img src="https://farm9.staticflickr.com/8068/8243640236_72bf897740_z_d.jpg" />
        </Slide>
      </Slides>
      <Controls>
        <PrevButton />
        <NextButton />
      </Controls>
    </Reslide>
  )
}

render(<App />, document.getElementById('root'))
```

### Render props

```Slide```, ```PrevButton```, and ```NextButton``` accept a [render prop](https://cdb.reacttraining.com/use-a-render-prop-50de598f11ce) which grands access to the component's props. This allows for more control on how ```children``` is rendered.

```jsx
import React from 'react'
import { render } from 'react-dom'

import {
  Reslide,
  Slides,
  Slide,
  Controls,
  PrevButton,
  NextButton
} from 'react-reslide'

const App = () => {
  return (
    <Reslide>
      <Slides>
        <Slide>
          <img src="https://farm9.staticflickr.com/8666/15944458013_1a100cc8e0_z_d.jpg" />
        </Slide>
        <Slide>
          <img src="https://farm2.staticflickr.com/1069/1243141435_eb6bf658f4_z_d.jpg" />
        </Slide>
        <Slide
          render={{ children, preloadContent, isActive } => {
            return preloadContent ? (
              <div
                style={{
                  display: isActive ? 'block' : 'none'
                }}
              >
                {children}
              </div>
            ) : isActive ? (
              <div>{children}</div>
            ) : null
          }}
        >
          <img src="https://farm9.staticflickr.com/8068/8243640236_72bf897740_z_d.jpg" />
        </Slide>
      </Slides>
      <Controls>
        <PrevButton
          render={{ children, slide, isDisabled } => {
            return (
              <button
                disabled={isDisbaled}
                onClick={!isDisbaled ? () => slide() : null}
              >
                {children}
              </button>
            )
          }}
        >
          Prev
        </PrevButton>
        <NextButton>Next</NextButton>
      </Controls>
    </Reslide>
  )
}

render(<App />, document.getElementById('root'))
```

## API

### ```Reslide```

Root component that wraps ```Slides``` and ```Controls```.

Props:

```className``` (*string*): Set ```className``` of underlying div.

```preloadContent``` (*bool*): If ```false```, content of ```Slide``` will load/render when ```isActive``` is ```true```. If true, set ```display``` to either ```none``` (```isActive``` is ```false```) or ```block``` (```isActive``` is ```true```).

---

### ```Slides```

Wraps ```Slide```.

---

### ```Slide```

Wraps ```children``` (e.g. text, images, or other components).

Props:

```className``` (*string*): Set ```className``` of underlying div.

```preloadContent``` (*bool*): Prop passed through from ```Reslide```.

```isActive``` (*bool*): Whether ```Slide``` is active (```true```) or not (```false```).

```render``` (*func*): Render prop.

---

### ```Controls```

Wraps ```PrevButton``` and ```NextButton```.

Props:

```className``` (*string*): Set ```className``` of underlying div.

---

### ```PrevButton```

Shows previous ```Slide``` (if available) when clicked.

Props:

```slide``` (*func*): Shows previous ```Slide``` when called.

```isDisabled``` (*bool*): Is ```true``` when there is no previous ```Slide```.

```render``` (*func*): Render prop.

---

### ```NextButton```

Shows next ```Slide``` (if available) when clicked.

Props:

```slide``` (*func*): Shows next ```Slide``` when called.

```isDisabled``` (*bool*): Is ```true``` when there is no next ```Slide```.

```render``` (*func*): Render prop.

---
_Source: https://npm.io/package/react-reslide · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._