Slides
Overview
The Slides component manages all Slide
sub-components, including clones.
Methods
register()
register( slide: HTMLElement, index: number, slideIndex: number ): void
Registers a slide element and creates a Slide object.
Params
slide |
---|
index |
slideIndex |
get()
get( excludeClones?: boolean ): SlideComponent[]
Returns all Slide objects.
Params
excludeClones |
---|
getIn()
getIn( page: number ): SlideComponent[]
Returns slides in the specified page.
Params
page |
---|
getAt()
getAt( index: number ): SlideComponent | undefined
Returns a Slide object at the specified index.
Params
index |
---|
add()
add( slide: string | Element | Array<string | Element>, index?: number ): void
Inserts a slide or slides at the specified index.
// Adds a slide by HTML:
add
(
'<li class="splide__slide"></li>'
)
;
// or adds an element:
const
slide
=
document
.
createElement
(
'li'
)
;
slide
.
classList
.
add
(
'splide__slide'
)
;
add
(
slide
)
;
JavaScript
// Adds a slide by HTML: add( '<li class="splide__slide"></li>' ); // or adds an element: const slide = document.createElement( 'li' ); slide.classList.add( 'splide__slide' ); add( slide );
Params
items |
---|
index |
remove()
remove( matcher: SlideMatcher ): void
Removes slides that match the matcher that can be an index, an array with indices, a selector, or a predicate function that takes following arguments:
Slide |
---|
index |
Slides |
remove
(
0
)
;
// Removes slides at 0 and 1:
remove
(
[
0
,
1
]
)
;
// Removes slides by a selector:
remove
(
'.is-visible'
)
;
// Removes slides by a predicate function:
remove
(
Slide
=>
Slide
.
index
%
2
===
0
)
;
JavaScript
remove( 0 ); // Removes slides at 0 and 1: remove( [ 0, 1 ] ); // Removes slides by a selector: remove( '.is-visible' ); // Removes slides by a predicate function: remove( Slide => Slide.index % 2 === 0 );
Params
matcher |
---|
forEach()
forEach( iteratee: SlidesIteratee, excludeClones?: boolean ): void
Iterates over Slide objects by the iteratee function.
Params
iteratee |
---|
excludeClones |
filter()
filter( matcher: SlideMatcher ): SlideComponent[]
Filters Slides by the matcher
that can be an index, an array with indices, a selector, or a predicate function.
See remove()
to know what arguments the function takes.
Params
matcher |
---|
style()
style( prop: string, value: string | number, useContainer?: boolean ): void
Adds a CSS rule to all slides or containers.
Params
prop |
---|
value |
useContainer |
getLength()
getLength( excludeClones?: boolean ): number
Returns the length of slides.
Params
excludeClones |
---|
isEnough()
isEnough(): boolean
Checks if the number of slides is over than the perPage
option, including clones.