UNPKG

@catull/igniteui-angular

Version:

Ignite UI for Angular is a dependency-free Angular toolkit for building modern web apps

118 lines (117 loc) 2.75 kB
import { OnDestroy, EventEmitter, ElementRef } from '@angular/core'; import { Subject } from 'rxjs'; export declare enum Direction { NONE = 0, NEXT = 1, PREV = 2 } /** * A slide component that usually holds an image and/or a caption text. * IgxSlideComponent is usually a child component of an IgxCarouselComponent. * * ``` * <igx-slide [input bindings] > * <ng-content></ng-content> * </igx-slide> * ``` * * @export */ export declare class IgxSlideComponent implements OnDestroy { private elementRef; private _active; private _destroy$; /** * Gets/sets the `index` of the slide inside the carousel. * ```html * <igx-carousel> * <igx-slide index = "1"></igx-slide> * <igx-carousel> * ``` * @memberOf IgxSlideComponent */ index: number; /** * Gets/sets the target `direction` for the slide. * ```html * <igx-carousel> * <igx-slide direction="NEXT"></igx-slide> * <igx-carousel> * ``` * @memberOf IgxSlideComponent */ direction: Direction; /** * Returns the `tabIndex` of the slide component. * ```typescript * let tabIndex = this.carousel.tabIndex; * ``` * @memberof IgxSlideComponent */ readonly tabIndex: number; /** * Returns the `aria-selected` of the slide. * * ```typescript * let slide = this.slide.ariaSelected; * ``` * */ readonly ariaSelected: boolean; /** * Returns the `aria-live` of the slide. * * ```typescript * let slide = this.slide.ariaLive; * ``` * */ readonly ariaLive: string; /** * Returns the class of the slide component. * ```typescript * let class = this.slide.cssClass; * ``` * @memberof IgxSlideComponent */ cssClass: string; /** * Gets/sets the `active` state of the slide. * ```html * <igx-carousel> * <igx-slide [active] ="false"></igx-slide> * <igx-carousel> * ``` * * Two-way data binding. * ```html * <igx-carousel> * <igx-slide [(active)] ="model.isActive"></igx-slide> * <igx-carousel> * ``` * @memberof IgxSlideComponent */ active: boolean; previous: boolean; /** *@hidden */ activeChange: EventEmitter<boolean>; constructor(elementRef: ElementRef); /** * Returns a reference to the carousel element in the DOM. * ```typescript * let nativeElement = this.slide.nativeElement; * ``` * @memberof IgxSlideComponent */ readonly nativeElement: any; /** * @hidden */ readonly isDestroyed: Subject<boolean>; /** * @hidden */ ngOnDestroy(): void; }