1.0.1 • Published 4 years ago

beautiful-react-news-ticker v1.0.1

Weekly downloads
6
License
ISC
Repository
github
Last release
4 years ago

beautiful-react-news-ticker

Install

Download

CDN

Link directly to Flickity files on unpkg.

<script src="https://unpkg.com/flickity@2/dist/flickity.pkgd.min.js"></script>

Usage

Flickity works with a container element and a set of child cell elements

import BeautifulReactNewsTicker from 'beautiful-react-news-ticker'
<BeautifulReactNewsTicker className="row">          
  <div className="slide"><img style={{maxWidth: '100%'}} src="http://localhost:4002/img/neighborhoods/Park_Slope_BKLN-min.png"/></div>
  <div className="slide"><img style={{maxWidth: '100%'}} src="http://localhost:4002/img/neighborhoods/Park_Slope_BKLN-min.png"/></div>
  <div className="slide"><img style={{maxWidth: '100%'}} src="http://localhost:4002/img/neighborhoods/Park_Slope_BKLN-min.png"/></div>
  <div className="slide"><img style={{maxWidth: '100%'}} src="http://localhost:4002/img/neighborhoods/Park_Slope_BKLN-min.png"/></div>
  ...
</BeautifulReactNewsTicker>

Options

var flky = new Flickity( '.gallery', {
  // options, defaults listed

  accessibility: true,
  // enable keyboard navigation, pressing left & right keys

  adaptiveHeight: false,
  // set carousel height to the selected slide

  autoPlay: false,
  // advances to the next cell
  // if true, default is 3 seconds
  // or set time between advances in milliseconds
  // i.e. `autoPlay: 1000` will advance every 1 second

  cellAlign: 'center',
  // alignment of cells, 'center', 'left', or 'right'
  // or a decimal 0-1, 0 is beginning (left) of container, 1 is end (right)

  cellSelector: undefined,
  // specify selector for cell elements

  contain: false,
  // will contain cells to container
  // so no excess scroll at beginning or end
  // has no effect if wrapAround is enabled

  draggable: '>1',
  // enables dragging & flicking
  // if at least 2 cells

  dragThreshold: 3,
  // number of pixels a user must scroll horizontally to start dragging
  // increase to allow more room for vertical scroll for touch devices

  freeScroll: false,
  // enables content to be freely scrolled and flicked
  // without aligning cells

  friction: 0.2,
  // smaller number = easier to flick farther

  groupCells: false,
  // group cells together in slides

  initialIndex: 0,
  // zero-based index of the initial selected cell

  lazyLoad: true,
  // enable lazy-loading images
  // set img data-flickity-lazyload="src.jpg"
  // set to number to load images adjacent cells

  percentPosition: true,
  // sets positioning in percent values, rather than pixels
  // Enable if items have percent widths
  // Disable if items have pixel widths, like images

  prevNextButtons: true,
  // creates and enables buttons to click to previous & next cells

  pageDots: true,
  // create and enable page dots

  resize: true,
  // listens to window resize events to adjust size & positions

  rightToLeft: false,
  // enables right-to-left layout

  setGallerySize: true,
  // sets the height of gallery
  // disable if gallery already has height set with CSS

  watchCSS: false,
  // watches the content of :after of the element
  // activates if #element:after { content: 'flickity' }

  wrapAround: false
  // at end of cells, wraps-around to first for infinite scrolling

});

By Kunal Malviya