packages/ecl/components/ecl-news-ticker/ecl-news-ticker.component.ts
| selector | ecl-news-ticker |
| imports |
EUI_ECL_BUTTON
EUI_ECL_ICON
EclNewsTickerItemComponent
TranslateModule
|
| templateUrl | ./ecl-news-ticker.component.html |
Properties |
Methods |
Inputs |
Outputs |
HostBindings |
Accessors |
constructor()
|
| isAutoplay |
Type : boolean
|
Default value : true
|
|
Enables or disables automatic cycling through ticker items.
Defaults to |
| class |
Type : string
|
| e2eAttr |
Type : any
|
| tabindex |
Type : number
|
| itemSwitch |
Type : EventEmitter
|
|
Emits when the visible news ticker item changes.
The payload is an instance of |
| class |
Type : string
|
| cancelAutoplay |
cancelAutoplay()
|
|
Cancels the automatic cycling of the ticker items.
Returns :
void
|
| nextSlide |
nextSlide()
|
|
Moves to the next slide and emits
Returns :
void
|
| onNewsTickerItemMouseOut |
onNewsTickerItemMouseOut()
|
|
Handles mouse out event from a ticker item. Resumes autoplay if it was paused due to hover.
Returns :
void
|
| onNewsTickerItemMouseOver |
onNewsTickerItemMouseOver()
|
|
Handles mouse over event on a ticker item. Temporarily pauses autoplay.
Returns :
void
|
| onNext |
onNext()
|
|
Handles "next" button click. Navigates to the next slide and stops autoplay.
Returns :
void
|
| onPauseBtnEnter | ||||||
onPauseBtnEnter(evt: Event)
|
||||||
|
Handles focus event on the "Pause" button. Stops autoplay and shifts focus to the "Play" button.
Parameters :
Returns :
void
|
| onPlayBtnEnter | ||||||
onPlayBtnEnter(evt: Event)
|
||||||
|
Handles focus event on the "Play" button. Starts autoplay and shifts focus to the "Pause" button.
Parameters :
Returns :
void
|
| onPrevious |
onPrevious()
|
|
Handles "previous" button click. Navigates to the previous slide and stops autoplay.
Returns :
void
|
| previousSlide |
previousSlide()
|
|
Moves to the previous slide and emits
Returns :
void
|
| startAutoplay |
startAutoplay()
|
|
Starts automatic cycling of the ticker items.
Returns :
void
|
| getCssClasses | ||||||
getCssClasses(rootClass: string)
|
||||||
|
Parameters :
Returns :
string
|
| firstHiddenItem |
Type : EclNewsTickerItemComponent
|
Decorators :
@ViewChild('firstHiddenItem')
|
|
Reference to the hidden first item used for looping. |
| itemIndex |
Type : number
|
Default value : 1
|
| lastHiddenItem |
Type : EclNewsTickerItemComponent
|
Decorators :
@ViewChild('lastHiddenItem')
|
|
Reference to the hidden last item used for looping. |
| newsTickerItems |
Type : QueryList<EclNewsTickerItemComponent>
|
Decorators :
@ContentChildren(EclNewsTickerItemComponent)
|
|
Query list of all |
| pauseBtn |
Type : EclButtonComponent
|
Decorators :
@ViewChild('pauseBtn')
|
|
Reference to the pause button used to stop autoplay. |
| playBtn |
Type : EclButtonComponent
|
Decorators :
@ViewChild('playBtn')
|
|
Reference to the play button used to start autoplay. |
| playing |
Type : unknown
|
Default value : false
|
| slidesContainer |
Type : ElementRef
|
Decorators :
@ViewChild('slidesContainer')
|
|
Reference to the container element that holds the slides. |
| slidesTransform |
Type : string
|
Default value : ''
|
| transitionDuration |
Type : number
|
| cssClasses |
getcssClasses()
|
| contentHeight |
getcontentHeight()
|
|
Returns the height of the currently visible ticker item.
Returns :
number
|
| itemsCount |
getitemsCount()
|
|
Returns the number of ticker items.
Returns :
number
|
| isShowControls |
getisShowControls()
|
|
Indicates whether navigation controls should be shown.
Returns :
boolean
|