]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
docs: OffCanvas correct transition time details
authorNoah Heck <noah@noahheck.com>
Mon, 28 Jan 2019 00:13:01 +0000 (17:13 -0700)
committerNoah Heck <noah@noahheck.com>
Mon, 28 Jan 2019 00:13:01 +0000 (17:13 -0700)
Because `transitionTime` is passed directly to the element CSS, the value should include the appropriate units

js/foundation.offcanvas.js

index b0c9c393a66cc0875f3ceef8cfa83c99b79f3383..1a4b49f522b74d280cf60a5edc007405b45ac0c8 100644 (file)
@@ -550,9 +550,9 @@ OffCanvas.defaults = {
   contentScroll: true,
 
   /**
-   * Amount of time in ms the open and close transition requires. If none selected, pulls from body style.
+   * Amount of time the open and close transition requires, including the appropriate milliseconds (`ms`) or seconds (`s) unit (e.g. `500ms`, `.75s`) If none selected, pulls from body style.
    * @option
-   * @type {number}
+   * @type {string}
    * @default null
    */
   transitionTime: null,