Api

Api

You can use Swiper's original params as react-id-swiper's props. Find out Swiper API documentationhere

Props

Name	Type	Default Value	Description
ContainerEl	String	div	Element type for container
containerClass	String	swiper-container	Swiper container class name
WrapperEl	String	div	Element type for wrapper
wrapperClass	String	swiper-wrapper	Swiper wrapper class name
slideClass	String	swiper-slide	Swiper slide class name
shouldSwiperUpdate	Boolean	false	Update swiper when component is updated
rebuildOnUpdate	Boolean	false	Rebuild swiper when component is updated
noSwiping	Boolean	false	Disable swiping by condition
activeSlideKey	String		Initial active slide index
renderPrevButton	Function		Render props function for prev button
renderNextButton	Function		Render props function for next button
renderScrollbar	Function		Render props function for scrollbar
renderPagination	Function		Render props function for pagination
renderParallax	Function		Render props function for parallax
getSwiper (deprecated from 4.x)	Function		Callback function that returns Swiper instance

Extra props for custom build

For custom build you need to provide extra props below

Name	Type	Default Value	Description
Swiper	Class		Swiper class
modules	array		Array of Swiper necessary modules

© 2024 - Asher Nguyen