Skip to content

Commit

Permalink
Made corrections in the text.
Browse files Browse the repository at this point in the history
  • Loading branch information
@minimind
minimind committed Mar 26, 2013
1 parent c457ac3 commit 1604115
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 37 deletions.
10 changes: 7 additions & 3 deletions README.md
View file
Expand Up @@ -12,7 +12,11 @@ groups of elements. Why use it? It looks nice and it's very easy to set up and u

You can download the latest version from here:

https://github.com/minimind/jquery.slideandfade
http://plugins.jquery.com/slideandfade

You can look at a demo and some basic instructions here:

http://www.ianmacinnes.net/blog/2013/03/26/jquery-plugin-to-slide-and-fade-elements/

There are a few simple examples in the index.html.
To use in your own page, place the jquery.slideandfade.min.js file where your web page can load it,
Expand All @@ -24,12 +28,12 @@ Here is an simple example of how a part of your web page might be set out:

```html
<div class="display-screen-description" id="display-screen">
<div class="displayBox" id="displayBox1_0">
<div class="displayBox" id="displayBox0">
<div class="fragment" id="a">The owl and the pussy cat</div>
<div class="fragment" id="b">Went to sea</div>
<div class="fragment" id="c">In a beautiful pea green boat</div>
</div>
<div class="displayBox" id="displayBox1_1">
<div class="displayBox" id="displayBox1">
<div class="fragment" id="d">They took some honey,</div>
<div class="fragment" id="e">And plenty of money</div>
<div class="fragment" id="f">Wrapped up in a five pound note.</div>
Expand Down
73 changes: 66 additions & 7 deletions css/main.css
View file
Expand Up @@ -151,10 +151,69 @@ div.fragment {

pre {
padding: 0 0 0 0;
margin: 0 10px 0 10px;
}

code {
padding: 0 0 0 0;
margin: 0 0 0 0;
}
margin: 0 30px 0 30px;
font-size: 12px;
}

.highlight .hll { /*background-color: #ffffcc*/ }
.highlight { /*background: #f8f8f8;*/ }
.highlight .c { color: #408080; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .m { color: #666666 } /* Literal.Number */
.highlight .s { color: #BA2121 } /* Literal.String */
.highlight .na { color: #7D9029 } /* Name.Attribute */
.highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.highlight .no { color: #880000 } /* Name.Constant */
.highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0000FF } /* Name.Function */
.highlight .nl { color: #A0A000 } /* Name.Label */
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #19177C } /* Name.Variable */
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #666666 } /* Literal.Number.Float */
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
.highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
67 changes: 40 additions & 27 deletions index.html
View file
@@ -1,4 +1,4 @@
<html xmlns="http://www.w3.org/1999/html">
<html xmlns="http://www.w3.org/1999/html" xmlns="http://www.w3.org/1999/html">
<head>
<title>Some examples for the jquery.slideandfade.js plugin</title>
<link rel="stylesheet" href="css/main.css" type="text/css" media="screen">
Expand All @@ -9,7 +9,11 @@
<body>
<div class="main-block">
<h1>Jquery plugin to slide and fade elements</h1>
<p>Author: <a href="http://www.ianmacinnes.net">Ian Macinnes</a></p>
<p>Author: <a href="http://www.ianmacinnes.net" target="_blank">Ian Macinnes</a></p>
<p>Docs: <a href="http://www.ianmacinnes.net/blog/2013/03/26/jquery-plugin-to-slide-and-fade-elements/"
target="_blank">Here</a></p>
<p>GitHub repo: <a href="https://github.com/minimind/jquery.slideandfade" target="_blank">Here</a></p>

<p>This page described the slide and fade jQuery plugin, which can be used as a very simple
and quick method of sliding whole groups of elements out of frame and moving other
ones in. It's under active development so please contact the author for fixes/suggestions etc.</p>
Expand All @@ -31,39 +35,48 @@ <h2>Moving groups of elements around</h2>
</div>
</div>
<p>Here's the HTML code for displaying the above box:</p>
<div class="codebox"><pre><code>
&lt;div class="display-screen"&gt;
&lt;div class="displayBox" id="displayBox0"&gt;
&lt;div class="fragment" id="a"&gt;The owl and the pussy cat&lt;/div&gt;
&lt;div class="fragment" id="b"&gt;Went to sea&lt;/div&gt;
&lt;div class="fragment" id="c"&gt;In a beautiful pea green boat&lt;/div&gt;
&lt;/div&gt;
&lt;div class="displayBox" id="displayBox1"&gt;
&lt;div class="fragment" id="d"&gt;They took some honey,&lt;/div&gt;
&lt;div class="fragment" id="e"&gt;And plenty of money&lt;/div&gt;
&lt;div class="fragment" id="f"&gt;Wrapped up in a five pound note.&lt;/div&gt;
&lt;/div&gt;
&lt;/div&gt;
</code></pre></div>

<div class="highlight"><pre><span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;display-screen-description&quot;</span> <span class="na">id=</span><span class="s">&quot;display-screen&quot;</span><span class="nt">&gt;</span>
&nbsp;&nbsp;<span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;displayBox&quot;</span> <span class="na">id=</span><span class="s">&quot;displayBox0&quot;</span><span class="nt">&gt;</span>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;fragment&quot;</span> <span class="na">id=</span><span class="s">&quot;a&quot;</span><span class="nt">&gt;</span>The owl and the pussy cat<span class="nt">&lt;/div&gt;</span>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;fragment&quot;</span> <span class="na">id=</span><span class="s">&quot;b&quot;</span><span class="nt">&gt;</span>Went to sea<span class="nt">&lt;/div&gt;</span>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;fragment&quot;</span> <span class="na">id=</span><span class="s">&quot;c&quot;</span><span class="nt">&gt;</span>In a beautiful pea green boat<span class="nt">&lt;/div&gt;</span>
&nbsp;&nbsp;<span class="nt">&lt;/div&gt;</span>
&nbsp;&nbsp;<span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;displayBox&quot;</span> <span class="na">id=</span><span class="s">&quot;displayBox1&quot;</span><span class="nt">&gt;</span>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;fragment&quot;</span> <span class="na">id=</span><span class="s">&quot;d&quot;</span><span class="nt">&gt;</span>They took some honey,<span class="nt">&lt;/div&gt;</span>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;fragment&quot;</span> <span class="na">id=</span><span class="s">&quot;e&quot;</span><span class="nt">&gt;</span>And plenty of money<span class="nt">&lt;/div&gt;</span>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">&quot;fragment&quot;</span> <span class="na">id=</span><span class="s">&quot;f&quot;</span><span class="nt">&gt;</span>Wrapped up in a five pound note.<span class="nt">&lt;/div&gt;</span>
&nbsp;&nbsp;<span class="nt">&lt;/div&gt;</span>
<span class="nt">&lt;/div&gt;</span>
</pre></div>

<p>
The code to move a particular display box into shot is:
</p>
<div class="codebox"><pre><code>
$('.display-screen').slideandfade($('#displayBox0'));
</code></pre></div>

<div class="highlight"><pre><span class="nx">$</span><span class="p">(</span><span class="s1">&#39;#display-screen&#39;</span><span class="p">).</span><span class="nx">slideandfade</span><span class="p">(</span><span class="nx">$</span><span class="p">(</span><span class="s1">&#39;#displayBox0&#39;</span><span class="p">));</span>
</pre></div>

<p>
You can also specify an optional callback for after the whole process is finished.
You use a settings dictionary to pass along various options.
Above, I use an option called callback to change toggle which text to display.
Above, I use an option called callback to toggle which text to display.
This callback is always called after the text has been moved into position.
</p>
<div class="codebox"><pre><code>
var screenToDisplay = 1;
$('.display-screen').click(function() {
var settings = {callback : function() { screenToDisplay = screenToDisplay == 0 ? 1 : 0; } };
$('.display-screen').slideandfade($('#displayBox'+screenToDisplay), settings );
});
</code></pre></div>

<div class="highlight"><pre><span class="kd">var</span> <span class="nx">screenToDisplay</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span>
<span class="nx">$</span><span class="p">(</span><span class="s1">&#39;#display-screen&#39;</span><span class="p">).</span><span class="nx">click</span><span class="p">(</span><span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
&nbsp;&nbsp;<span class="kd">var</span> <span class="nx">settings</span> <span class="o">=</span> <span class="p">{</span>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="nx">callback</span> <span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="nx">screenToDisplay</span> <span class="o">=</span> <span class="nx">screenToDisplay</span> <span class="o">===</span> <span class="mi">0</span> <span class="o">?</span> <span class="mi">1</span> <span class="o">:</span> <span class="mi">0</span><span class="p">;</span>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="p">}</span>
&nbsp;&nbsp;<span class="p">};</span>

&nbsp;&nbsp;<span class="nx">$</span><span class="p">(</span><span class="s1">&#39;.display-screen&#39;</span><span class="p">).</span><span class="nx">slideandfade</span><span class="p">(</span><span class="nx">$</span><span class="p">(</span><span class="s1">&#39;#displayBox&#39;</span> <span class="o">+</span> <span class="nx">screenToDisplay</span><span class="p">),</span>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="nx">settings</span><span class="p">);</span>
<span class="p">});</span>
</pre></div>

<p>It's also easy to have two slideandfade boxes on the same page:
<div class="display-screen-description" id="display-screen2">
<div class="displayBox" id="displayBox2_0">
Expand Down

0 comments on commit 1604115

Please sign in to comment.