Skip to content

Commit d1fd91d

Browse files
chiciochicio
committed
Update docs 💡
1 parent 04c7829 commit d1fd91d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1343
-222
lines changed

‎CHANGELOG.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# Change Log
22
All changes to RangeUISlider will be documented in this file.
33

4+
## [4.0.0](https://github.com/chicio/RangeUISlider/releases/tag/4.0.0)
5+
Release date: 2022-07-15.
6+
7+
#### Adding
8+
- New slider delegate methods signature.
9+
10+
411
## [3.1.0](https://github.com/chicio/RangeUISlider/releases/tag/3.1.0)
512
Release date: 2022-03-24.
613

714
#### Fixed
8-
Increased Package.swift supported version
15+
- Increased Package.swift supported version
916

1017
## [3.0.3](https://github.com/chicio/RangeUISlider/releases/tag/3.0.3)
1118
Release date: 2021-12-02.

‎README.md

+19-23
Original file line numberDiff line numberDiff line change
@@ -135,33 +135,29 @@ You can access the range values in two ways, depending on the fact that you're u
135135
- for `SwiftUI`, use the `RangeSlider.minValueSelected` and `RangeSlider.maxValueSelected` binding values
136136

137137
#### UIKit - RangeUISliderDelegate
138-
To get the current values from the slider in a `UIKit` project, set the slider delegate property. The delegate of `RangeUISlider` must implement the `RangeUISliderDelegate` protocol, that has three methods:
138+
To get the current values from the slider in a `UIKit` project, set the slider delegate property. The delegate of `RangeUISlider` must implement the `RangeUISliderDelegate` protocol, that has three methods. See code below.
139139

140140
```swift
141-
142-
/**
143-
Calls the delegate when the user has started the change of the range.
144-
*/
145-
@objc optional func rangeChangeStarted()
146-
147-
/**
148-
Calls the delegate when the user is changing the range by moving the knobs.
141+
@objc public protocol RangeUISliderDelegate {
142+
/**
143+
Calls the delegate when the user has started the change of the range.
144+
*/
145+
@objc optional func rangeChangeStarted()
146+
147+
/**
148+
Calls the delegate when the user is changing the range by moving the knobs.
149149
150-
- parameter minValueSelected: the minimum value selected.
151-
- parameter maxValueSelected: the maximum value selected.
152-
- parameter slider: the slider on which the range has been modified.
153-
*/
154-
@objc optional func rangeIsChanging(minValueSelected: CGFloat, maxValueSelected: CGFloat, slider: RangeUISlider)
155-
156-
/**
157-
Calls the delegate when the user has finished the change of the range.
158-
159-
- parameter minValueSelected: the minimum value selected.
160-
- parameter maxValueSelected: the maximum value selected.
161-
- parameter slider: the slider on which the range has been modified.
162-
*/
163-
@objc func rangeChangeFinished(minValueSelected: CGFloat, maxValueSelected: CGFloat, slider: RangeUISlider)
150+
- parameter event: the change event data. See `RangeUISliderChangeEvent`.
151+
*/
152+
@objc optional func rangeIsChanging(event: RangeUISliderChangeEvent)
164153

154+
/**
155+
Calls the delegate when the user has finished the change of the range.
156+
157+
- parameter event: the change finish event data. See `RangeUISliderChangeFinishedEvent`.
158+
*/
159+
@objc func rangeChangeFinished(event: RangeUISliderChangeFinishedEvent)
160+
}
165161
```
166162

167163
#### SwiftUI - Binding values

‎Source/RangeUISliderDelegate.swift

+2-7
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,14 @@ import UIKit
2323
/**
2424
Calls the delegate when the user is changing the range by moving the knobs.
2525

26-
- parameter minValueSelected: the minimum value selected.
27-
- parameter maxValueSelected: the maximum value selected.
28-
- parameter slider: the slider on which the range has been modified.
26+
- parameter event: the change event data. See `RangeUISliderChangeEvent`.
2927
*/
3028
@objc optional func rangeIsChanging(event: RangeUISliderChangeEvent)
3129

3230
/**
3331
Calls the delegate when the user has finished the change of the range.
3432

35-
- parameter minValueSelected: the minimum value selected.
36-
- parameter maxValueSelected: the maximum value selected.
37-
- parameter slider: the slider on which the range has been modified.
38-
- parameter userInteraction: a boolean indicating if the interaction is from user (or a programattic change)
33+
- parameter event: the change finish event data. See `RangeUISliderChangeFinishedEvent`.
3934
*/
4035
@objc func rangeChangeFinished(event: RangeUISliderChangeFinishedEvent)
4136
}

‎Source/RangeUISliderDelegateEvents.swift

+3
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ import Foundation
2626
}
2727
}
2828

29+
/**
30+
A range change finished event.
31+
*/
2932
@objc public class RangeUISliderChangeFinishedEvent: NSObject {
3033
/// The minimum value selected.
3134
public let minValueSelected: CGFloat

‎docs/Classes.html

+64
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@
6969
<li class="nav-group-task">
7070
<a href="Classes/RangeUISlider.html">RangeUISlider</a>
7171
</li>
72+
<li class="nav-group-task">
73+
<a href="Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a>
77+
</li>
7278
<li class="nav-group-task">
7379
<a href="Classes/RangeUISliderComponents.html">RangeUISliderComponents</a>
7480
</li>
@@ -134,6 +140,64 @@ <h4>Declaration</h4>
134140
</section>
135141
</div>
136142
</li>
143+
<li class="item">
144+
<div>
145+
<code>
146+
<a name="/c:@M@RangeUISlider@objc(cs)RangeUISliderChangeEvent"></a>
147+
<a name="//apple_ref/swift/Class/RangeUISliderChangeEvent" class="dashAnchor"></a>
148+
<a class="token" href="#/c:@M@RangeUISlider@objc(cs)RangeUISliderChangeEvent">RangeUISliderChangeEvent</a>
149+
</code>
150+
</div>
151+
<div class="height-container">
152+
<div class="pointer-container"></div>
153+
<section class="section">
154+
<div class="pointer"></div>
155+
<div class="abstract">
156+
<p>A range change event.</p>
157+
158+
<a href="Classes/RangeUISliderChangeEvent.html" class="slightly-smaller">See more</a>
159+
</div>
160+
<div class="declaration">
161+
<h4>Declaration</h4>
162+
<div class="language">
163+
<p class="aside-title">Swift</p>
164+
<pre class="highlight swift"><code><span class="kd">@objc</span>
165+
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">RangeUISliderChangeEvent</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
166+
167+
</div>
168+
</div>
169+
</section>
170+
</div>
171+
</li>
172+
<li class="item">
173+
<div>
174+
<code>
175+
<a name="/c:@M@RangeUISlider@objc(cs)RangeUISliderChangeFinishedEvent"></a>
176+
<a name="//apple_ref/swift/Class/RangeUISliderChangeFinishedEvent" class="dashAnchor"></a>
177+
<a class="token" href="#/c:@M@RangeUISlider@objc(cs)RangeUISliderChangeFinishedEvent">RangeUISliderChangeFinishedEvent</a>
178+
</code>
179+
</div>
180+
<div class="height-container">
181+
<div class="pointer-container"></div>
182+
<section class="section">
183+
<div class="pointer"></div>
184+
<div class="abstract">
185+
<p>A range change finished event.</p>
186+
187+
<a href="Classes/RangeUISliderChangeFinishedEvent.html" class="slightly-smaller">See more</a>
188+
</div>
189+
<div class="declaration">
190+
<h4>Declaration</h4>
191+
<div class="language">
192+
<p class="aside-title">Swift</p>
193+
<pre class="highlight swift"><code><span class="kd">@objc</span>
194+
<span class="kd">public</span> <span class="kd">class</span> <span class="kt">RangeUISliderChangeFinishedEvent</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
195+
196+
</div>
197+
</div>
198+
</section>
199+
</div>
200+
</li>
137201
<li class="item">
138202
<div>
139203
<code>

‎docs/Classes/Bar.html

+6
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@
6969
<li class="nav-group-task">
7070
<a href="../Classes/RangeUISlider.html">RangeUISlider</a>
7171
</li>
72+
<li class="nav-group-task">
73+
<a href="../Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a>
77+
</li>
7278
<li class="nav-group-task">
7379
<a href="../Classes/RangeUISliderComponents.html">RangeUISliderComponents</a>
7480
</li>

‎docs/Classes/Gradient.html

+6
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@
6969
<li class="nav-group-task">
7070
<a href="../Classes/RangeUISlider.html">RangeUISlider</a>
7171
</li>
72+
<li class="nav-group-task">
73+
<a href="../Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a>
77+
</li>
7278
<li class="nav-group-task">
7379
<a href="../Classes/RangeUISliderComponents.html">RangeUISliderComponents</a>
7480
</li>

‎docs/Classes/Knob.html

+6
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@
6969
<li class="nav-group-task">
7070
<a href="../Classes/RangeUISlider.html">RangeUISlider</a>
7171
</li>
72+
<li class="nav-group-task">
73+
<a href="../Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a>
77+
</li>
7278
<li class="nav-group-task">
7379
<a href="../Classes/RangeUISliderComponents.html">RangeUISliderComponents</a>
7480
</li>

‎docs/Classes/KnobComponents.html

+6
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@
6969
<li class="nav-group-task">
7070
<a href="../Classes/RangeUISlider.html">RangeUISlider</a>
7171
</li>
72+
<li class="nav-group-task">
73+
<a href="../Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a>
77+
</li>
7278
<li class="nav-group-task">
7379
<a href="../Classes/RangeUISliderComponents.html">RangeUISliderComponents</a>
7480
</li>

‎docs/Classes/Knobs.html

+6
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@
6969
<li class="nav-group-task">
7070
<a href="../Classes/RangeUISlider.html">RangeUISlider</a>
7171
</li>
72+
<li class="nav-group-task">
73+
<a href="../Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a>
77+
</li>
7278
<li class="nav-group-task">
7379
<a href="../Classes/RangeUISliderComponents.html">RangeUISliderComponents</a>
7480
</li>

‎docs/Classes/ProgressViews.html

+6
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@
6969
<li class="nav-group-task">
7070
<a href="../Classes/RangeUISlider.html">RangeUISlider</a>
7171
</li>
72+
<li class="nav-group-task">
73+
<a href="../Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a>
77+
</li>
7278
<li class="nav-group-task">
7379
<a href="../Classes/RangeUISliderComponents.html">RangeUISliderComponents</a>
7480
</li>

‎docs/Classes/RangeSliderCoordinator.html

+26-8
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@
6969
<li class="nav-group-task">
7070
<a href="../Classes/RangeUISlider.html">RangeUISlider</a>
7171
</li>
72+
<li class="nav-group-task">
73+
<a href="../Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a>
77+
</li>
7278
<li class="nav-group-task">
7379
<a href="../Classes/RangeUISliderComponents.html">RangeUISliderComponents</a>
7480
</li>
@@ -116,9 +122,9 @@ <h1>RangeSliderCoordinator</h1>
116122
<li class="item">
117123
<div>
118124
<code>
119-
<a name="/s:13RangeUISlider0A17SliderCoordinatorC15rangeIsChanging16minValueSelected03maxiJ06slidery12CoreGraphics7CGFloatV_Aj2ACtF"></a>
120-
<a name="//apple_ref/swift/Method/rangeIsChanging(minValueSelected:maxValueSelected:slider:)" class="dashAnchor"></a>
121-
<a class="token" href="#/s:13RangeUISlider0A17SliderCoordinatorC15rangeIsChanging16minValueSelected03maxiJ06slidery12CoreGraphics7CGFloatV_Aj2ACtF">rangeIsChanging(minValueSelected:<wbr>maxValueSelected:<wbr>slider:<wbr>)</a>
125+
<a name="/s:13RangeUISlider0A17SliderCoordinatorC15rangeIsChanging5eventyAA0aB11ChangeEventC_tF"></a>
126+
<a name="//apple_ref/swift/Method/rangeIsChanging(event:)" class="dashAnchor"></a>
127+
<a class="token" href="#/s:13RangeUISlider0A17SliderCoordinatorC15rangeIsChanging5eventyAA0aB11ChangeEventC_tF">rangeIsChanging(event:<wbr>)</a>
122128
</code>
123129
</div>
124130
<div class="height-container">
@@ -133,7 +139,7 @@ <h1>RangeSliderCoordinator</h1>
133139
<h4>Declaration</h4>
134140
<div class="language">
135141
<p class="aside-title">Swift</p>
136-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">rangeIsChanging</span><span class="p">(</span><span class="nv">minValueSelected</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">,</span> <span class="nv">maxValueSelected</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">,</span> <span class="nv">slider</span><span class="p">:</span> <span class="kt"><a href="../Classes/RangeUISlider.html">RangeUISlider</a></span><span class="p">)</span></code></pre>
142+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">rangeIsChanging</span><span class="p">(</span><span class="nv">event</span><span class="p">:</span> <span class="kt"><a href="../Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a></span><span class="p">)</span></code></pre>
137143

138144
</div>
139145
</div>
@@ -186,9 +192,9 @@ <h4>Parameters</h4>
186192
<li class="item">
187193
<div>
188194
<code>
189-
<a name="/s:13RangeUISlider0A17SliderCoordinatorC19rangeChangeFinished16minValueSelected03maxiJ06slidery12CoreGraphics7CGFloatV_Aj2ACtF"></a>
190-
<a name="//apple_ref/swift/Method/rangeChangeFinished(minValueSelected:maxValueSelected:slider:)" class="dashAnchor"></a>
191-
<a class="token" href="#/s:13RangeUISlider0A17SliderCoordinatorC19rangeChangeFinished16minValueSelected03maxiJ06slidery12CoreGraphics7CGFloatV_Aj2ACtF">rangeChangeFinished(minValueSelected:<wbr>maxValueSelected:<wbr>slider:<wbr>)</a>
195+
<a name="/s:13RangeUISlider0A17SliderCoordinatorC19rangeChangeFinished5eventyAA0abfG5EventC_tF"></a>
196+
<a name="//apple_ref/swift/Method/rangeChangeFinished(event:)" class="dashAnchor"></a>
197+
<a class="token" href="#/s:13RangeUISlider0A17SliderCoordinatorC19rangeChangeFinished5eventyAA0abfG5EventC_tF">rangeChangeFinished(event:<wbr>)</a>
192198
</code>
193199
</div>
194200
<div class="height-container">
@@ -203,7 +209,7 @@ <h4>Parameters</h4>
203209
<h4>Declaration</h4>
204210
<div class="language">
205211
<p class="aside-title">Swift</p>
206-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">rangeChangeFinished</span><span class="p">(</span><span class="nv">minValueSelected</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">,</span> <span class="nv">maxValueSelected</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">,</span> <span class="nv">slider</span><span class="p">:</span> <span class="kt"><a href="../Classes/RangeUISlider.html">RangeUISlider</a></span><span class="p">)</span></code></pre>
212+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">rangeChangeFinished</span><span class="p">(</span><span class="nv">event</span><span class="p">:</span> <span class="kt"><a href="../Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a></span><span class="p">)</span></code></pre>
207213

208214
</div>
209215
</div>
@@ -247,6 +253,18 @@ <h4>Parameters</h4>
247253
</div>
248254
</td>
249255
</tr>
256+
<tr>
257+
<td>
258+
<code>
259+
<em>userInteraction</em>
260+
</code>
261+
</td>
262+
<td>
263+
<div>
264+
<p>a boolean indicating if the change comes from user interaction</p>
265+
</div>
266+
</td>
267+
</tr>
250268
</tbody>
251269
</table>
252270
</div>

‎docs/Classes/RangeUISlider.html

+6
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@
6969
<li class="nav-group-task">
7070
<a href="../Classes/RangeUISlider.html">RangeUISlider</a>
7171
</li>
72+
<li class="nav-group-task">
73+
<a href="../Classes/RangeUISliderChangeEvent.html">RangeUISliderChangeEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Classes/RangeUISliderChangeFinishedEvent.html">RangeUISliderChangeFinishedEvent</a>
77+
</li>
7278
<li class="nav-group-task">
7379
<a href="../Classes/RangeUISliderComponents.html">RangeUISliderComponents</a>
7480
</li>

0 commit comments

Comments
 (0)