From b28a7cce2de71dafe6fe80ef6452fe3d1a3c58a1 Mon Sep 17 00:00:00 2001 From: Nicolas Coden Date: Sat, 24 Dec 2016 00:41:17 +0100 Subject: [PATCH] Add possible values in JS docs --- js/foundation.drilldown.js | 5 +++-- js/foundation.dropdownMenu.js | 2 +- js/foundation.magellan.js | 3 ++- js/foundation.slider.js | 2 +- js/foundation.sticky.js | 2 +- 5 files changed, 8 insertions(+), 6 deletions(-) diff --git a/js/foundation.drilldown.js b/js/foundation.drilldown.js index 732a02566..c7cea55a0 100644 --- a/js/foundation.drilldown.js +++ b/js/foundation.drilldown.js @@ -422,7 +422,7 @@ Drilldown.defaults = { */ backButton: '
  • Back
  • ', /** - * Position the back button either at the top or bottom of drilldown submenus. + * Position the back button either at the top or bottom of drilldown submenus. Can be `'left'` or `'bottom'`. * @option * @type {string} * @default top @@ -492,9 +492,10 @@ Drilldown.defaults = { */ animationDuration: 500, /** - * Scroll animation easing + * Scroll animation easing. Can be `'swing'` or `'linear'`. * @option * @type {string} + * @see {@link https://api.jquery.com/animate|JQuery animate} * @default 'swing' */ animationEasing: 'swing' diff --git a/js/foundation.dropdownMenu.js b/js/foundation.dropdownMenu.js index 40e5dac19..54cb254ff 100644 --- a/js/foundation.dropdownMenu.js +++ b/js/foundation.dropdownMenu.js @@ -393,7 +393,7 @@ DropdownMenu.defaults = { closingTime: 500, /** - * Position of the menu relative to what direction the submenus should open. Handled by JS. + * Position of the menu relative to what direction the submenus should open. Handled by JS. Can be `'left'` or `'right'`. * @option * @type {string} * @default 'left' diff --git a/js/foundation.magellan.js b/js/foundation.magellan.js index 82e6a14b5..80b35f308 100644 --- a/js/foundation.magellan.js +++ b/js/foundation.magellan.js @@ -208,10 +208,11 @@ Magellan.defaults = { */ animationDuration: 500, /** - * Animation style to use when scrolling between locations. + * Animation style to use when scrolling between locations. Can be `'swing'` or `'linear'`. * @option * @type {string} * @default 'linear' + * @see {@link https://api.jquery.com/animate|Jquery animate} */ animationEasing: 'linear', /** diff --git a/js/foundation.slider.js b/js/foundation.slider.js index bd047114e..e53f00e1f 100644 --- a/js/foundation.slider.js +++ b/js/foundation.slider.js @@ -672,7 +672,7 @@ Slider.defaults = { */ nonLinearBase: 5, /** - * Basevalue for non-linear sliders, possible values are: 'linear', 'pow' & 'log'. Pow and Log use the nonLinearBase setting. + * Basevalue for non-linear sliders, possible values are: `'linear'`, `'pow'` & `'log'`. Pow and Log use the nonLinearBase setting. * @option * @type {string} * @default 'linear' diff --git a/js/foundation.sticky.js b/js/foundation.sticky.js index c8815054e..cea0ba7f2 100644 --- a/js/foundation.sticky.js +++ b/js/foundation.sticky.js @@ -389,7 +389,7 @@ Sticky.defaults = { */ container: '
    ', /** - * Location in the view the element sticks to. + * Location in the view the element sticks to. Can be `'top'` or `'bottom'`. * @option * @type {string} * @default 'top' -- 2.47.2