From fe2dcdc9271944191ed0010baf3d42e31f425ce1 Mon Sep 17 00:00:00 2001 From: Andy Joslin Date: Mon, 10 Mar 2014 15:30:20 -0600 Subject: [PATCH] docs(slideBox): write documentation --- js/ext/angular/src/directive/ionicSlideBox.js | 38 ++++++++++++++++--- 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/js/ext/angular/src/directive/ionicSlideBox.js b/js/ext/angular/src/directive/ionicSlideBox.js index 9f5251a6f5..3bd1fa5655 100644 --- a/js/ext/angular/src/directive/ionicSlideBox.js +++ b/js/ext/angular/src/directive/ionicSlideBox.js @@ -1,18 +1,44 @@ (function() { 'use strict'; -/** - * @description - * The slideBoxCtrol lets you quickly create a multi-page - * container where each page can be swiped or dragged between - */ - angular.module('ionic.ui.slideBox', []) /** * The internal controller for the slide box controller. */ +/** + * @ngdoc directive + * @name ionSlideBox + * @module ionic + * @restrict E + * @description + * The Slide Box is a multi-page container where each page can be swiped or dragged between: + * + * ![SlideBox](http://ionicframework.com.s3.amazonaws.com/docs/controllers/slideBox.gif) + * + * @usage + * ```html + * + * + *

BLUE

+ *
+ * + *

YELLOW

+ *
+ * + *

PINK

+ *
+ *
+ * ``` + * + * @param {boolean=} does-continue Whether the slide box should automatically slide. + * @param {number=} slide-interval How many milliseconds to wait to change slides (if does-continue is true). Defaults to 4000. + * @param {boolean=} show-pager Whether a pager should be shown for this slide box. + * @param {boolean=} disable-scroll Whether to disallow scrolling/dragging of the slide-box content. + * @param {expression=} on-slide-changed Expression called whenever the slide is changed. + * @param {expression=} active-slide Model to bind the current slide to. + */ .directive('ionSlideBox', ['$timeout', '$compile', '$ionicSlideBoxDelegate', function($timeout, $compile, $ionicSlideBoxDelegate) { return { restrict: 'E',