Skip to content
This repository has been archived by the owner on Jan 19, 2022. It is now read-only.

Commit

Permalink
Merge pull request #170 from luispadron/features/v6.0.0
Browse files Browse the repository at this point in the history 
Version 6.0.0
  • Loading branch information
@luispadron
luispadron committed Feb 22, 2019
2 parents e454856 + 3f62ae2 commit 332ea72
Show file tree
Hide file tree
Showing 52 changed files with 1,223 additions and 1,310 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
@@ -1,3 +1,13 @@
# Version 6.0.0

- Fixed issue with API of `UICircularRingStyle` which made it impossible to have both a gradient and outer ring style, etc.
- Refactor way that `UICircularRingValueFormatter` works. It's now a simple protocol which anyone can conform to. There are two concrete implementations from 5.0.0 which can still be used, however, they're now `struct`s so cannot be mutated.

### Breaking Changes

- Due to the fact that both the `.style` property now doesnt allow setting `.gradient`, this API has been broken. Instead, use the new `.gradientOptions` property to set a gradient, and `.style` if you need extra styling on top of gradient
- Because the value formatter are now structs, they cannot be modified with `.` syntax. Instead create a brand new formatter and assign to the `.valueFormatter` property. This will be over all much better in the future, less state and structs are cool!

# Version 5.1.0

*wow bug fixes already?*
Expand Down
2 changes: 1 addition & 1 deletion UICircularProgressRing.podspec
View file
Expand Up @@ -2,7 +2,7 @@
Pod::Spec.new do |s|

s.name = "UICircularProgressRing"
s.version = "5.1.0"
s.version = "6.0.0"
s.summary = "A highly customizable circular progress bar for iOS written in Swift"

s.description = <<-DESC
Expand Down
154 changes: 12 additions & 142 deletions docs/Classes.html
View file
Expand Up @@ -14,7 +14,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">UICircularProgressRing Docs</a> (97% documented)</p>
<p><a href="index.html">UICircularProgressRing Docs</a> (96% documented)</p>
<p class="header-right"><a href="https://github.com/luispadron/UICircularProgressRing"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand All @@ -34,24 +34,15 @@
<li class="nav-group-task">
<a href="Classes/UICircularProgressRing.html">UICircularProgressRing</a>
</li>
<li class="nav-group-task">
<a href="Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a>
</li>
<li class="nav-group-task">
<a href="Classes/UICircularRing.html">UICircularRing</a>
</li>
<li class="nav-group-task">
<a href="Classes/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a>
</li>
<li class="nav-group-task">
<a href="Classes/UICircularTimerRing.html">UICircularTimerRing</a>
</li>
<li class="nav-group-task">
<a href="Classes/UICircularTimerRing/State.html">– State</a>
</li>
<li class="nav-group-task">
<a href="Classes/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -71,17 +62,26 @@
<li class="nav-group-task">
<a href="Protocols/UICircularProgressRingDelegate.html">UICircularProgressRingDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/UICircularGradientOptions.html">UICircularGradientOptions</a>
<a href="Structs/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a>
</li>
<li class="nav-group-task">
<a href="Structs/UICircularRingGradientOptions.html">UICircularRingGradientOptions</a>
</li>
<li class="nav-group-task">
<a href="Structs/UICircularRingValueKnobStyle.html">UICircularRingValueKnobStyle</a>
</li>
<li class="nav-group-task">
<a href="Structs/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -172,136 +172,6 @@ <h4>Declaration</h4>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/UICircularRingValueFormatter"></a>
<a name="//apple_ref/swift/Section/UICircularRingValueFormatter" class="dashAnchor"></a>
<a href="#/UICircularRingValueFormatter">
<h3 class="section-name">UICircularRingValueFormatter</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@UICircularProgressRing@objc(cs)UICircularRingValueFormatter"></a>
<a name="//apple_ref/swift/Class/UICircularRingValueFormatter" class="dashAnchor"></a>
<a class="token" href="#/c:@M@UICircularProgressRing@objc(cs)UICircularRingValueFormatter">UICircularRingValueFormatter</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>UICricularRingValueFormatter</p>

<p>The base class for all the UICircularRing formatters.
Subclasses should implement <code>string(forValue:)</code> as this is used
to format the value into a string in the base class</p>

<p>Two concrete implementations are provided, refer to <code><a href="Classes/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a></code>
and <code><a href="Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a></code></p>

<a href="Classes/UICircularRingValueFormatter.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">UICircularRingValueFormatter</span> <span class="p">:</span> <span class="kt">Formatter</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/UICircularTimerRingFormatter"></a>
<a name="//apple_ref/swift/Section/UICircularTimerRingFormatter" class="dashAnchor"></a>
<a href="#/UICircularTimerRingFormatter">
<h3 class="section-name">UICircularTimerRingFormatter</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@UICircularProgressRing@objc(cs)UICircularTimerRingFormatter"></a>
<a name="//apple_ref/swift/Class/UICircularTimerRingFormatter" class="dashAnchor"></a>
<a class="token" href="#/c:@M@UICircularProgressRing@objc(cs)UICircularTimerRingFormatter">UICircularTimerRingFormatter</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>UICircularTimerRingFormatter</p>

<p>The formatter used in UICircularTimerRing class, formats
the ring value into a time string.</p>

<a href="Classes/UICircularTimerRingFormatter.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">UICircularTimerRingFormatter</span> <span class="p">:</span> <span class="kt"><a href="Classes/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a></span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/UICircularProgressRingFormatter"></a>
<a name="//apple_ref/swift/Section/UICircularProgressRingFormatter" class="dashAnchor"></a>
<a href="#/UICircularProgressRingFormatter">
<h3 class="section-name">UICircularProgressRingFormatter</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRingFormatter"></a>
<a name="//apple_ref/swift/Class/UICircularProgressRingFormatter" class="dashAnchor"></a>
<a class="token" href="#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRingFormatter">UICircularProgressRingFormatter</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>UICircularProgressRingFormatter</p>

<p>The formatter used in UICircularProgressRing class,
responsible for formatting the value of the ring into a readable string</p>

<a href="Classes/UICircularProgressRingFormatter.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">public</span> <span class="kd">class</span> <span class="kt">UICircularProgressRingFormatter</span> <span class="p">:</span> <span class="kt"><a href="Classes/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a></span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
Expand Down Expand Up @@ -337,7 +207,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2019 <a class="link" href="https://luispadron.com" target="_blank" rel="external">Luis</a>. All rights reserved. (Last updated: 2019-02-08)</p>
<p>&copy; 2019 <a class="link" href="https://luispadron.com" target="_blank" rel="external">Luis</a>. All rights reserved. (Last updated: 2019-02-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
32 changes: 16 additions & 16 deletions docs/Classes/UICircularProgressRing.html
View file
Expand Up @@ -14,7 +14,7 @@
<a title="UICircularProgressRing Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">UICircularProgressRing Docs</a> (97% documented)</p>
<p><a href="../index.html">UICircularProgressRing Docs</a> (96% documented)</p>
<p class="header-right"><a href="https://github.com/luispadron/UICircularProgressRing"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand All @@ -34,24 +34,15 @@
<li class="nav-group-task">
<a href="../Classes/UICircularProgressRing.html">UICircularProgressRing</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UICircularRing.html">UICircularRing</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UICircularTimerRing.html">UICircularTimerRing</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UICircularTimerRing/State.html">– State</a>
</li>
<li class="nav-group-task">
<a href="../Classes/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -71,17 +62,26 @@
<li class="nav-group-task">
<a href="../Protocols/UICircularProgressRingDelegate.html">UICircularProgressRingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/UICircularGradientOptions.html">UICircularGradientOptions</a>
<a href="../Structs/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a>
</li>
<li class="nav-group-task">
<a href="../Structs/UICircularRingGradientOptions.html">UICircularRingGradientOptions</a>
</li>
<li class="nav-group-task">
<a href="../Structs/UICircularRingValueKnobStyle.html">UICircularRingValueKnobStyle</a>
</li>
<li class="nav-group-task">
<a href="../Structs/UICircularTimerRingFormatter.html">UICircularTimerRingFormatter</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -340,9 +340,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:22UICircularProgressRingAAC14valueFormatterAA0abcE0Cvp"></a>
<a name="/s:22UICircularProgressRingAAC14valueFormatterAA0ac5ValueE0_pvp"></a>
<a name="//apple_ref/swift/Property/valueFormatter" class="dashAnchor"></a>
<a class="token" href="#/s:22UICircularProgressRingAAC14valueFormatterAA0abcE0Cvp">valueFormatter</a>
<a class="token" href="#/s:22UICircularProgressRingAAC14valueFormatterAA0ac5ValueE0_pvp">valueFormatter</a>
</code>
</div>
<div class="height-container">
Expand All @@ -354,7 +354,7 @@ <h4>Declaration</h4>
value of the progress ring into a readable text string
which is then displayed in the label of the ring.</p>

<p>Default formatter is of type <code><a href="../Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a></code>.</p>
<p>Default formatter is of type <code><a href="../Structs/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a></code>.</p>
<h2 id='author' class='heading'>Author</h2>

<p>Luis Padron</p>
Expand All @@ -364,7 +364,7 @@ <h2 id='author' class='heading'>Author</h2>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">valueFormatter</span><span class="p">:</span> <span class="kt"><a href="../Classes/UICircularProgressRingFormatter.html">UICircularProgressRingFormatter</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">valueFormatter</span><span class="p">:</span> <span class="kt"><a href="../Protocols/UICircularRingValueFormatter.html">UICircularRingValueFormatter</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -591,7 +591,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2019 <a class="link" href="https://luispadron.com" target="_blank" rel="external">Luis</a>. All rights reserved. (Last updated: 2019-02-08)</p>
<p>&copy; 2019 <a class="link" href="https://luispadron.com" target="_blank" rel="external">Luis</a>. All rights reserved. (Last updated: 2019-02-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down

0 comments on commit 332ea72

Please sign in to comment.