Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/ratchet.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Mulvey <kmulvey@linux.com>2015-02-10 15:40:14 +0300
committerXhmikosR <xhmikosr@gmail.com>2015-03-05 11:33:19 +0300
commitea65f13d3eea566e2d233ab791e0ab11affd68bb (patch)
treeacc6f7acbcb8daa5caca9c2ec02d3c44b2b90339
parent1b0c0fd11e6727e38c26335df02205dd4bf6f3a4 (diff)
Document manually calling `PUSH()`.
Closes #753.
-rw-r--r--docs/components.html7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/components.html b/docs/components.html
index 8ae2b77..476ddc1 100644
--- a/docs/components.html
+++ b/docs/components.html
@@ -1261,6 +1261,13 @@ document
window.addEventListener('push', myFunction);
{% endhighlight %}
+ <p class="component-description">Push.js can be triggered manually by using the PUSH(options) function. When passing options, url is required, container, transition and timeout are optional. As of version 2.1.0 Ratchet has its own namespace and can also be called with RATCHET.push(options).</p>
+
+{% highlight js %}
+PUSH({url: "/signin"});
+RATCHET.push({url: "/signin"});
+{% endhighlight %}
+
</article>
<!-- Ratchicons -->