search

kevinfarrugia / react-glider

A ReactJS wrapper for Glider.js
https://react-glider.vercel.app/
MIT License
208 stars 42 forks source link
component glider react

readme

build

react-glider

A ReactJS wrapper for Glider.js.

Demo | Code Sandbox

Quick Start

Installation:

npm i -s react-glider

Usage

import * as React from 'react';

import Glider from 'react-glider';
import 'glider-js/glider.min.css';
<Glider
  draggable
  hasArrows
  hasDots
  slidesToShow={2}
  slidesToScroll={1}
>
  <div>1</div>
  <div>2</div>
  <div>3</div>
  <div>4</div>
  <div>5</div>
</Glider>

CSS

To use the CSS for Glider.js, you may import it from the npm module:

import "glider-js/glider.min.css";

or reference the CSS file in your <head> (not recommended):

<link
  rel="stylesheet"
  href="https://unpkg.com/glider-js@1.7.7/glider.min.css"
/>

Demo Defaults

This package also exposes the CSS used to render the demo which may also be imported as follows.

Note that this file is no longer maintained.

import Glider from "react-glider/glider.defaults.css";

Options

Option Description
hasArrows Show/hide arrows. (default = false)
hasDots Show/hide dots. (default = false)
iconLeft ReactNode for the left arrow. (default = '«')
iconRight ReactNode for the right arrow. (default = '»')
scrollToSlide Starting slide (default = 0)
scrollToPage Starting page (default = 0)
slidesToShow The number of slides to show in container. If this value is set to auto, it will be automatically calculated based upon the number of items able to fit within the container viewport. This requires setting the itemWidth option.
slidesToScroll The number of slides to scroll when arrow navigation is used. If this value is set to auto, it will match the value of slidesToScroll.
itemWidth This value is ignored unless slidesToShow is set to auto, in which it is then required.
exactWidth This prevents resizing items to fit when slidesToShow is set to auto.
resizeLock If true, Glider.js will lock to the nearest slide on resizing of the window
rewind If true, Glider.js will scroll to the beginning/end when its respective endpoint is reached
duration An aggravator used to control animation speed. Higher is slower. (default = 0.5)
dots A string containing the dot container selector
arrows An object containing the prev/next arrows selectors
draggable If true, the list can be scrolled by click and dragging with the mouse. (default = false)
dragVelocity How much to aggravate the velocity of the mouse dragging. (default = 3.3)
scrollPropagate Whether or not to release the scroll events from the container. (default = true)
propagateEvent Whether or not Glider.js events should bubble (useful for binding events to all carousels). (default = false)
scrollLock If true, Glider.js will scroll to the nearest slide after any scroll interactions. (default = false)
skipTrack Whether or not Glider.js should skip wrapping its children with a 'glider-track' <div>. NOTE: If true, Glider.js will assume that the 'glider-track' element has been added manually. All slides must be children of the track element. (default = false)
scrollLockDelay How long (ms) to wait after scroll event before locking, if too low, it might interrupt normal scrolling. (default = 250)
responsive An object containing custom settings per provided breakpoint. Glider.js breakpoints are mobile-first, be conscious of your ordering. Supported responsive settings are slidesToShow, slidesToScroll, itemWidth, and duration.
containerElement Replace container HTML element.
easing Use any custom easing function, compatible with most easing plugins.

Arrows

If the Glider component should display arrows, you can configure these using the arrows prop.

Selectors

The arrows prop supports an object containing left and right CSS selectors.

arrows={{
  prev: '#buttonPrev',
  next: '#buttonNext',
}}

Note that if you have multiple Glider elements on the same page, you need to assign a different CSS selector to each Glider.

Elements

The arrows prop supports an object containing left and right references to an HTML element.

When using native HTML elements:

arrows={{
  prev: document.getElementById("prev"),
  next: document.getElementById("next")
}}

When using React.useRef:

arrows={{
  prev: leftArrowEl.current,
  next: rightArrowEl.current,
}}

Note that React.useRef will assign a value to current after the component has rendered. This means that on the first render, current is null.

Responsive mode

You can set different settings for different viewport widths.

<Glider
  slidesToShow={1}
  scrollLock
  responsive={[
    {
      breakpoint: 864,
      settings: {
        slidesToShow: 3,
      },
    },
  ]}
>
  {* ... *}
</Glider>

Note that React Glider is designed to be mobile-first, so the order of your breakpoints should be small-to-large.

Container element

If you would like to use a custom element or React component as the parent for your slides, you can use the containerElement property.

function ContainerElement({ children }) {
  return <div className={styles.glider}>{children}</div>;
}

function MyComponent() {
  return <Glider
    slidesToShow={1}
    containerElement={ContainerElement}
  >
    {* ... *}
  </Glider>
}

Events

Event Description
onLoad Called after Glider component is initialized.
onAnimated Called whenever a Glider.js paging animation is complete
onRemove Called whenever a Glider.js animation is complete
onSlideVisible Called whenever a slide a shown. Passed an object containing the slide index
onRefresh Called whenever Glider.js refreshes it's elements or settings
onAdd Called whenever an item is added to Glider.js
onDestroy Called whenever a Glider.js is destroyed
onSlideHidden Called whenever a slide a hidden. Passed an object containing the slide index

Glider Methods

To get access to the current glider instance this react component exposes a ref.

function Example() {
  const gliderRef = React.useRef<GliderMethods>(null);
  return (
    <div>
      <button
        type="button"
        onClick={() => {
          const random = Math.floor(Math.random() * 12);
          gliderRef.current?.scrollItem(random);
        }}
      >
        Scroll to random item
      </button>
      <Glider
        className="glider-container"
        draggable
        hasDots
        slidesToShow={1}
        scrollLock
        ref={gliderRef}
      >
        <div>
          <span>1</span>
        </div>
      </Glider>
    </div>
  );
}

Perspective View

The CSS for the perspective view is not included in Glider.js or this package. You can find it in perspective.css. Please do not file bugs for it as I do not want to support it.

Examples

You may view the examples used in the docs page in the ./examples directory.

FAQs

Can I replace react-slick with react-glider?

If you are interested in migrating from react-slick, please note that react-glider only includes a subset of the features available in react-slick. Most notably, react-glider doesn't include variable width or custom transitions, while autoplay must be handled by you. If you are using react-slick as a carousel to list elements, react-slick probably includes more features than you need. In such cases, replacing it with react-glider would reduce the JavaScript KBs while providing your users with a jank-free experience.

How can I remove the ESLint warning import/no-extraneous-dependencies?

import/no-extraneous-dependencies requires that all dependencies are included in the project's package.json file. Since the CSS file is generated by glider-js, it will not be listed in your package.json file. The preferred option would be to create a local CSS file containing the glider.css file's contents. Alternatively, you may disable the eslint warning for that line. We do not recommend installing glider-js as a dependency in your package as you would then be responsible for maintaining the glider-js and react-glider dependencies in your project.

Can I customize the appearance of the dots/pagination elements?

You may customize the dots by overriding the CSS for .glider-dots and glider-dot.

Alternatively, you may pass a CSS selector to the dots property to assign a DOM element as the container for the Glider's pagination. This allows you to override the CSS for .glider-dots using CSS specificity.

.my-dots-container.glider-dots {
  /* ... */
}

This is also possible when using CSS modules and allows you to have multiple Glider components on the same page, each with different styles.

<div className={styles.banner}>
  <Glider
    dots={`.${style.dots}`}
    slidesToShow={1}
  >
    {* ... *}
  </Glider>
  <div className={style.dots} />
</div>

Can I lazyload images on inactive slides?

The recommended approach for lazy loading images is to use the browser's loading="lazy" implementation. You can use the slide's index to know which images should have the attribute set.

Which browsers are supported?

As react-glider is a wrapper for Glider.js, it should run on all modern browsers. Support for older browsers can be achieved by polyfilling document.classList, window.requestAnimationFrame, Object.assign and CustomEvent.

Developing

yarn
yarn dev

License and Copyright

This software is released under the terms of the MIT license.