vue-tiny-slider

tiny-slider 2.0 for Vue

Wrapper for Tiny slider for all purposes by ganlanyuan in Vue. Live demo →

Table of Contents

• Compatibility
• Install
• Use
• Styling
• Options
• Methods
  • How to use the methods
• Nuxt 3 SSR
• Todos
• Collaborators
• License
• Cheerios <3

Compatibility

If you're on Vue 2, pin to vue-tiny-slider@^0.1.

Install

npm install vue-tiny-slider

Use

Globally (Vue 3):

import { createApp } from 'vue';
import VueTinySlider from 'vue-tiny-slider';
import App from './App.vue';

createApp(App)
  .component('tiny-slider', VueTinySlider)
  .mount('#app');

Or locally inside a single component:

import VueTinySlider from 'vue-tiny-slider';

export default {
  components: { 'tiny-slider': VueTinySlider }
}

<tiny-slider :mouse-drag="true" :loop="false" items="2" gutter="20">
  <div>Slider item #1</div>
  <div>Slider item #2</div>
  <div>Slider item #3</div>
  <div>Slider item #4</div>
  <div>Slider item #5</div>
  <div>Slider item #6</div>
</tiny-slider>

Styling

SCSS

@import 'tiny-slider/src/tiny-slider';

CDN

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/tiny-slider/2.9.1/tiny-slider.css">

Options

auto-init
items
mode
gutter
edge-padding
fixed-width
slide-by
controls
controls-text
controls-container
nav
nav-container
arrow-keys
speed
autoplay
autoplay-timeout
autoplay-direction
autoplay-text
autoplay-hover-pause
autoplay-button
autoplay-button-output
autoplay-reset-on-visibility
animate-in
animate-out
animate-normal
animate-delay
loop
rewind
auto-height
responsive
lazyload
touch
mouse-drag
nested
freezable
disable
on-init
center
lazy-load-selector
prevent-action-when-running
prevent-scroll-on-touch
nav-options
auto-width

For more detailed information about the options, see the Tiny-slider documentation (Options).

Methods

getInfo goTo destroy

How to use the methods

To be able to use the methods, you need to use ref on the component. Ref is used to register a reference to an element or a child component.

<vue-tiny-slider ref="tinySlider"></vue-tiny-slider>

import VueTinySlider from 'vue-tiny-slider';

export default {
  ...,
    methods: {
        getInfo: function(event) {
             this.$refs.tinySlider.slider.getInfo();
        }
     }
}

For more detailed information about the methods, see the Tiny-slider documentation (Methods).

Nuxt 3 SSR

Tiny-slider touches the DOM, so the component must only render on the client.

1. npm install vue-tiny-slider

2. Create plugins/vue-tiny-slider.client.js (the .client suffix makes it client-only):

import VueTinySlider from 'vue-tiny-slider';

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.component('VueTinySlider', VueTinySlider);
});

3. Wrap the slider in <ClientOnly> where you use it:

<ClientOnly>
  <vue-tiny-slider v-bind="tinySliderOptions">
    <div>#1</div>
    <div>#2</div>
    <div>#3</div>
  </vue-tiny-slider>
</ClientOnly>

Todo

• Add demo link from a fiddle or something similar
• Better handling of the responsive-settings
• Add Custom Events
• Add Methods

Collaborators

• Morgan Eklund
• Viktor Sarström

License

This project is available under the MIT license.

Cheerios <3

• Fixed broken demo link, @VitorLuizC
• Moved tiny-slider from devDependencies to dependencies, @TitanFighter
• Added nav position to props, @Irsanarisandy
• Got it to work with NuxtJS SSR, @ilbonte