Skip to content

Commit

Permalink
Updated doc 💡
Browse files Browse the repository at this point in the history
  • Loading branch information
@chicio
chicio committed Sep 1, 2018
1 parent 72dd071 commit 1cc90d7
Show file tree
Hide file tree
Showing 14 changed files with 3,406 additions and 44 deletions.
4 changes: 2 additions & 2 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ <h4>Declaration</h4>
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@IBDesignable</span>
<span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">RangeUISlider</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>
<span class="kd">open</span> <span class="kd">class</span> <span class="kt">RangeUISlider</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>

</div>
</div>
Expand All @@ -91,7 +91,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-08-14)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-09-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
1,688 changes: 1,684 additions & 4 deletions docs/Classes/RangeUISlider.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Protocols.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-08-14)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-09-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/Protocols/RangeUISliderDelegate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-08-14)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-09-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/docsets/RangeUISlider.docset/Contents/Resources/Documents/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ <h4>Declaration</h4>
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@IBDesignable</span>
<span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">RangeUISlider</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>
<span class="kd">open</span> <span class="kd">class</span> <span class="kt">RangeUISlider</span> <span class="p">:</span> <span class="kt">UIView</span></code></pre>

</div>
</div>
Expand All @@ -91,7 +91,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-08-14)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-09-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
1,688 changes: 1,684 additions & 4 deletions docs/docsets/RangeUISlider.docset/Contents/Resources/Documents/Classes/RangeUISlider.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/docsets/RangeUISlider.docset/Contents/Resources/Documents/Protocols.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-08-14)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-09-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion ...ts/RangeUISlider.docset/Contents/Resources/Documents/Protocols/RangeUISliderDelegate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-08-14)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-09-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
27 changes: 14 additions & 13 deletions docs/docsets/RangeUISlider.docset/Contents/Resources/Documents/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ <h1 id='rangeuislider' class='heading'>RangeUISlider</h1>
<a href="https://cocoapods.org/pods/RangeUISlider"><img src="https://img.shields.io/cocoapods/metrics/doc-percent/RangeUISlider.svg" alt="CocoaPods Doc Coverage Percentage"></a>
<a href="https://img.shields.io/cocoapods/dt/RangeUISlider.svg"><img src="https://img.shields.io/cocoapods/dt/RangeUISlider.svg" alt="CocoaPods Download"></a></p>

<p>A highly customizable iOS range selection slider, developed using autolayout and completely customizable using IBDesignabled and IBInspectable.</p>
<p>A highly customizable iOS range selection slider, developed using autolayout and completely customizable using IBDesignabled and IBInspectable or programmatically.</p>

<hr>
<h3 id='installation' class='heading'>Installation</h3>
Expand Down Expand Up @@ -88,7 +88,9 @@ <h3 id='installation' class='heading'>Installation</h3>
<hr>
<h3 id='usage' class='heading'>Usage</h3>

<p>The step needed to use RangeUISlider are:</p>
<p>You can use RangeUISlider in two ways: in interface builder (thanks to<code>@IBDesignable</code> and <code>@IBInspectable</code>) or programmatically.
Then you can use the <code><a href="Protocols/RangeUISliderDelegate.html">RangeUISliderDelegate</a></code> protocol to get the values of the slider.</p>
<h4 id='interface-builder' class='heading'>Interface builder</h4>

<ul>
<li>drag a UIView into you storyboard</li>
Expand All @@ -100,11 +102,15 @@ <h3 id='usage' class='heading'>Usage</h3>
<li>start editing using interface builder</li>
</ul>

<p><a href="https://www.youtube.com/watch?v=Lorvozz-1HU" target="_blank">Here</a> you can find a video tutorial. </p>
<p><a href="https://www.youtube.com/watch?v=Lorvozz-1HU">Here</a> you can find a video tutorial for the setup with interface builder.</p>

<p align="center">
<a href="https://www.youtube.com/watch?v=Lorvozz-1HU" target="_blank"><img src="https://raw.githubusercontent.com/chicio/RangeUISlider/master/Screenshots/tutorial.png"></a>
</p>
<h4 id='programmatic' class='heading'>Programmatic</h4>

<p>You can also use RangeUISlider as a programmatic UI component by setting all the property you need in your code. Take a look at the <a href="https://github.com/chicio/RangeUISlider/blob/master/Demo/SetupProgrammaticViewController.swift">example in the SetupProgrammaticViewController contained in the demo project </a> to see an example of programmatic setup.</p>
<h4 id='rangeuisliderdelegate' class='heading'>RangeUISliderDelegate</h4>

<p>To get the current values from the slider, set its delegate property.
The delegate of the RangeUISlider must implement the <code><a href="Protocols/RangeUISliderDelegate.html">RangeUISliderDelegate</a></code> protocol, that has two methods:</p>
Expand All @@ -130,7 +136,7 @@ <h3 id='usage' class='heading'>Usage</h3>
</code></pre>

<hr>
<h3 id='customizable-property' class='heading'>Customizable property</h3>
<h4 id='customizable-property' class='heading'>Customizable property</h4>

<p>This is the list of the <strong>current customizable property of the RangeUISlider directly from Interface Builder using IBDesignable/IBInspectable</strong>:</p>

Expand Down Expand Up @@ -197,15 +203,10 @@ <h3 id='customizable-property' class='heading'>Customizable property</h3>
<li>container corners</li>
</ul>

<p>It is also possible to <strong>set programmatically the following properties</strong>:</p>
<hr>
<h3 id='documentation' class='heading'>Documentation</h3>

<ul>
<li>identifier of the slider (Int )</li>
<li>range minimum value (CGFloat)</li>
<li>range maximum value (CGFloat)</li>
<li>default starting value left knob (CGFloat)</li>
<li>default starting value right knob (CGFloat)</li>
</ul>
<p>You can find the complete api documentation on <a href="https://www.fabrizioduroni.it/RangeUISlider/" title="RangeUISlider doc">fabrizioduroni.it</a>.</p>

<hr>
<h3 id='examples' class='heading'>Examples</h3>
Expand All @@ -225,7 +226,7 @@ <h3 id='examples' class='heading'>Examples</h3>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-08-14)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-09-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/docsets/RangeUISlider.docset/Contents/Resources/Documents/search.json
View file

Large diffs are not rendered by default.

Binary file modified docs/docsets/RangeUISlider.docset/Contents/Resources/docSet.dsidx
View file
Binary file not shown.
Binary file modified docs/docsets/RangeUISlider.tgz
View file
Binary file not shown.
27 changes: 14 additions & 13 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ <h1 id='rangeuislider' class='heading'>RangeUISlider</h1>
<a href="https://cocoapods.org/pods/RangeUISlider"><img src="https://img.shields.io/cocoapods/metrics/doc-percent/RangeUISlider.svg" alt="CocoaPods Doc Coverage Percentage"></a>
<a href="https://img.shields.io/cocoapods/dt/RangeUISlider.svg"><img src="https://img.shields.io/cocoapods/dt/RangeUISlider.svg" alt="CocoaPods Download"></a></p>

<p>A highly customizable iOS range selection slider, developed using autolayout and completely customizable using IBDesignabled and IBInspectable.</p>
<p>A highly customizable iOS range selection slider, developed using autolayout and completely customizable using IBDesignabled and IBInspectable or programmatically.</p>

<hr>
<h3 id='installation' class='heading'>Installation</h3>
Expand Down Expand Up @@ -88,7 +88,9 @@ <h3 id='installation' class='heading'>Installation</h3>
<hr>
<h3 id='usage' class='heading'>Usage</h3>

<p>The step needed to use RangeUISlider are:</p>
<p>You can use RangeUISlider in two ways: in interface builder (thanks to<code>@IBDesignable</code> and <code>@IBInspectable</code>) or programmatically.
Then you can use the <code><a href="Protocols/RangeUISliderDelegate.html">RangeUISliderDelegate</a></code> protocol to get the values of the slider.</p>
<h4 id='interface-builder' class='heading'>Interface builder</h4>

<ul>
<li>drag a UIView into you storyboard</li>
Expand All @@ -100,11 +102,15 @@ <h3 id='usage' class='heading'>Usage</h3>
<li>start editing using interface builder</li>
</ul>

<p><a href="https://www.youtube.com/watch?v=Lorvozz-1HU" target="_blank">Here</a> you can find a video tutorial. </p>
<p><a href="https://www.youtube.com/watch?v=Lorvozz-1HU">Here</a> you can find a video tutorial for the setup with interface builder.</p>

<p align="center">
<a href="https://www.youtube.com/watch?v=Lorvozz-1HU" target="_blank"><img src="https://raw.githubusercontent.com/chicio/RangeUISlider/master/Screenshots/tutorial.png"></a>
</p>
<h4 id='programmatic' class='heading'>Programmatic</h4>

<p>You can also use RangeUISlider as a programmatic UI component by setting all the property you need in your code. Take a look at the <a href="https://github.com/chicio/RangeUISlider/blob/master/Demo/SetupProgrammaticViewController.swift">example in the SetupProgrammaticViewController contained in the demo project </a> to see an example of programmatic setup.</p>
<h4 id='rangeuisliderdelegate' class='heading'>RangeUISliderDelegate</h4>

<p>To get the current values from the slider, set its delegate property.
The delegate of the RangeUISlider must implement the <code><a href="Protocols/RangeUISliderDelegate.html">RangeUISliderDelegate</a></code> protocol, that has two methods:</p>
Expand All @@ -130,7 +136,7 @@ <h3 id='usage' class='heading'>Usage</h3>
</code></pre>

<hr>
<h3 id='customizable-property' class='heading'>Customizable property</h3>
<h4 id='customizable-property' class='heading'>Customizable property</h4>

<p>This is the list of the <strong>current customizable property of the RangeUISlider directly from Interface Builder using IBDesignable/IBInspectable</strong>:</p>

Expand Down Expand Up @@ -197,15 +203,10 @@ <h3 id='customizable-property' class='heading'>Customizable property</h3>
<li>container corners</li>
</ul>

<p>It is also possible to <strong>set programmatically the following properties</strong>:</p>
<hr>
<h3 id='documentation' class='heading'>Documentation</h3>

<ul>
<li>identifier of the slider (Int )</li>
<li>range minimum value (CGFloat)</li>
<li>range maximum value (CGFloat)</li>
<li>default starting value left knob (CGFloat)</li>
<li>default starting value right knob (CGFloat)</li>
</ul>
<p>You can find the complete api documentation on <a href="https://www.fabrizioduroni.it/RangeUISlider/" title="RangeUISlider doc">fabrizioduroni.it</a>.</p>

<hr>
<h3 id='examples' class='heading'>Examples</h3>
Expand All @@ -225,7 +226,7 @@ <h3 id='examples' class='heading'>Examples</h3>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-08-14)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/chicio/RangeUISlider" target="_blank" rel="external">chicio</a>. All rights reserved. (Last updated: 2018-09-02)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion docs/search.json
View file

Large diffs are not rendered by default.

0 comments on commit 1cc90d7

Please sign in to comment.