docs(slides): fix docs

This commit is contained in:
mhartington
2017-01-09 14:38:58 -05:00
parent 9a00af34e3
commit 3f164237ae

View File

@ -129,6 +129,7 @@ export class Slides extends Ion {
* @input {number} Delay between transitions (in milliseconds). If this * @input {number} Delay between transitions (in milliseconds). If this
* parameter is not passed, autoplay is disabled. Default does * parameter is not passed, autoplay is disabled. Default does
* not have a value and does not autoplay. * not have a value and does not autoplay.
* Default: `null`.
*/ */
@Input() @Input()
get autoplay() { get autoplay() {
@ -226,7 +227,7 @@ export class Slides extends Ion {
private _paginationType = 'bullets'; private _paginationType = 'bullets';
/** /**
* Enable, if you want to use "parallaxed" elements inside of * @input {boolean} Enable, if you want to use "parallaxed" elements inside of
* slider. Default: `false`. * slider. Default: `false`.
*/ */
@Input() @Input()
@ -265,16 +266,19 @@ export class Slides extends Ion {
private _isZoom = false; private _isZoom = false;
/** /**
* @private
* Height of container. * Height of container.
*/ */
height: number; height: number;
/** /**
* @private
* Width of container. * Width of container.
*/ */
width: number; width: number;
/** /**
* @private
* Enabled this option and swiper will be operated as usual except it will * Enabled this option and swiper will be operated as usual except it will
* not move, real translate values on wrapper will not be set. Useful when * not move, real translate values on wrapper will not be set. Useful when
* you may need to create custom slide transition. * you may need to create custom slide transition.
@ -282,68 +286,189 @@ export class Slides extends Ion {
virtualTranslate = false; virtualTranslate = false;
/** /**
* @private
* Set to true to round values of slides width and height to prevent blurry * Set to true to round values of slides width and height to prevent blurry
* texts on usual resolution screens (if you have such) * texts on usual resolution screens (if you have such)
*/ */
roundLengths = false; roundLengths = false;
// Slides grid // Slides grid
/**
* @private
*/
spaceBetween = 0; spaceBetween = 0;
/**
* @private
*/
slidesPerView: number|string = 1; slidesPerView: number|string = 1;
/**
* @private
*/
slidesPerColumn = 1; slidesPerColumn = 1;
/**
* @private
*/
slidesPerColumnFill = 'column'; slidesPerColumnFill = 'column';
/**
* @private
*/
slidesPerGroup = 1; slidesPerGroup = 1;
/**
* @private
*/
centeredSlides = false; centeredSlides = false;
/**
* @private
*/
slidesOffsetBefore = 0; slidesOffsetBefore = 0;
/**
* @private
*/
slidesOffsetAfter = 0; slidesOffsetAfter = 0;
/**
* @private
*/
touchEventsTarget: 'container'; touchEventsTarget: 'container';
// autoplay // autoplay
/**
* @private
*/
autoplayDisableOnInteraction = true; autoplayDisableOnInteraction = true;
/**
* @private
*/
autoplayStopOnLast = false; autoplayStopOnLast = false;
// Free mode // Free mode
/**
* @private
*/
freeMode = false; freeMode = false;
/**
* @private
*/
freeModeMomentum = true; freeModeMomentum = true;
/**
* @private
*/
freeModeMomentumRatio = 1; freeModeMomentumRatio = 1;
/**
* @private
*/
freeModeMomentumBounce = true; freeModeMomentumBounce = true;
/**
* @private
*/
freeModeMomentumBounceRatio = 1; freeModeMomentumBounceRatio = 1;
/**
* @private
*/
freeModeMomentumVelocityRatio = 1; freeModeMomentumVelocityRatio = 1;
/**
* @private
*/
freeModeSticky = false; freeModeSticky = false;
/**
* @private
*/
freeModeMinimumVelocity = 0.02; freeModeMinimumVelocity = 0.02;
// Autoheight // Autoheight
/**
* @private
*/
autoHeight = false; autoHeight = false;
// Set wrapper width // Set wrapper width
/**
* @private
*/
setWrapperSize = false; setWrapperSize = false;
// Zoom // Zoom
/**
* @private
*/
zoomMax = 3; zoomMax = 3;
/**
* @private
*/
zoomMin = 1; zoomMin = 1;
/**
* @private
*/
zoomToggle = true; zoomToggle = true;
// Touches // Touches
/**
* @private
*/
touchRatio = 1; touchRatio = 1;
/**
* @private
*/
touchAngle = 45; touchAngle = 45;
/**
* @private
*/
simulateTouch = true; simulateTouch = true;
/**
* @private
*/
shortSwipes = true; shortSwipes = true;
/**
* @private
*/
longSwipes = true; longSwipes = true;
/**
* @private
*/
longSwipesRatio = 0.5; longSwipesRatio = 0.5;
/**
* @private
*/
longSwipesMs = 300; longSwipesMs = 300;
/**
* @private
*/
followFinger = true; followFinger = true;
/**
* @private
*/
onlyExternal = false; onlyExternal = false;
/**
* @private
*/
threshold = 0; threshold = 0;
/**
* @private
*/
touchMoveStopPropagation = true; touchMoveStopPropagation = true;
/**
* @private
*/
touchReleaseOnEdges = false; touchReleaseOnEdges = false;
// To support iOS's swipe-to-go-back gesture (when being used in-app, with UIWebView). // To support iOS's swipe-to-go-back gesture (when being used in-app, with UIWebView).
/**
* @private
*/
iOSEdgeSwipeDetection = false; iOSEdgeSwipeDetection = false;
/**
* @private
*/
iOSEdgeSwipeThreshold = 20; iOSEdgeSwipeThreshold = 20;
// Pagination // Pagination
/**
* @private
*/
paginationClickable = false; paginationClickable = false;
/**
* @private
*/
paginationHide = false; paginationHide = false;
// Resistance // Resistance
@ -355,25 +480,52 @@ export class Slides extends Ion {
watchSlidesVisibility = false; watchSlidesVisibility = false;
// Clicks // Clicks
/**
* @private
*/
preventClicks = true; preventClicks = true;
/**
* @private
*/
preventClicksPropagation = true; preventClicksPropagation = true;
/**
* @private
*/
slideToClickedSlide = false; slideToClickedSlide = false;
// loop // loop
/**
* @private
*/
loopAdditionalSlides = 0; loopAdditionalSlides = 0;
/**
* @private
*/
loopedSlides = null; loopedSlides = null;
// Swiping/no swiping // Swiping/no swiping
/**
* @private
*/
swipeHandler = null; swipeHandler = null;
/**
* @private
*/
noSwiping = true; noSwiping = true;
// Callbacks // Callbacks
runCallbacksOnInit = true; runCallbacksOnInit = true;
// Keyboard // Keyboard
/**
* @private
*/
keyboardControl = true; keyboardControl = true;
// Effects // Effects
/**
* @private
*/
coverflow = { coverflow = {
rotate: 50, rotate: 50,
stretch: 0, stretch: 0,
@ -381,26 +533,50 @@ export class Slides extends Ion {
modifier: 1, modifier: 1,
slideShadows: true slideShadows: true
}; };
/**
* @private
*/
flip = { flip = {
slideShadows: true, slideShadows: true,
limitRotation: true limitRotation: true
}; };
/**
* @private
*/
cube = { cube = {
slideShadows: true, slideShadows: true,
shadow: true, shadow: true,
shadowOffset: 20, shadowOffset: 20,
shadowScale: 0.94 shadowScale: 0.94
}; };
/**
* @private
*/
fade = { fade = {
crossFade: false crossFade: false
}; };
// Accessibility // Accessibility
/**
* @private
*/
prevSlideMessage = 'Previous slide'; prevSlideMessage = 'Previous slide';
/**
* @private
*/
nextSlideMessage = 'Next slide'; nextSlideMessage = 'Next slide';
/**
* @private
*/
firstSlideMessage = 'This is the first slide'; firstSlideMessage = 'This is the first slide';
/**
* @private
*/
lastSlideMessage = 'This is the last slide'; lastSlideMessage = 'This is the last slide';
/**
* @private
*/
originalEvent: any; originalEvent: any;
/** /**
@ -434,7 +610,7 @@ export class Slides extends Ion {
@Output() ionSlideAutoplay: EventEmitter<Slides> = new EventEmitter(); @Output() ionSlideAutoplay: EventEmitter<Slides> = new EventEmitter();
/** /**
* @output {Slides} Same as `ionWillChange` but caused by autoplay. * @output {Slides} Same as `ionSlideWillChange` but caused by autoplay.
*/ */
@Output() ionSlideAutoplayStart: EventEmitter<Slides> = new EventEmitter(); @Output() ionSlideAutoplayStart: EventEmitter<Slides> = new EventEmitter();
@ -444,22 +620,22 @@ export class Slides extends Ion {
@Output() ionSlideAutoplayStop: EventEmitter<Slides> = new EventEmitter(); @Output() ionSlideAutoplayStop: EventEmitter<Slides> = new EventEmitter();
/** /**
* @output {Slides} Same as `ionWillChange` but for "forward" direction only. * @output {Slides} Same as `ionSlideWillChange` but for "forward" direction only.
*/ */
@Output() ionSlideNextStart: EventEmitter<Slides> = new EventEmitter(); @Output() ionSlideNextStart: EventEmitter<Slides> = new EventEmitter();
/** /**
* @output {Slides} Same as `ionWillChange` but for "backward" direction only. * @output {Slides} Same as `ionSlideWillChange` but for "backward" direction only.
*/ */
@Output() ionSlidePrevStart: EventEmitter<Slides> = new EventEmitter(); @Output() ionSlidePrevStart: EventEmitter<Slides> = new EventEmitter();
/** /**
* @output {Slides} Same as `ionDidChange` but for "forward" direction only. * @output {Slides} Same as `ionSlideDidChange` but for "forward" direction only.
*/ */
@Output() ionSlideNextEnd: EventEmitter<Slides> = new EventEmitter(); @Output() ionSlideNextEnd: EventEmitter<Slides> = new EventEmitter();
/** /**
* @output {Slides} Same as `ionDidChange` but for "backward" direction only. * @output {Slides} Same as `ionSlideDidChange` but for "backward" direction only.
*/ */
@Output() ionSlidePrevEnd: EventEmitter<Slides> = new EventEmitter(); @Output() ionSlidePrevEnd: EventEmitter<Slides> = new EventEmitter();