1.2.2 • Published 4 years ago

react-magic-slider-dots v1.2.2

Weekly downloads
1,606
License
MIT
Repository
github
Last release
4 years ago

react-magic-slider-dots

React Magic Slider Dots Component for React Slick Carousel

Inspired by Instagram

NPM JavaScript Style Guide

screenshot

Install

npm install --save react-magic-slider-dots

⚠️ Also install react-slick and slick-carousel for css and font React Slick Documentation

npm install slick-carousel
npm install react-slick --save
import "slick-carousel/slick/slick.css";
import "slick-carousel/slick/slick-theme.css";

DEMO

Usage

import React, { Component } from 'react';
import Slider from 'react-slick';
import 'slick-carousel/slick/slick.css';
import 'slick-carousel/slick/slick-theme.css';

import MagicSliderDots from 'react-magic-slider-dots';
import 'react-magic-slider-dots/dist/magic-dots.css';

class App extends Component {
  render() {
    const settings = {
      dots: true,
      arrows: true,
      infinite: false,
      speed: 500,
      slidesToShow: 1,
      slidesToScroll: 1,
      appendDots: dots => {
        return <MagicSliderDots dots={dots} numDotsToShow={4} dotWidth={30} />;
      }
    };

    return (
      <Slider {...settings}>
        <div>
          <h3>1</h3>
        </div>
        <div>
          <h3>2</h3>
        </div>
        <div>
          <h3>3</h3>
        </div>
        <div>
          <h3>4</h3>
        </div>
        <div>
          <h3>5</h3>
        </div>
        <div>
          <h3>6</h3>
        </div>
        <div>
          <h3>7</h3>
        </div>
        <div>
          <h3>8</h3>
        </div>
      </Slider>
    );
  }
}

API

This a list of props that you can pass down to the component:

PropertyDescriptionDefault valueTypeRequired
dotsarray of HTML li elements representing the slider dotarrayyes
numDotsToShownumber of slider dots to shownumberyes
dotWidthwidth, in pixels, of a slider dot including any margins/paddingnumberyes
dotContainerClassNameclass name of parent divmagic-dots slick-dotsstring
activeDotClassNameclass name of active slider dotslick-activestring
prevNextDotClassNameclass name of left-most (prev) and right-most (next) slider dot.smallstring

License

MIT © patricktran