forked from ElemeFE/element
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcarousel.d.ts
57 lines (43 loc) · 1.47 KB
/
carousel.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
import { ElementUIComponent } from './component'
export type CarouselIndicatorTrigger = 'hover' | 'click'
export type CarouselIndicatorPosition = 'outside' | 'none'
export type CarouselArrowVisibility = 'always' | 'hover' | 'never'
export type CarouselType = 'card'
export type CarouselDirection = 'horizontal' | 'vertical'
/** Loop a series of images or texts in a limited space */
export declare class ElCarousel extends ElementUIComponent {
/** Height of the carousel */
height: number
/** Index of the initially active slide (starting from 0) */
initialIndex: number
/** How indicators are triggered */
trigger: CarouselIndicatorTrigger
/** Whether automatically loop the slides */
autoplay: boolean
/** Interval of the auto loop, in milliseconds */
interval: number
/** Position of the indicators */
indicatorPosition: CarouselIndicatorPosition
/** When arrows are shown */
arrow: CarouselArrowVisibility
/** Type of the Carousel */
type: CarouselType
/** Display direction */
direction: CarouselDirection
/**
* Manually switch slide by index
*
* @param index Index of the slide to be switched to (starting from 0)
*/
setActiveItem (index: number): void
/**
* Manually switch slide by carousel item's name
*
* @param name The name of the corresponding `el-carousel-item`
*/
setActiveItem (name: string): void
/** Switch to the previous slide */
prev (): void
/** Switch to the next slide */
next (): void
}