]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
Add possible values in JS docs 9562/head
authorNicolas Coden <nicolas@ncoden.fr>
Fri, 23 Dec 2016 23:41:17 +0000 (00:41 +0100)
committerNicolas Coden <nicolas@ncoden.fr>
Fri, 23 Dec 2016 23:41:17 +0000 (00:41 +0100)
js/foundation.drilldown.js
js/foundation.dropdownMenu.js
js/foundation.magellan.js
js/foundation.slider.js
js/foundation.sticky.js

index 732a02566f18f5e055738826598830587fddcbcf..c7cea55a0eb7a7442fa3ea947fbc9e4830d3d094 100644 (file)
@@ -422,7 +422,7 @@ Drilldown.defaults = {
    */
   backButton: '<li class="js-drilldown-back"><a tabindex="0">Back</a></li>',
   /**
-   * 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'
index 40e5dac19808a4b7baa952d54c68ac0efb2920ab..54cb254ff0a4f79d6d2afbcf0807f0103c41276d 100644 (file)
@@ -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'
index 82e6a14b5d47afa5845670c556df742c678cef2c..80b35f3082d2a46896f23856b10a75932c265c41 100644 (file)
@@ -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',
   /**
index bd047114eca7c00b9ab5e00fe27c549218d165b8..e53f00e1f8f35233037d4a7745cbab58ad8f58bb 100644 (file)
@@ -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'
index c8815054e709396624fd9da1172e4604193e06b0..cea0ba7f27be620df166f33b7dbb632a15f3895e 100644 (file)
@@ -389,7 +389,7 @@ Sticky.defaults = {
    */
   container: '<div data-sticky-container></div>',
   /**
-   * 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'