Options

Embla Carousel provides a range of configuration options that let you control its behavior.

Usage

Options can be set via the constructor or as global defaults. If both are present, they're merged, and the constructor options override any conflicting global options.

Default options

Here's a list of all available options and their default values:

const defaultOptions = {  align: 'center',  axis: 'x',  container: null,  slides: null,  containScroll: 'trimSnaps',  direction: 'ltr',  slidesToScroll: 1,  inViewThreshold: 0,  breakpoints: {},  dragFree: false,  dragThreshold: 10,  loop: false,  skipSnaps: false,  duration: 25,  startIndex: 0,  active: true,  watchDrag: true,  watchResize: true,  watchSlides: true,  watchFocus: true}

Constructor options

The constructor options are the primary way to configure Embla Carousel. In the example below, the loop option is set to true:

import EmblaCarousel from 'embla-carousel'
const wrapperNode = document.querySelector('.embla')const viewportNode = wrapperNode.querySelector('.embla__viewport')
const emblaApi = EmblaCarousel(viewportNode, { loop: true })
<div class="embla">  <div class="embla__viewport">    <div class="embla__container">      <div class="embla__slide">Slide 1</div>      <div class="embla__slide">Slide 2</div>      <div class="embla__slide">Slide 3</div>    </div>  </div></div>

Global options

Setting global options applies them to all carousels, overriding Embla's default options with your own. In the example below, the loop option is set to true:

import EmblaCarousel from 'embla-carousel'
EmblaCarousel.globalOptions = { loop: true }
const wrapperNode = document.querySelector('.embla')const viewportNode = wrapperNode.querySelector('.embla__viewport')
const emblaApi = EmblaCarousel(viewportNode, { align: 'start' })
<div class="embla">  <div class="embla__viewport">    <div class="embla__container">      <div class="embla__slide">Slide 1</div>      <div class="embla__slide">Slide 2</div>      <div class="embla__slide">Slide 3</div>    </div>  </div></div>

Assign global options before initializing any carousel and only once. Re-assigning them can lead to confusing code and unexpected behavior.

Changing options

It's possible to update the options passed to the Embla Carousel constructor after initialization using the reInit method.

In the React, Vue, Solid, and Svelte wrappers, you can provide reactive options, and the carousel will automatically reinitialize whenever they change. Here are some examples:

import EmblaCarousel from 'embla-carousel'
const wrapperNode = document.querySelector('.embla')const viewportNode = wrapperNode.querySelector('.embla__viewport')
let loopEnabled = trueconst emblaApi = EmblaCarousel(viewportNode, { loop: loopEnabled })
function toggleLoop() {  loopEnabled = !loopEnabled  emblaApi.reInit({ loop: loopEnabled })}
<div class="embla">  <div class="embla__viewport">    <div class="embla__container">      <div class="embla__slide">Slide 1</div>      <div class="embla__slide">Slide 2</div>      <div class="embla__slide">Slide 3</div>    </div>  </div></div>

TypeScript

The EmblaOptionsType comes directly from the core package embla-carousel and can be used as follows:

import EmblaCarousel, { EmblaOptionsType } from 'embla-carousel'
const wrapperNode = <HTMLElement>document.querySelector('.embla')const viewportNode = <HTMLElement>wrapperNode.querySelector('.embla__viewport')
const options: EmblaOptionsType = { loop: true }const emblaApi = EmblaCarousel(viewportNode, options)
<div class="embla">  <div class="embla__viewport">    <div class="embla__container">      <div class="embla__slide">Slide 1</div>      <div class="embla__slide">Slide 2</div>      <div class="embla__slide">Slide 3</div>    </div>  </div></div>

Reference

Below follows an exhaustive list of all Embla Carousel options and their default values.

active

Type:boolean
Default: true
{ active: false | true }

Setting this to false will not activate or deactivate the carousel. Useful when used together with the breakpoints option to toggle the carousel active/inactive depending on media queries.

align

Type:string | function
Default: center
{ align: 'start' | 'center' | 'end' | (viewSize, snapSize, index) => 40 }

Align the slides relative to the carousel viewport. Use one of the predefined alignments start, center or end. Alternatively, provide your own callback to fully customize the alignment.

axis

Type:string
Default: x
{ axis: 'x' | 'y' }

Choose scroll axis between x and y. Remember to stack your slides horizontally or vertically using CSS to match this option.

breakpoints

Type:EmblaOptionsType
Default: {}
{   loop: true,  '(min-width: 768px)': { loop: false }}

An object with options that will be applied for a given breakpoint by overriding the options at the root level.

Note: If multiple queries match, they will be merged. And when breakpoint options clash, the last one in the list has precedence.

container

Type:string | HTMLElement | null
Default: null
{ container: '.embla__container' | document.querySelector('.embla__container') }

Enables choosing a custom container element which holds the slides. By default, Embla will choose the first direct child element of the root element. Provide either a valid CSS selector string or a HTML element.

containScroll

Type:false | string
Default: trimSnaps
{ containScroll: false | 'trimSnaps' | 'keepSnaps' }

Clear leading and trailing empty space that causes excessive scrolling. Use trimSnaps to only use snap points that trigger scrolling or keepSnaps to keep them.

Note: When this is active, it will override alignments applied by the align option for enough slides at the start and the end of the carousel, in order to cover the leading and trailing space.

direction

Type:string
Default: ltr
{ direction: 'ltr' | 'rtl' }

Choose content direction between ltr and rtl.

Note: When using rtl, the content direction also has to be set to RTL, either by using the HTML dir attribute or the CSS direction property.

dragFree

Type:boolean
Default: false
{ dragFree: true | false }

Enables momentum scrolling. The duration of the continued scrolling is proportional to how vigorous the drag gesture is.

dragThreshold

Type:number
Default: 10
{ dragThreshold: 10 }

Drag threshold in pixels. This only affects when clicks are fired and not. In contrast to other carousel libraries, it will not affect when dragging of the carousel starts.

Note: Browsers handle touch events differently than mouse events. Browsers won't fire the click event when a touch event includes an accidental slight swipe gesture. This is why this threshold only works for mouse events.

duration

Type:number
Default: 25
{ duration: 25 }

Set scroll duration when triggered by any of the API methods. Higher numbers enables slower scrolling. Drag interactions are not affected because duration is then determined by the drag force.

Note: Duration is not in milliseconds because Embla uses an attraction physics simulation when scrolling instead of easings. Only values between 20-60 are recommended.

inViewThreshold

Type:IntersectionObserverInit.threshold
Default: 0
{ inViewThreshold: 0 }

This is the Intersection Observer threshold option that will be applied to all slides.

loop

Type:boolean
Default: false
{ loop: true | false }

Enables infinite looping. Embla will apply translateX or translateY to the slides that need to change position in order to create the loop effect.

Embla automatically falls back to false if slide content isn't enough to create the loop effect without visible glitches.

skipSnaps

Type:boolean
Default: false
{ skipSnaps: true | false }

Allow the carousel to skip scroll snaps if it's dragged vigorously. Note that this option will be ignored if the dragFree option is set to true.

slides

Type:string | HTMLElement[] | NodeListOf<HTMLElement> | null
Default: null
{ slides: '.embla__slide' | Array.from(document.querySelectorAll('.embla__slide')) }

Enables using custom slide elements. By default, Embla will choose all direct child elements of its container. Provide either a valid CSS selector string or a nodeList/array containing HTML elements.

Note: Even though it's possible to provide custom slide elements, they still have to be direct descendants of the carousel container.

Warning: If you place elements inside the carousel container that aren't slides, they either shouldn't have any size, or should be detached from the document flow with position: absolute or similar.

slidesToScroll

Type:string | number
Default: 1
{ slidesToScroll: 1 | 2 | 'auto' }

Control the grouping of slides used for navigation interactions (next/prev buttons, dots, and dragging). By default, a single slide will be scrolled per interaction.

Set an integer value to scroll by a fixed number of slides on each interaction. For example, value 2 will treat every two slides as a single navigational unit.

Set to auto to dynamically create groups that match the number of slides visible in the viewport. For example, if 3 slides are currently visible, an auto setting would cause those 3 slides to be scrolled.

If using auto with slides of variable width, the group size will be calculated and adjusted dynamically based on how many slides fit into the viewport width at any given moment; not all groups will necessarily contain the same number of slides.

startIndex

Type:number
Default: 0
{ startIndex: 0 }

Set the initial scroll snap to the given number. First snap index starts at 0. Please note that this is not necessarily equal to the number of slides when used together with the slidesToScroll option.

watchDrag

Type:boolean | function
Default: true
{ watchDrag: true | false | (emblaApi, event) => boolean | void }

Enables for scrolling the carousel with mouse and touch interactions. Set this to false to disable drag events or pass a custom callback to add your own drag logic.

Note: When passing a custom callback it will run before the default Embla drag behaviour. Return true in your callback if you want Embla to run its default drag behaviour after your callback, or return false if you want to skip it.

watchFocus

Type:boolean | function
Default: true
{ watchFocus: true | false | (emblaApi, event) => boolean | void }

Embla automatically watches the slides for focus events. The default callback fires the slideFocus event and scrollTo to the focused element. Set this to false to disable this behaviour or pass a custom callback to add your own focus logic.

Note: When passing a custom callback it will run before the default Embla focus behaviour. Return true in your callback if you want Embla to run its default focus behaviour after your callback, or return false if you want to skip it.

watchResize

Type:boolean | function
Default: true
{ watchResize: true | false | (emblaApi, entries) => boolean | void }

Embla automatically watches the container and slides for size changes and runs reInit when any size has changed. Set this to false to disable this behaviour or pass a custom callback to add your own resize logic.

Note: When passing a custom callback it will run before the default Embla resize behaviour. Return true in your callback if you want Embla to run its default resize behaviour after your callback, or return false if you want to skip it.

watchSlides

Type:boolean | function
Default: true
{ watchSlides: true | false | (emblaApi, mutations) => boolean | void }

Embla automatically watches the container for added and/or removed slides and runs reInit if needed. Set this to false to disable this behaviour or pass a custom callback to add your own slides changed logic.

Note: When passing a custom callback it will run before the default Embla mutation behaviour. Return true in your callback if you want Embla to run its default mutation behaviour after your callback, or return false if you want to skip it.

Edit this page on GitHub