Slides
Slides
概要
Slidesコンポーネントは、クローンを含むすべてのSlideサブコンポーネントを管理します。
メソッド
register()
register( slide: HTMLElement, index: number, slideIndex: number ): void
スライド要素を新規で登録し、Slide
オブジェクトを作成します。
引数
slide |
---|
index |
slideIndex |
get()
get( excludeClones?: boolean ): SlideComponent[]
すべてのSlide
オブジェクトを含む配列を返します。
引数
excludeClones |
---|
getIn()
getIn( page: number ): SlideComponent[]
与えられたページに含まれるSlide
オブジェクトを配列で返します。
引数
page |
---|
getAt()
getAt( index: number ): SlideComponent | undefined
与えられたインデックスに該当するSlide
オブジェクトを返します。
引数
index |
---|
add()
add( slide: string | Element | Array<string | Element>, index?: number ): void
指定したインデックスに新たなスライドを挿入します。複数追加するには配列を利用してください。
// HTMLで挿入
add
(
'<li class="splide__slide"></li>'
)
;
// エレメントを挿入
const
slide
=
document
.
createElement
(
'li'
)
;
slide
.
classList
.
add
(
'splide__slide'
)
;
add
(
slide
)
;
JavaScript
// HTMLで挿入 add( '<li class="splide__slide"></li>' ); // エレメントを挿入 const slide = document.createElement( 'li' ); slide.classList.add( 'splide__slide' ); add( slide );
引数
items |
---|
index |
remove()
remove( matcher: SlideMatcher ): void
指定されたmatcher
に一致するスライドを削除します。matcher
にはスライドのインデックス、インデックスを含む配列、セレクタ、またはテスト関数のうちのいずれかを使用することができます。テスト関数には、以下のような引数が与えられます。
Slide |
---|
index |
Slides |
remove
(
0
)
;
// 配列を用いて削除
remove
(
[
0
,
1
]
)
;
// セレクタに一致するスライドを削除
remove
(
'.is-visible'
)
;
// テスト関数に合格するスライドを削除
remove
(
Slide
=>
Slide
.
index
%
2
===
0
)
;
JavaScript
remove( 0 ); // 配列を用いて削除 remove( [ 0, 1 ] ); // セレクタに一致するスライドを削除 remove( '.is-visible' ); // テスト関数に合格するスライドを削除 remove( Slide => Slide.index % 2 === 0 );
引数
matcher |
---|
forEach()
forEach( iteratee: SlidesIteratee, excludeClones?: boolean ): void
Slide
オブジェクトを反復処理します。
引数
iteratee |
---|
excludeClones |
filter()
filter( matcher: SlideMatcher ): SlideComponent[]
すべてのSlide
オブジェクトに対してmatcher
を実行し、該当するもののみが含まれる配列を返します。matcher
については上記remove()
の項を参照してください。
引数
matcher |
---|
style()
style( prop: string, value: string | number, useContainer?: boolean ): void
すべてのスライドに対してスタイルを適用します。
引数
prop |
---|
value |
useContainer |
getLength()
getLength( excludeClones?: boolean ): number
スライドの全体数を返します。
引数
excludeClones |
---|
isEnough()
isEnough(): boolean
現在のスライド数が、perPage
を上回っているかどうかを判定します。