Giter VIP home page Giter VIP logo

react-awesome-component-carousel's Introduction

โš™๏ธ React Awesome Component Viewer ๐ŸŒˆ

react-awesome-component-carousel is a library that allows you to easily add a viewer for your components that transition between one another. The two available transition modes are fade and slide.

Installation

npm install --save react-awesome-component-carousel

Examples

Slide

Fade

Basic use

import React from 'react';
import ComponentCarousel from 'react-awesome-component-carousel';

const component1 = () => (
  <div style={{backgroundColor: '#fd3164', height:  '100vh', width: '100vw'}}>
    <h1>Slide 1</h1>
  </div>
);
const component2 = () => (
  <div style={{backgroundColor: '#80a5fd', height:  '100vh', width: '100vw'}}>
    <h1>Slide 2</h1>
  </div>
);
const component3 = () => (
  <div style={{backgroundColor: '#1ccb9e', height:  '100vh', width: '100vw'}}>
    <h1>Slide 3</h1>
  </div>
);

const components = [component1, component2, component3];

export default class App extends React.Component {
  render() {
    return (
      <div style={{ width: '100vw', height: '100vh', position: 'relative', overflow: 'hidden' }}>
        <ComponentCarousel
          transition={'slide'}
          transitionDuration={0.3}
          auto
          autoDuration={3}
          coolOff={6}
          components={components}
        />
      </div>
    );
  }
}

auto: false, autoDuration: 3, disableButtons: false, components: [], coolOff: 6, transition: slide, transitionDuration: 0.3,

ComponentViewer

Props

Summary

Name Type Description Default value
auto boolean This determines whether or not the images transition automatically false
autoDuration number (seconds) This sets the duration of when to automatically transition to the next image 3
components array This should be an array of components []
coolOff number (seconds) This is the duration for how long an image pauses before resuming the auto image transition when the next or previous buttons are clicked 6
disableButtons boolean This will remove the previous and next buttons false
dots boolean This will add click-able dots to the bottom of the slider to allow the user to navigate the slides false
customPrevButton component This will remove the default left button and use a your custom component, an onClick prop will be passed in undefined
customNextButton component This will remove the default right button and use a your custom component, an onClick prop will be passed in undefined
transition string This can either be set to 'fade' or 'slide' which will set the transition type of the images 'slide'
transitionDuration number (seconds) This is the duration of the transition 0.3

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.