upjs-rails 0.12.4 → 0.12.5

data/lib/assets/javascripts/up/link.js.coffee

@@ -95,7 +95,7 @@ up.link = (($) ->
 
       up.visit('/users')
 
-  @method up.visit
+  @function up.visit
   @param {String} url
     The URL to visit.
   @param {String} [options.target='body']
@@ -121,7 +121,7 @@ up.link = (($) ->
       var $link = $('a:first'); // select link with jQuery
       up.follow($link);
 
-  @method up.follow
+  @function up.follow
   @param {Element|jQuery|String} linkOrSelector
     An element or selector which resolves to an `<a>` tag
     or any element that is marked up with an `up-href` attribute.
@@ -170,7 +170,7 @@ up.link = (($) ->
   Defaults to `get`.
 
   @protected
-  @method up.link.followMethod
+  @function up.link.followMethod
   @param linkOrSelector
   @param options.method {String}
   ###
@@ -226,8 +226,7 @@ up.link = (($) ->
   Note that using any element other than `<a>` will prevent users from
   opening the destination in a new tab.
 
-  @method a[up-target]
-  @ujs
+  @selector a[up-target]
   @param {String} up-target
     The CSS selector to replace
   @param {String} [up-href]
@@ -269,8 +268,7 @@ up.link = (($) ->
   navigation actions this isn't needed. E.g. popular operation
   systems switch tabs on `mousedown` instead of `click`.
 
-  @method a[up-instant]
-  @ujs
+  @selector a[up-instant]
   ###
   up.on 'mousedown', 'a[up-instant], [up-href][up-instant]', (event, $link) ->
     if shouldProcessLinkEvent(event, $link)
@@ -278,7 +276,7 @@ up.link = (($) ->
       follow($link)
 
   ###*
-  @method up.link.childClicked
+  @function up.link.childClicked
   @private
   ###
   childClicked = (event, $link) ->
@@ -295,7 +293,7 @@ up.link = (($) ->
   This is done by giving the link an `up-follow` attribute
   if it doesn't already have it an `up-target` or `up-follow` attribute.
 
-  @method up.link.makeFollowable
+  @function up.link.makeFollowable
   @protected
   ###
   makeFollowable = (link) ->
@@ -324,8 +322,7 @@ up.link = (($) ->
   Note that using any element other than `<a>` will prevent users from
   opening the destination in a new tab.
 
-  @method a[up-follow]
-  @ujs
+  @selector a[up-follow]
   @param [up-href]
     The destination URL to follow.
     If omitted, the the link's `href` attribute will be used.
@@ -358,8 +355,7 @@ up.link = (($) ->
   `up-expand` honors all the UJS behavior in expanded links
   (`up-target`, `up-instant`, `up-preload`, etc.).
 
-  @ujs
-  @method [up-expand]
+  @selector [up-expand]
   ###
   up.compiler '[up-expand]', ($area) ->
     link = $area.find('a, [up-href]').get(0)
@@ -392,8 +388,7 @@ up.link = (($) ->
   
       <a href="/users" up-target=".main" up-instant up-preload>User list</a>  
 
-  @method [up-dash]
-  @ujs
+  @selector [up-dash]
   ###
   up.compiler '[up-dash]', ($element) ->
     target = u.castedAttr($element, 'up-dash')

data/lib/assets/javascripts/up/modal.js.coffee

@@ -2,10 +2,55 @@
 Modal dialogs
 =============
 
-Instead of linking to another page fragment, you can also choose
-to open any target CSS selector in a modal dialog.
+Instead of [linking to a page fragment](/up.link), you can choose
+to show a fragment in a modal dialog.
+
+To open a modal, add an [`up-modal` attribute](/a-up-modal) to a link,
+or call the Javascript functions [`up.modal.follow`](/up.modal.follow)
+and [`up.modal.visit`](/up.modal.visit).
   
-For small popup overlays ("dropdowns") see [up.popup](/up.popup) instead.
+For smaller popup overlays ("dropdowns") see [up.popup](/up.popup) instead.
+
+
+\#\#\#\# Customizing the dialog design
+
+Loading the Up.js stylesheet will give you a minimal dialog design:
+
+- Dialog contents are displayed in a white box that is centered vertically and horizontally.
+- There is a a subtle box shadow around the dialog
+- The box will grow to fit the dialog contents, but never grow larger than the screen
+- The box is placed over a semi-transparent background to dim the rest of the page
+- There is a button to close the dialog in the top-right corner
+
+The easiest way to change how the dialog looks is by overriding the [default CSS styles](https://github.com/makandra/upjs/blob/master/lib/assets/stylesheets/up/modal.css.sass).
+
+By default the dialog uses the following DOM structure:
+
+    <div class="up-modal">
+      <div class="up-modal-dialog">
+        <div class="up-modal-close" up-close>X</div>
+        <div class="up-modal-content">
+          ...
+        </div>
+      </div>
+    </div>
+
+If you want to change the design beyond CSS, you can
+configure Up.js to [use a different HTML structure](/up.modal.config).
+
+
+\#\#\#\# Closing behavior
+
+By default the dialog automatically closes
+*whenever a page fragment below the dialog is updated*.
+This is useful to have the dialog interact with the page that
+opened it, e.g. by updating parts of a larger form or by signing in a user
+and revealing additional information.
+
+To disable this behavior, give the opening link an `up-sticky` attribute:
+
+    <a href="/settings" up-modal=".options" up-sticky>Settings</a>
+
 
 @class up.modal 
 ###
@@ -16,8 +61,7 @@ up.modal = (($) ->
   ###*
   Sets default options for future modals.
 
-  @method up.modal.config
-  @property
+  @property up.modal.config
   @param {Number} [config.width]
     The width of the dialog as a CSS value like `'400px'` or `50%`.
 
@@ -72,7 +116,7 @@ up.modal = (($) ->
   Returns the source URL for the fragment displayed in the current modal overlay,
   or `undefined` if no modal is currently open.
 
-  @method up.modal.url
+  @function up.modal.url
   @return {String}
     the source URL
   ###
@@ -81,7 +125,7 @@ up.modal = (($) ->
   ###*
   Returns the URL of the page below the modal overlay.
 
-  @method up.modal.coveredUrl
+  @function up.modal.coveredUrl
   @return {String}
   @protected
   ###
@@ -167,14 +211,9 @@ up.modal = (($) ->
 
   Any option attributes for [`a[up-modal]`](/a.up-modal) will be honored.
 
-  \#\#\#\# Events
-
-  - Emits an [event](/up.bus) `up:modal:open` when the modal
-    is starting to open.
-  - Emits an [event](/up.bus) `up:modal:opened` when the opening
-    animation has finished and the modal contents are fully visible.
+  Emits events [`up:modal:open`](/up:modal:open) and [`up:modal:opened`](/up:modal:opened).
 
-  @method up.modal.follow
+  @function up.modal.follow
   @param {Element|jQuery|String} linkOrSelector
     The link to follow.
   @param {String} [options.target]
@@ -206,7 +245,6 @@ up.modal = (($) ->
     options.$link = $(linkOrSelector)
     open(options)
 
-
   ###*
   Opens a modal for the given URL.
 
@@ -217,7 +255,9 @@ up.modal = (($) ->
   This will request `/foo`, extract the `.list` selector from the response
   and open the selected container in a modal dialog.
 
-  @method up.modal.visit
+  Emits events [`up:modal:open`](/up:modal:open) and [`up:modal:opened`](/up:modal:opened).
+
+  @function up.modal.visit
   @param {String} url
     The URL to load.
   @param {String} options.target
@@ -231,8 +271,8 @@ up.modal = (($) ->
     options.url = url
     open(options)
 
-
   ###*
+  @function up.modal.open
   @private
   ###
   open = (options) ->
@@ -268,18 +308,27 @@ up.modal = (($) ->
       # callers by returning a Deferred that will never be resolved.
       $.Deferred()
 
+  ###*
+  This event is [emitted](/up.emit) when a modal dialog is starting to open.
+
+  @event up:modal:open
+  @param event.preventDefault()
+    Event listeners may call this method to prevent the modal from opening.
+  ###
+
+  ###*
+  This event is [emitted](/up.emit) when a modal dialog has finished opening.
+
+  @event up:modal:opened
+  ###
+
   ###*
   Closes a currently opened modal overlay.
   Does nothing if no modal is currently open.
 
-  \#\#\#\# Events
+  Emits events [`up:modal:close`](/up:modal:close) and [`up:modal:closed`](/up:modal:closed).
 
-  - Emits an [event](/up.bus) `modal:close` when the modal
-    is starting to close.
-  - Emits an [event](/up.bus) `modal:closed` when the closing
-    animation has finished and the modal has been removed from the DOM.
-  
-  @method up.modal.close
+  @function up.modal.close
   @param {Object} options
     See options for [`up.animate`](/up.animate)
   ###
@@ -305,6 +354,22 @@ up.modal = (($) ->
     else
       u.resolvedDeferred()
 
+  ###*
+  This event is [emitted](/up.emit) when a modal dialog
+  is starting to [close](/up.modal.close).
+
+  @event up:modal:close
+  @param event.preventDefault()
+    Event listeners may call this method to prevent the modal from closing.
+  ###
+
+  ###*
+  This event is [emitted](/up.emit) when a modal dialog
+  is done [closing](/up.modal.close).
+
+  @event up:modal:closed
+  ###
+
   autoclose = ->
     unless $('.up-modal').is('[up-sticky]')
       discardHistory()
@@ -314,7 +379,7 @@ up.modal = (($) ->
   Returns whether the given element or selector is contained
   within the current modal.
 
-  @methods up.modal.contains
+  @function up.modal.contains
   @param {String} elementOrSelector
   @protected
   ###
@@ -335,51 +400,7 @@ up.modal = (($) ->
   and place the matching `.blog-list` tag will be placed in
   a modal dialog.
 
-
-  \#\#\#\# Customizing the dialog design
-
-  Loading the Up.js stylesheet will give you a minimal dialog design:
-
-  - Dialog contents are displayed in a white box that is centered vertically and horizontally.
-  - There is a a subtle box shadow around the dialog
-  - The box will grow to fit the dialog contents, but never grow larger than the screen
-  - The box is placed over a semi-transparent background to dim the rest of the page
-  - There is a button to close the dialog in the top-right corner
-
-  The easiest way to change how the dialog looks is by overriding the [default CSS styles](https://github.com/makandra/upjs/blob/master/lib/assets/stylesheets/up/modal.css.sass).
-
-  By default the dialog uses the following DOM structure (continuing the blog-switcher example from above):
-
-      <div class="up-modal">
-        <div class="up-modal-dialog">
-          <div class="up-modal-close" up-close>X</div>
-          <div class="up-modal-content">
-            <ul class="blog-list">
-              ...
-            </ul>
-          </div>
-        </div>
-      </div>
-
-  If you want to change the design beyond CSS, you can
-  configure Up.js to [use a different HTML structure](/up.modal.config).
-
-
-  \#\#\#\# Closing behavior
-
-  By default the dialog automatically closes
-  *whenever a page fragment below the dialog is updated*.
-  This is useful to have the dialog interact with the page that
-  opened it, e.g. by updating parts of a larger form or by signing in a user
-  and revealing additional information.
-
-  To disable this behavior, give the opening link an `up-sticky` attribute:
-
-      <a href="/settings" up-modal=".options" up-sticky>Settings</a>
-
-
-  @method a[up-modal]
-  @ujs
+  @selector a[up-modal]
   @param [up-sticky]
   @param [up-animation]
   @param [up-height]
@@ -417,8 +438,7 @@ up.modal = (($) ->
   When this element is clicked, closes a currently open dialog.
   Does nothing if no modal is currently open.
 
-  @method [up-close]
-  @ujs
+  @selector [up-close]
   ###
   up.on('click', '[up-close]', (event, $element) ->
     if $element.closest('.up-modal').length

data/lib/assets/javascripts/up/motion.js.coffee

@@ -41,8 +41,7 @@ up.motion = (($) ->
   ###*
   Sets default options for animations and transitions.
 
-  @method up.motion.config
-  @property
+  @property up.motion.config
   @param {Number} [config.duration=300]
   @param {Number} [config.delay=0]
   @param {String} [config.easing='ease']
@@ -105,7 +104,7 @@ up.motion = (($) ->
   the previous animation will instantly jump to its last frame before
   the new animation begins.
 
-  @method up.animate
+  @function up.animate
   @param {Element|jQuery|String} elementOrSelector
     The element to animate.
   @param {String|Function|Object} animation
@@ -145,7 +144,7 @@ up.motion = (($) ->
   attributes like `up-easing` or `up-duration`.
 
   @protected
-  @method up.motion.animateOptions
+  @function up.motion.animateOptions
   ###
   animateOptions = (allOptions, $element = null) ->
     allOptions = u.options(allOptions)
@@ -226,7 +225,7 @@ up.motion = (($) ->
 
   Does nothing if the given element is not currently animating.
   
-  @method up.motion.finish
+  @function up.motion.finish
   @param {Element|jQuery|String} elementOrSelector
   ###
   finish = (elementOrSelector) ->
@@ -291,7 +290,7 @@ up.motion = (($) ->
   - When the transition has finished, the clones are removed from the DOM and the new element is shown.
     The old element remains hidden in the DOM.
 
-  @method up.morph
+  @function up.morph
   @param {Element|jQuery|String} source
   @param {Element|jQuery|String} target
   @param {Function|String} transitionOrName
@@ -315,7 +314,7 @@ up.motion = (($) ->
     $old = $(source)
     $new = $(target)
 
-    parsedOptions = u.only(options, 'reveal', 'restoreScroll')
+    parsedOptions = u.only(options, 'reveal', 'restoreScroll', 'source')
     parsedOptions = u.extend(parsedOptions, animateOptions(options))
 
     if up.browser.canCssAnimation()
@@ -415,8 +414,8 @@ up.motion = (($) ->
 
       up.transition('cross-fade', ($old, $new, options) ->
         up.motion.when(
-          animate($old, 'fade-out', options),
-          animate($new, 'fade-in', options)
+          up.animate($old, 'fade-out', options),
+          up.animate($new, 'fade-in', options)
         )
       )
 
@@ -435,7 +434,7 @@ up.motion = (($) ->
   Calling [`up.animate`](/up.animate) with an object argument
   will take care of all these points.
 
-  @method up.transition
+  @function up.transition
   @param {String} name
   @param {Function} transition
   ###
@@ -447,10 +446,10 @@ up.motion = (($) ->
 
   Here is the definition of the pre-defined `fade-in` animation:
 
-      up.animation('fade-in', ($ghost, options) ->
-        $ghost.css(opacity: 0)
-        animate($ghost, { opacity: 1 }, options)
-      )
+      up.animation('fade-in', function($ghost, options) {
+        $ghost.css(opacity: 0);
+        up.animate($ghost, { opacity: 1 }, options);
+      })
 
   It is recommended that your definitions always end by calling
   calling [`up.animate`](/up.animate) with an object argument, passing along
@@ -468,7 +467,7 @@ up.motion = (($) ->
   Calling [`up.animate`](/up.animate) with an object argument
   will take care of all these points.
 
-  @method up.animation
+  @function up.animation
   @param {String} name
   @param {Function} animation
   ###
@@ -486,7 +485,7 @@ up.motion = (($) ->
   the combined promise will have a `resolve` method. This `resolve` method
   will resolve all the wrapped promises.
 
-  @method up.motion.when
+  @function up.motion.when
   @param promises...
   @return A new promise.
   ###
@@ -496,7 +495,7 @@ up.motion = (($) ->
   Returns a no-op animation or transition which has no visual effects
   and completes instantly.
 
-  @method up.motion.none
+  @function up.motion.none
   @return {Promise}
     A resolved promise
   ###