Skip to content

Commit fe2dcdc

Browse files
committed
docs(slideBox): write documentation
1 parent 7d076bd commit fe2dcdc

File tree

1 file changed

+32
-6
lines changed

1 file changed

+32
-6
lines changed

Diff for: js/ext/angular/src/directive/ionicSlideBox.js

+32-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,44 @@
11
(function() {
22
'use strict';
33

4-
/**
5-
* @description
6-
* The slideBoxCtrol lets you quickly create a multi-page
7-
* container where each page can be swiped or dragged between
8-
*/
9-
104
angular.module('ionic.ui.slideBox', [])
115

126
/**
137
* The internal controller for the slide box controller.
148
*/
159

10+
/**
11+
* @ngdoc directive
12+
* @name ionSlideBox
13+
* @module ionic
14+
* @restrict E
15+
* @description
16+
* The Slide Box is a multi-page container where each page can be swiped or dragged between:
17+
*
18+
* ![SlideBox](http://ionicframework.com.s3.amazonaws.com/docs/controllers/slideBox.gif)
19+
*
20+
* @usage
21+
* ```html
22+
* <ion-slide-box>
23+
* <ion-slide>
24+
* <div class="box blue"><h1>BLUE</h1></div>
25+
* </ion-slide>
26+
* <ion-slide>
27+
* <div class="box yellow"><h1>YELLOW</h1></div>
28+
* </ion-slide>
29+
* <ion-slide>
30+
* <div class="box pink"><h1>PINK</h1></div>
31+
* </ion-slide>
32+
* </ion-slide-box>
33+
* ```
34+
*
35+
* @param {boolean=} does-continue Whether the slide box should automatically slide.
36+
* @param {number=} slide-interval How many milliseconds to wait to change slides (if does-continue is true). Defaults to 4000.
37+
* @param {boolean=} show-pager Whether a pager should be shown for this slide box.
38+
* @param {boolean=} disable-scroll Whether to disallow scrolling/dragging of the slide-box content.
39+
* @param {expression=} on-slide-changed Expression called whenever the slide is changed.
40+
* @param {expression=} active-slide Model to bind the current slide to.
41+
*/
1642
.directive('ionSlideBox', ['$timeout', '$compile', '$ionicSlideBoxDelegate', function($timeout, $compile, $ionicSlideBoxDelegate) {
1743
return {
1844
restrict: 'E',

0 commit comments

Comments
 (0)