0.2.1 • Published 3 years ago

react-surfer-slider v0.2.1

Weekly downloads
8
License
MIT
Repository
github
Last release
3 years ago

react-surfer-slider

Photo slider component with animated caption for React

Check examples

Installation

npm install --save react-surfer-slider

or

yarn add react-surfer-slider

Usage

import SurferSlider, { Slide } from 'react-surfer-slider'
import 'react-surfer-slider/dist/ReactSurferSlider.css'

<SurferSlider ratio={{width: 16, height: 9}} duration={6000}>
    <Slide caption="Every golfer loves knocking back a cold one during a round. But should you do it?">
        <a href="https://placedog.net/1024/768?id=7" target="_blank" rel="noopener noreferrer">
            <img
                src="https://placedog.net/1024/768?id=7"
                srcSet="https://placedog.net/480/360?id=7 480w, https://placedog.net/800/600?id=7 800w"
                alt="react-surfer-slider image"
            />
        </a>
    </Slide>
    <Slide caption="Tides are the rise and fall of sea levels caused by the combined effects of the gravitational forces">
        <a href="https://placedog.net/1024/768?id=118" target="_blank" rel="noopener noreferrer">
            <img
                src="https://placedog.net/1024/768?id=118"
                srcSet="https://placedog.net/480/360?id=118 480w, https://placedog.net/800/600?id=118 800w"
                alt="react-surfer-slider image"
            />
        </a>
    </Slide>
    <Slide caption="Freedom, generally, is having the ability to act or change without constraint">
        <a href="https://placedog.net/1024/768?id=140" target="_blank" rel="noopener noreferrer">
            <img
                src="https://placedog.net/1024/768?id=140"
                srcSet="https://placedog.net/480/360?id=140 480w, https://placedog.net/800/600?id=140 800w"
                alt="react-surfer-slider image"
            />
        </a>
    </Slide>
</SurferSlider>

Props

NameTypeDefaultDescription
durationnumber6000Slide duration in milliseconds
ratioobject{width: 16, height: 9}Slider aspect ratio
<!--captionWidthsarray[{ minWidth: 0, captionWidth: 1 }, { minWidth: 420, captionWidth: .7 }]Responsive caption width in percentage of slider width (0 - 1)-->

Run examples locally

npm install
npm run dev