Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davedbase/solid-slider

A carousel/slider implementation for SolidJS.
https://github.com/davedbase/solid-slider

Last synced: 7 days ago
JSON representation

A carousel/slider implementation for SolidJS.

Awesome Lists containing this project

README 

        
# Solid Slider



[![size](https://img.shields.io/bundlephobia/minzip/solid-slider?style=for-the-badge)](https://bundlephobia.com/package/solid-slider)

[![size](https://img.shields.io/npm/v/solid-slider?style=for-the-badge)](https://www.npmjs.com/package/solid-slider)

![npm](https://img.shields.io/npm/dw/solid-slider?style=for-the-badge)



A carousel/slider implementation in TypeScript for [Solid](https://www.solidjs.com). It's built on Keen-Slider 6, an open-source library agnostic touch slider with native touch/swipe behavior and great performance. It comes with no dependencies, TypeScript support, multitouch support and is compatible with all common browsers.



This package providers both primitive & directive as well as components. You may use either according to your preference. Note that for better SSR support, the component is recommended over the directive.



## Installation



```bash

## npm

npm install solid-slider

## bun

bun add solid-slider

## yarn

yarn add solid-slider

## pnpm

pnpm add solid-slider

```



Import either the directive or component as you'd like:



```ts

import { Slider, createSlider } from "solid-slider";

import "solid-slider/slider.css";

```



## Demo



You can find a functional demo of the slider with most features implemented here: https://codesandbox.io/s/solid-slider-j0x2g



## Plugins



Plugins may be added directly via the createSlider primitive. You may add a Keen-Slider plugin directly or built-in plugins shipped with this package. Currently an autoplay plugin is available that will assist with autoplaying actions in the slider. Simply add the plugins after the options parameter. Please feel free to post requests for additional plugins or submit PRs if you decide to improve the base functionality. Some ideas for additional plugins include:



- Slider nav (dot, arrow controls even thumbnails)

- Lazy loaded images

- Slide transitions



Details on applying plugins are available for each use below.



## Use as Component



The following is an example of how to use the component.



```tsx

const MyComponent = () => {

  return (

    

      
Slide 1


      
Slide 2


      
Slide 3


    

  );

};

```



You may also use the next and previous button. Note that you must wrap your `Slider` with `SliderProvider`.



```tsx

const MyComponent = () => {

  return (

    

      

        
Slide 1


        
Slide 2


        
Slide 3


      

      Previous

      Next

    

  );

};

```



### Autoplay Plugin



You may include the autoplay plugin by providing it as a prop:



```tsx

import createSlider from "solid-slider";

import autoplay from "solid-slider/plugins/autoplay";



const MyComponent = () => {

  return (

    

      
1


      
2


      
3


      
4


      
5


      
6


    

  );

};

```



### Adaptive Height Plugin



You may include the adaptive height plugin by providing it as a prop:



```tsx

import createSlider from "solid-slider";

import autoplay from "solid-slider/plugins/adaptiveHeight";



const MyComponent = () => {

  return (

    

      
1


      
2


      
3


    

  );

};

```



### Adaptive Width Plugin



You may include the adaptive width plugin by providing it as a prop:



```tsx

import { createSlider } from "solid-slider";

import { autoplay } from "solid-slider/plugins/adaptiveWidth";



const MyComponent = () => {

  return (

    

      
1


      
2


      
3


    

  );

};

```



## Use as Primitive



The following is an example of how to create and then bind options using a directive.



```tsx

const MyComponent = () => {

  const options = { duration: 1000 };

  const [slider, { current, next, prev, moveTo }] = createSlider(options);

  return (

    


      
Slide 1


      
Slide 2


      
Slide 3


    


  );

};

```



or without a directive:



```tsx

const MyComponent = () => {

  let ref: HTMLElement;

  const options = { duration: 1000 };

  const [slider, { current, next, prev, moveTo }] = createSlider(options);

  onMount(() => {

    slider(ref);

  });

  return (

    


      
Slide 1


      
Slide 2


      
Slide 3


    


  );

};

```



The primitive itself returns the following shape:



```ts

type SliderControls = [

  create: (el: HTMLElement) => void,

  helpers: {

    current: Accessor;

    next: VoidFunction;

    prev: VoidFunction;

    moveTo: (id: number, duration?: number, absolute?: boolean, easing?: (t: number) => number) => void;

    details: () => TrackDetails;

    slider: () => KeenSliderInstance | undefined;

    destroy: VoidFunction;

    update: VoidFunction;

  },

];

```



Note that only the `current` property returned from the primitive is reactive. If you require additional reactivity on slide change you can use the returns slider instance to bind additional events.



### Autoplay



The autoplay function extends the slider with pausable playing. You can even supply a signal to control toggling autoplay. [Click here](https://codesandbox.io/s/solid-slider-autoplay-plugin-h2wphk?file=/src/index.tsx) for a demo of autoplay.



```ts

import { createSlider } from "solid-slider";

import { autoplay } from "solid-slider/plugins/autoplay";



const [pause, togglePause] = createSignal(false);

const [slider] = createSlider(

  { loop: true },

  autoplay(2000, {

    pause,

    pauseOnDrag: true,

  }),

);

```



## SolidStart & Server-Side Rendering



So you want to use Solid Slider with [SolidStart](https://start.solidjs.com/). No problem but be mindful of how you use it and how server-side rendering impacts the experience. Remember that by default SolidStart enables SSR meaning that your pages are initially rendered on the server. The server has no context of the dimensions of your browser so it cannot calculate how the slider will appear once it's rendered in the browser.



Furthermore there's typically a small window of window between when the slider is sent to the browser and the moment it hydrates and becomes interactive. Given this is how all frameworks operate you're likely to experience the dreaded FOUC (flash of un-styled content).



To mitigate this issue you have two options available. You could add CSS styles (`visibility: hidden` or `hidden` in Tailwind) to hide the content and use the `created` callback in options to remove it from the slider once it's been created on the page. You could also initially style your slider correctly so it doesn't flash at all.



Alternatively you can use [`clientOnly`](https://docs.solidjs.com/solid-start/reference/client/client-only#clientonly) to ensure it isn't part of the SSR process. This is a bit lazy and not ideal in situations where you want content on your page to render for SEO purposes.



## Implementation



Solid Slider is meant to be a lightweight and compact wrapper of Keen-Slider. It exposes helpers to make working with the slider convenient. Note that the when the slider mounts it assumes all children in the el are slides. You can override this functionality by passing in a "selector" value to target the specific slides you'd like to include.



Thie library exports it's own CSS which is the basic Keen-Slider implementation for convenience. If you supply options as an accessor function, the slider will reactively update the configuration so that you don't have to destroy and recreate the slider. As of Keen-Slider 6 plugins are now fully supported. You may supply them as a param in createSlider. Note that plugins are not reactively updated and must be supplied on creation.



## Roadmap



- [x] Create [adaptiveHeight](https://codesandbox.io/s/github/rcbyr/keen-slider-sandboxes/tree/v6/misc/adaptive-height/react?file=/src/App.js:191-403) plugin

- [x] Create [adaptiveWidth](https://github.com/joeygrable94/solid-slider) plugin

- [ ] Add Dots components (to display a row of dots below the slider)

- [ ] Add slider thumbnail navigation

- [ ] Add slider loader

- [ ] Build [timepicker](https://keen-slider.io/examples#timepicker) component

- [ ] Create [Scroll Wheel](https://keen-slider.io/examples#scroll-wheel-controls) component



## Changelog



- 1.0.0 - Initial release

- 1.0.3 - Changed the exported API to be slightly more flexible.

- 1.1.1 - Upgraded to Keen-Slider 6 and improved general reactivity.

- 1.2.5 - Added autoplay plugin and general plugin structure.

- 1.2.7 - Maybe I should actually export the .css? That'd be a good idea, right? /s

- 1.2.9 - Updated timer primitive and patched issue with current slide setting from initial options.

- 1.3.1 - Introduced Slider, SliderProvider and SliderButton for ease.

- 1.3.2 - Patched issue with initial slide not setting current signal.

- 1.3.5 - Updated to latest SolidJS version.

- 1.3.7 - Fixed TS issues updated to latest KeenSlider.

- 1.3.8 - Updated to Solid 1.5

- 1.3.9 - Fixed Keen URLs, type issues and truthy error with autoplay (thanks [ishanAhuja](https://www.github.com/ishanAhuja) and [ahhshm](https://www.github.com/ahhshm))

- 1.3.11 - Upgraded importance dependencies including Solid 1.6

- 1.3.12 - Patched slider to reactively update on updating children

- 1.3.13 - Incorporated adaptiveHeight plugin (thanks [joeygrable94](https://www.github.com/joeygrable94))

- 1.3.14 - Patched npm packaging issue (thanks [joeygrable94 ](https://www.github.com/joeygrable94))

- 1.3.15 - Updated to Solid 1.7.11

- 1.3.16 - Updated dependencies and move Solid from dependency to peer

- 1.3.17 - Added typs definition to exports (thanks [ChristophP](https://github.com/ChristophP))

- 1.3.18 - Adjusted documentation and minor source cleanup



## Keen Options API



You can set options to the slider via parameters. Note that there are other hooks available as well. Only a subset of useful methods are exposed via the primitive although you can access the slider instance as well from the exports to use the methods directly.



- [Options](https://keen-slider.io/docs#options)

- [Event Hooks](https://keen-slider.io/docs#event-hooks)

- [Methods](https://keen-slider.io/docs#methods)