SMcDick / react-insta-stories

A React component for Instagram like stories

Home Page:https://mohitk05.github.io/react-insta-stories/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

react-insta-stories

A React component for Instagram like stories

NPM JavaScript Style Guide

Install

npm install --save react-insta-stories

Demo

The component responds to actions like tap on right side for next story, on left for previous and tap and hold for pause. Custom time duration for each story can be provided. See it in action here: https://mohitk05.github.io/react-insta-stories/

Usage

import React, { Component } from 'react'

import Stories from 'react-insta-stories'

class App extends Component {
  render () {
    return (
      <Stories 
        stories={stories}
        defaultInterval={1500}
        loader={<div>Loading...</div>}
        width={432}
        height={768}
      />
    )
  }
}

const stories = [
  'https://i.imgur.com/YA4fraZ.png', 
  'https://i.imgur.com/Ik635gD.jpg', 
  { url: 'https://i.imgur.com/mDuSAmB.png', duration: 1500 }, 'https://www.jlstms.com/data/wallpapers/54/im58571310.jpg',
  'https://i.imgur.com/YA4fraZ.png'
]

Props

Property Type Default Description
stories [String/Object] required An array of image urls ['https://i.imgur.com/YA4fraZ.png', 'https://i.imgur.com/Ik635gD.jpg'] or array of story objects [{ url: 'https://i.imgur.com/mDuSAmB.png', duration: 1500 }, { url: 'https://i.imgur.com/YA4fraZ.png', duration: 1000 }]
defaultInterval Number 1200 Milliseconds duration for which a story persists
loader Component 'Loading..' A loader component as a fallback until image loads from url
width Number 360 Width of the component in pixels
height Number 640 Height of the component in pixels

License

MIT © mohitk05

About

A React component for Instagram like stories

https://mohitk05.github.io/react-insta-stories/

License:MIT License


Languages

Language:JavaScript 86.4%Language:HTML 7.2%Language:CSS 6.4%