alongslide 0.9.5 → 0.9.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzNkYzVmNTViZjI3NzY3MTNhMzk1MGYwMWJlMmJiOTg3YjBkMTM0NA==
+    NjU4NGUyNzU1ODFlNDYxZWY1YWI4MWMzYzAzODY5Yzc2ZDkxNjJhNQ==
   data.tar.gz: !binary |-
-    ZjcyYzI2MzE2MGMxZTYzN2I3ZTQ0ODc1MDI2OGEyYjFhYzczZjZlOQ==
+    ZmUyNjc5YzMyZGNiNjBiZDM2YzhkODZmNmQwMjY1OThjNDBhZGMzZg==
 SHA512:
   metadata.gz: !binary |-
-    YjY1ZmJhMjAzZDg5Y2Y4ZWMxMmE0YTBhNjkzYmM1OTJkNWU5YWE4ODFhOGY0
-    MjZmN2I0YWIwOGQwYWQ4OTgwNjE5ZTFlOWMxMzkxNDIyYzgxODZmMjAyNDhl
-    YmNiZmY4MTM5ZTU3OTZmZGZiYjhiYzAzODM5NTE0ZDEzYmFlZTk=
+    NTU1YWZmMzUwNDBkMjVmMGI2OWIzYTk4NTIyNzE4OWE0NjlhYThjN2IxZWI1
+    YzdhZDQ3ZWFkZTMxMTFiM2EwY2MxOWYyZTc2YzExNmExYzJhNGFhNjJjNjFj
+    YTY3ZGFiZmZkYTk0YmY2ZDNmYTQ0OTBmYmQ2N2NkNjQzMmViZDc=
   data.tar.gz: !binary |-
-    YzkwMzZjNDM3YWJjNzFjZmY0NmUyMGQ4YzMyMGUwYzBlNTVjODgyMTg1MmQx
-    YThhZTdjNzUyNTE0MjY0NmNmYjQxYTlmMjkzY2FlZmU3Nzk1ZWMxYzM1NmQ2
-    MDAwMGJhODU5MmNkZDI5NzQ1NGNhZTU5NTNkYmMwMGE4MTI1NmY=
+    ZDljNmZiNzRiNWVjYjgzYzE2ZWQzNDg2YzljZTEyNjQyNDI2MWEwZjY0NmQ3
+    OGRmNGViNGMwMGZmYjg3YzY3NmZhZDhkOGQ5NzMzNjU1MWE0ZDYwM2I5OTRm
+    YjhkODFlNjU3YzllOWFlODIyNWRkNDlhNzNiMmU1ODdmNDk0MTc=

data/README.md

@@ -32,48 +32,11 @@ The gem includes both the Ruby and frontend components.
 
 ## Usage
 
-To use Alongslide, begin by setting up your view:
-
-```erb
-<article id="frames">
-	<div class="backgrounds"></div>
-	<div class="flow"></div>
-	<div class="panels"></div>
-</article>
-<div id="content" style="display: none">
-	<%= Alongslide::render(your_markdown_string) %>
-</div>
-```
-
-Where `your_markdown_string` is a string of Alongslide-flavored Markdown.
-
-Note that the Alongslide HTML is rendered into a hidden DOM element. The empty
-elements above are there for Alongslide's JS to write into.
-
-Then, once the page is loaded and ready, you can kick off the Alongslide render:
-
-```javascript
-MIN_WINDOW_WIDTH = 980
-window.alongslide = new Alongslide({
-  source: '#content',
-  to: '#frames'
-})
-frameAspect = FixedAspect.prototype.fitFrame(MIN_WINDOW_WIDTH)
-window.alongslide.render(frameAspect, function({
-	FixedAspect.prototype.fitPanels(frameAspect)
-}))
-```
+The best introduction to using Alongslide is by checking out the demo Rails app:
 
-For RegionFlow (our CSS Regions polyfill) to work properly, it is critical that
-_all_ styles and webfonts be loaded in browser memory before the Alongslide
-render begins. For that reason, it is recommend that you use the included
-`Styles.prototype.doLoad()` utility to force CSS to load (by loading it via
-Ajax and writing it to the DOM) and/or a tool such as
-[webfontloader](https://github.com/typekit/webfontloader).
+https://github.com/triplecanopy/alongslide-demo
 
-After the inital render, you can use `window.alongslide.refresh(frameAspect)`
-to update just the scroll positioning (after a window resize for example) without
-incurring the full cost of doing the layout over again. 
+This app demonstrates the minimum views, JS, and CSS needed to build an Alongslide site.
 
 ### Creating custom templates
 

data/alongslide.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name    = 'alongslide'
-  gem.version = '0.9.5'
+  gem.version = '0.9.6'
 
   gem.summary = "Create dynamic web layouts with an extended Markdown syntax"
   gem.description = "Create dynamic web layouts with an extended Markdown syntax"

data/app/assets/javascripts/alongslide/alongslide.coffee

@@ -46,7 +46,8 @@ class Alongslide
   # @param frameAspect - bounding box computed by FixedAspect
   # @param postRenderCallback - to be called when layout returns
   # 
-  render: (frameAspect, postRenderCallback) ->
+  render: (postRenderCallback) ->
+    frameAspect = FixedAspect.prototype.fitFrame(@layout.FRAME_WIDTH)
     @layout.render (lastFramePosition) =>
 
       @lastFramePosition = lastFramePosition
@@ -59,12 +60,15 @@ class Alongslide
       $(document).triggerHandler 'alongslide.ready', @frames
 
       @hashToPosition()
+      FixedAspect.prototype.fitPanels(frameAspect)
       postRenderCallback()
 
   # Refresh Skrollr only on resize events, as it's fast.
   # 
-  refresh: (frameAspect) ->
+  refresh: ->
+    frameAspect = FixedAspect.prototype.fitFrame(@layout.FRAME_WIDTH)
     @scrolling.render(frameAspect, @lastFramePosition)
+    FixedAspect.prototype.fitPanels(frameAspect)
 
   hashToPosition: ->
     hash = window.location.hash

data/app/assets/javascripts/alongslide/layout.coffee

@@ -21,6 +21,9 @@ class Alongslide::Layout
   IN_POINT_KEY: 'als-in-position'
   OUT_POINT_KEY: 'als-out-position'
 
+  # Corresponds to $fixed-frame-width in alongslide.sass
+  FRAME_WIDTH: 980
+
   # Pixel width of each frame == screen width.
   # 
   frameWidth: $(window).width()

data/app/assets/javascripts/alongslide/scrolling.coffee

@@ -205,7 +205,7 @@ class Alongslide::Scrolling
 
               # x translate
               translateBy = (offset - direction) * scale
-              translateByPx = Math.round(translateBy * Math.max($(window).width(), 980))
+              translateByPx = Math.round(translateBy * Math.max($(window).width(), alongslide.layout.FRAME_WIDTH))
               styles["#{prefix.css}transform"] =
                 "translate(#{translateByPx}px, 0) translateZ(0)"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alongslide
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Adam Florin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2014-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet