Fixed mistake in README and docs

The protocol functions were missing parameters and had misspelled variables.
Ramotion · Jul 12, 2016 · 44d99a9 · 44d99a9
1 parent a5778ae
commit 44d99a9
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -80,19 +80,19 @@ github "Ramotion/animated-tab-bar"
 
   ``` swift
     // method call when Tab Bar Item is selected
-    override func playAnimation(icon : UIImageView, textLable : UILabel) {
+    override func playAnimation(icon: UIImageView, textLabel: UILabel) {
       // add animation
     }
   ```  
   ``` swift
     // method call when Tab Bar Item is deselected
-    override func deselectAnimation(icon : UIImageView, textLable : UILabel, defaultTextColor : UIColor) {
+    override func deselectAnimation(icon: UIImageView, textLabel: UILabel, defaultTextColor: UIColor, defaultIconColor: UIColor) {
       // add animation
     }
   ```    
   ``` swift
     // method call when TabBarController did load
-    override func selectedState(icon : UIImageView, textLable : UILabel) {
+    override func selectedState(icon: UIImageView, textLabel: UILabel) {
       // set selected state  
     }
   ```
@@ -102,17 +102,17 @@ github "Ramotion/animated-tab-bar"
 ``` swift
 class RAMBounceAnimation : RAMItemAnimation {
 
-    override func playAnimation(icon : UIImageView, textLable : UILabel) {
+    override func playAnimation(icon: UIImageView, textLabel: UILabel) {
         playBounceAnimation(icon)
-        textLable.textColor = textSelectedColor
+        textLabel.textColor = textSelectedColor
     }
 
-    override func deselectAnimation(icon : UIImageView, textLable : UILabel, defaultTextColor : UIColor) {
-        textLable.textColor = defaultTextColor
+    override func deselectAnimation(icon: UIImageView, textLabel: UILabel, defaultTextColor: UIColor, defaultIconColor: UIColor) {
+        textLabel.textColor = defaultTextColor
     }
 
-    override func selectedState(icon : UIImageView, textLable : UILabel) {
-        textLable.textColor = textSelectedColor
+    override func selectedState(icon: UIImageView, textLabel: UILabel) {
+        textLabel.textColor = textSelectedColor
     }
 
     func playBounceAnimation(icon : UIImageView) {

diff --git a/docs/index.html b/docs/index.html
@@ -7,7 +7,7 @@
     <meta charset='utf-8'>
     <script src="js/jquery.min.js" defer></script>
     <script src="js/jazzy.js" defer></script>
-    
+
   </head>
   <body>
     <a title="RAMAnimatedTabBarDemo  Reference"></a>
@@ -60,7 +60,7 @@
       <article class="main-content">
         <section>
           <section class="section">
-            
+
             <p><img src="https://raw.githubusercontent.com/Ramotion/animated-tab-bar/master/header.png" alt="header"></p>
 <a href='#ramanimatedtabbarcontroller' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h1 id='ramanimatedtabbarcontroller'>RAMAnimatedTabBarController</h1>
 
@@ -75,7 +75,7 @@
 
 <p><img src="https://raw.githubusercontent.com/Ramotion/animated-tab-bar/master/Screenshots/tab-bar-icons-iphone-ramotion-animation-interface-design.gif" alt="Animation"></p>
 
-<p>The <a href="https://store.ramotion.com/product/iphone-6-mockups?utm_source=gthb&amp;utm_medium=special&amp;utm_campaign=animated-tab-bar">iPhone mockup</a> available <a href="https://store.ramotion.com/product/iphone-6-mockups?utm_source=gthb&amp;utm_medium=special&amp;utm_campaign=animated-tab-bar">here</a>.</p>
+<p>The <a href="https://store.ramotion.com/product/iphone-6-mockups?utm_source=gthb&amp;utm_medium=special&amp;utm_campaign=animated-tab-bar">iPhone mockup</a> avaiLabel <a href="https://store.ramotion.com/product/iphone-6-mockups?utm_source=gthb&amp;utm_medium=special&amp;utm_campaign=animated-tab-bar">here</a>.</p>
 
 <p>Screencast from our Demo</p>
 
@@ -140,17 +140,17 @@
 <li>Implement the methods in RAMItemAnimationProtocol:</li>
 </ol>
 <pre class="highlight swift"><code>    <span class="c1">// method call when Tab Bar Item is selected</span>
-    <span class="k">override</span> <span class="kd">func</span> <span class="nf">playAnimation</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLable</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">)</span> <span class="p">{</span>
+    <span class="k">override</span> <span class="kd">func</span> <span class="nf">playAnimation</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLabel</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">)</span> <span class="p">{</span>
       <span class="c1">// add animation</span>
     <span class="p">}</span>
 </code></pre>
 <pre class="highlight swift"><code>    <span class="c1">// method call when Tab Bar Item is deselected</span>
-    <span class="k">override</span> <span class="kd">func</span> <span class="nf">deselectAnimation</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLable</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">,</span> <span class="n">defaultTextColor</span> <span class="p">:</span> <span class="kt">UIColor</span><span class="p">)</span> <span class="p">{</span>
+    <span class="k">override</span> <span class="kd">func</span> <span class="nf">deselectAnimation</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLabel</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">,</span> <span class="n">defaultTextColor</span> <span class="p">:</span> <span class="kt">UIColor</span><span class="p">)</span> <span class="p">{</span>
       <span class="c1">// add animation</span>
     <span class="p">}</span>
 </code></pre>
 <pre class="highlight swift"><code>    <span class="c1">// method call when TabBarController did load</span>
-    <span class="k">override</span> <span class="kd">func</span> <span class="nf">selectedState</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLable</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">)</span> <span class="p">{</span>
+    <span class="k">override</span> <span class="kd">func</span> <span class="nf">selectedState</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLabel</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">)</span> <span class="p">{</span>
       <span class="c1">// set selected state  </span>
     <span class="p">}</span>
 </code></pre>
@@ -160,17 +160,17 @@
 </ol>
 <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">RAMBounceAnimation</span> <span class="p">:</span> <span class="kt">RAMItemAnimation</span> <span class="p">{</span>
 
-    <span class="k">override</span> <span class="kd">func</span> <span class="nf">playAnimation</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLable</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">)</span> <span class="p">{</span>
+    <span class="k">override</span> <span class="kd">func</span> <span class="nf">playAnimation</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLabel</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">)</span> <span class="p">{</span>
         <span class="nf">playBounceAnimation</span><span class="p">(</span><span class="n">icon</span><span class="p">)</span>
-        <span class="n">textLable</span><span class="o">.</span><span class="n">textColor</span> <span class="o">=</span> <span class="n">textSelectedColor</span>
+        <span class="n">textLabel</span><span class="o">.</span><span class="n">textColor</span> <span class="o">=</span> <span class="n">textSelectedColor</span>
     <span class="p">}</span>
 
-    <span class="k">override</span> <span class="kd">func</span> <span class="nf">deselectAnimation</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLable</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">,</span> <span class="n">defaultTextColor</span> <span class="p">:</span> <span class="kt">UIColor</span><span class="p">)</span> <span class="p">{</span>
-        <span class="n">textLable</span><span class="o">.</span><span class="n">textColor</span> <span class="o">=</span> <span class="n">defaultTextColor</span>
+    <span class="k">override</span> <span class="kd">func</span> <span class="nf">deselectAnimation</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLabel</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">,</span> <span class="n">defaultTextColor</span> <span class="p">:</span> <span class="kt">UIColor</span><span class="p">)</span> <span class="p">{</span>
+        <span class="n">textLabel</span><span class="o">.</span><span class="n">textColor</span> <span class="o">=</span> <span class="n">defaultTextColor</span>
     <span class="p">}</span>
 
-    <span class="k">override</span> <span class="kd">func</span> <span class="nf">selectedState</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLable</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">)</span> <span class="p">{</span>
-        <span class="n">textLable</span><span class="o">.</span><span class="n">textColor</span> <span class="o">=</span> <span class="n">textSelectedColor</span>
+    <span class="k">override</span> <span class="kd">func</span> <span class="nf">selectedState</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">,</span> <span class="nv">textLabel</span> <span class="p">:</span> <span class="kt">UILabel</span><span class="p">)</span> <span class="p">{</span>
+        <span class="n">textLabel</span><span class="o">.</span><span class="n">textColor</span> <span class="o">=</span> <span class="n">textSelectedColor</span>
     <span class="p">}</span>
 
     <span class="kd">func</span> <span class="nf">playBounceAnimation</span><span class="p">(</span><span class="nv">icon</span> <span class="p">:</span> <span class="kt">UIImageView</span><span class="p">)</span> <span class="p">{</span>