javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-20 12:29:55 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
ionic-framework/core/src/components/slides/readme.md
Manu MA ecc2c55370 docs(all): possible values are extracted by stencil (#16190) 
* docs(all): possible values are extracted by stencil

* add defaults

* remove all hardcoded defaults

* update stencil
2018-11-02 00:06:40 +01:00

6.9 KiB
Raw Blame History

ion-slides

The Slides component is a multi-section container. Each section can be swiped or dragged between. It contains any number of Slide components.

Adopted from Swiper.js: The most modern mobile touch slider and framework with hardware accelerated transitions.

http://www.idangero.us/swiper/

Copyright 2016, Vladimir Kharlampidi The iDangero.us http://www.idangero.us/

Licensed under MIT

Properties

Property Attribute Description Type Default
mode mode The mode determines which platform styles to use. "ios" | "md" undefined
options -- Options to pass to the swiper instance. See http://idangero.us/swiper/api/ for valid options any {}
pager pager If true, show the pagination. boolean false
scrollbar scrollbar If true, show the scrollbar. boolean false

Events

Event Description Detail
ionSlideDidChange Emitted after the active slide has changed. void
ionSlideDoubleTap Emitted when the user double taps on the slide's container. void
ionSlideDrag Emitted when the slider is actively being moved. void
ionSlideNextEnd Emitted when the next slide has ended. void
ionSlideNextStart Emitted when the next slide has started. void
ionSlidePrevEnd Emitted when the previous slide has ended. void
ionSlidePrevStart Emitted when the previous slide has started. void
ionSlideReachEnd Emitted when the slider is at the last slide. void
ionSlideReachStart Emitted when the slider is at its initial position. void
ionSlideTap Emitted when the user taps/clicks on the slide's container. void
ionSlideTouchEnd Emitted when the user releases the touch. void
ionSlideTouchStart Emitted when the user first touches the slider. void
ionSlideTransitionEnd Emitted when the slide transition has ended. void
ionSlideTransitionStart Emitted when the slide transition has started. void
ionSlideWillChange Emitted before the active slide has changed. void
ionSlidesDidLoad Emitted after Swiper initialization void

Methods

getActiveIndex() => Promise<number>

Get the index of the active slide.

Returns

Type: Promise<number>

getPreviousIndex() => Promise<number>

Get the index of the previous slide.

Returns

Type: Promise<number>

isBeginning() => Promise<boolean>

Get whether or not the current slide is the first slide.

Returns

Type: Promise<boolean>

isEnd() => Promise<boolean>

Get whether or not the current slide is the last slide.

Returns

Type: Promise<boolean>

length() => Promise<number>

Get the total number of slides.

Returns

Type: Promise<number>

lockSwipeToNext(shouldLockSwipeToNext: boolean) => Promise<void>

Lock or unlock the ability to slide to the next slides.

Parameters

Name Type Description
shouldLockSwipeToNext boolean

Returns

Type: Promise<void>

lockSwipeToPrev(shouldLockSwipeToPrev: boolean) => Promise<void>

Lock or unlock the ability to slide to the previous slides.

Parameters

Name Type Description
shouldLockSwipeToPrev boolean

Returns

Type: Promise<void>

lockSwipes(shouldLockSwipes: boolean) => Promise<void>

Lock or unlock the ability to slide to change slides.

Parameters

Name Type Description
shouldLockSwipes boolean

Returns

Type: Promise<void>

slideNext(speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise<void>

Transition to the next slide.

Parameters

Name Type Description
speed number | undefined
runCallbacks boolean | undefined

Returns

Type: Promise<void>

slidePrev(speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise<void>

Transition to the previous slide.

Parameters

Name Type Description
speed number | undefined
runCallbacks boolean | undefined

Returns

Type: Promise<void>

slideTo(index: number, speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise<void>

Transition to the specified slide.

Parameters

Name Type Description
index number
speed number | undefined
runCallbacks boolean | undefined

Returns

Type: Promise<void>

startAutoplay() => Promise<void>

Start auto play.

Returns

Type: Promise<void>

stopAutoplay() => Promise<void>

Stop auto play.

Returns

Type: Promise<void>

update() => Promise<void>

Update the underlying slider implementation. Call this if you've added or removed child slides.

Returns

Type: Promise<void>

CSS Custom Properties

Name Description
--bullet-background Background of the pagination bullets
--bullet-background-active Background of the active pagination bullet

Built with StencilJS