--------------------------------------------------------------------------------
/Documentation/Style.md:
--------------------------------------------------------------------------------
1 | # Advanded Style Guide
2 |
3 | Since `RESegmentedControl` can be stylized only in code, there are couple of options you can consider to avoid code dublication. The easiest option is to write an extension for `BootstapPreset` and configure it for your needs.
4 |
5 | ``` Swift
6 | extension BootstapPreset {
7 | mutating func configure() {
8 | self.segmentItemBorderWidth = 1
9 | self.segmentItemBorderColor = .gray
10 |
11 | self.textFont = UIFont.systemFont(ofSize: 11, weight: .bold)
12 | self.selectedTextFont = UIFont.systemFont(ofSize: 11, weight: .bold)
13 | }
14 | }
15 |
16 | //ViewController
17 | var preset = BootstapPreset(backgroundColor: .white, selectedBackgroundColor: .red)
18 | preset.configure()
19 |
20 | segmentedControl.configure(segmentItems: items, preset: preset)
21 | ```
22 |
23 | ### Creating a Preset
24 |
25 | A better option is to create a **preset**, while it requires more time and code but is more reusable.
26 |
27 | To create a **preset**, create a `struct` and inherit from the `SegmentedControlPresettable` protocol.
28 |
29 | ``` Swift
30 | struct DarkPreset: SegmentedControlPresettable
31 | ```
32 |
33 | `SegmentedControlPresettable` protocol contains three main styles that you need to implement in your **preset**:
34 |
35 | ``` Swift
36 | struct DarkPreset: SegmentedControlPresettable {
37 |
38 | /// Segmented control style
39 | public var segmentStyle: SegmentStylable
40 |
41 | /// Segment item style
42 | public var segmentItemStyle: SegmentItemStylable
43 |
44 | /// Selected segment item style
45 | public var segmentSelectedItemStyle: SegmentSelectedItemStylable
46 |
47 | }
48 | ```
49 |
50 | Initiate and configure styles for your needs. It’s possible to use existing ***styles*** structs that already inherit from `Stylable` protocols.
51 |
52 | ``` Swift
53 | import UIKit
54 |
55 | public struct DarkPreset: SegmentedControlPresettable {
56 |
57 | /// Segmented control style
58 | public var segmentStyle: SegmentStylable
59 |
60 | /// Segment item style
61 | public var segmentItemStyle: SegmentItemStylable
62 |
63 | /// Selected segment item style
64 | public var segmentSelectedItemStyle: SegmentSelectedItemStylable
65 |
66 | public init(backgroundColor: UIColor = .white,
67 | selectedBackgroundColor: UIColor = .yellow) {
68 | segmentStyle = SegmentStyle()
69 | segmentItemStyle = SegmentItemStyle(backgroundColor: backgroundColor)
70 | segmentSelectedItemStyle = SegmentSelectedItemStyle(backgoundColor: selectedBackgroundColor)
71 | }
72 |
73 | }
74 | ```
75 |
76 | > *For more information, see `BootstapPreset` and `MaterialPreset` in the demo project.*
77 |
78 | Then use your preset in `SegmentedControl`:
79 |
80 | ``` Swift
81 | //ViewController
82 | let preset = DarkPreset(backgroundColor: .white, selectedBackgroundColor: .red)
83 | segmentedControl.configure(segmentItems: items, preset: preset)
84 | ```
85 |
86 | > To learn more see a full 
27 |
28 | ## How to use
29 |
30 | - Import **RESegmentedControl** to your class:
31 |
32 | ``` Swift
33 | import RESegmentedControl
34 | ```
35 |
36 | - Add `UIView` to Storyboard's ViewController. Change class and module to `RESegmentedControl` and @IBOutlet to your ViewController:
37 |
38 | 
39 |
40 | ``` Swift
41 | /// Segmented Control
42 | @IBOutlet weak var segmentedControl: RESegmentedControl!
43 | ```
44 |
45 | *or create a `RESegmentedControl` programmatically:*
46 |
47 | ``` Swift
48 | let segmentedControl = RESegmentedControl(frame: CGRect(x: 0, y: 0, width: 200, height: 44))
49 | self.view.addSubview(segmentedControl)
50 | // TODO: Add segmentedControl Auto-Layouts…
51 | ```
52 |
53 | - Configure your segmentedControl with items and preset:
54 |
55 | ``` Swift
56 | // Specify a list of string that will be shown
57 | let titles = ["safari", "chrome", "firefox"]
58 |
59 | // Map a list of string to the [SegmentModel]
60 | var segmentItems: [SegmentModel] {
61 | return titles.map({ SegmentModel(title: $0) })
62 | }
63 |
64 | // Create a preset to style the segmentedControl
65 | let preset = BootstapPreset(backgroundColor: .white, selectedBackgroundColor: .black)
66 |
67 | // segmentedControl configuration method
68 | segmentedControl.configure(segmentItems: segmentItems, preset: preset)
69 | ```
70 |
71 | > *To learn more, take a look at the demo project.*
72 |
73 | ## Layout Types
74 |
75 | 
76 |
77 | `RESegmentedControl` initialize with a list of `SegmentModel`. `RESegmentedControl ` could be shown in three ways, with text only, image only or with text and image.
78 |
79 | - To show segments with **text**, initiate a `SegmentModel` with `title` variable:
80 |
81 | ``` Swift
82 | let segmentsItem: [SegmentModel] = [SegmentModel(title: “Title”)]
83 | ```
84 | - To show **image**, initiate a `SegmentModel` with `imageName` variable:
85 |
86 | ``` Swift
87 | let segmentsItem: [SegmentModel] = [SegmentModel(imageName: “imageNameInAseetCatalog”)]
88 | ```
89 | initiate a `SegmentModel` with `imageUrl` variable to load **image** from remote server:
90 |
91 | ``` Swift
92 | let imageUrl = “https://domain.com/image.png”
93 | let segmentsItem: [SegmentModel] = [SegmentModel(imageUrl: imageUrl)]
94 | ```
95 | - To show **text** and **image**, initiate a `SegmentModel` with `title` and `imageName` or `imageUrl` variable:
96 |
97 | ``` Swift
98 | let segmentsItem: [SegmentModel] = [SegmentModel(title: “Title”, imageName: “imageNameInAseetCatalog”)]
99 |
100 | // Image remote location url
101 | let imageUrl = “https://domain.com/image.png”
102 | let segmentsItem: [SegmentModel] = [SegmentModel(title: “Title”, imageUrl: imageUrl)]
103 | ```
104 | > *For more information, see `BasicExampleViewController` in the demo project.*
105 |
106 | ## API
107 |
108 | 
109 |
110 | - Dynamically adds item:
111 |
112 | ``` Swift
113 | func addItem(_ item: SegmentModel, atIndex index: Int? = nil)
114 | ```
115 |
116 | - Dynamically removes item:
117 |
118 | ``` Swift
119 | func removeItem(atIndex index: Int? = nil)
120 | ```
121 |
122 | - Returns segment items count:
123 |
124 | ``` Swift
125 | var segmentItemsCount: Int
126 | ```
127 |
128 | - Returns or dynamically changes selected index:
129 |
130 | ``` Swift
131 | var selectedSegmentIndex: Int
132 | ```
133 |
134 | - Deselects selected segment item:
135 |
136 | ``` Swift
137 | func deselect()
138 | ```
139 |
140 | - Replace segment item:
141 |
142 | ``` Swift
143 | func replaceItem(_ item: SegmentModel, atIndex index: Int)
144 | ```
145 |
146 | > *For more information, see `ActionViewController` in the demo project.*
147 |
148 | ## Presets and Styles
149 |
150 | 
151 |
152 | `RESegmentedControl` supports a wide range of customization appearance. It is also possible to apply ready-made presets of styles or create your own preset.
153 |
154 | Currently 4 presets are available:
155 |
156 | - iOS7Preset - Stylizes to iOS7 system style.
157 |
158 | ``` swift
159 | struct iOS7Preset: SegmentedControlPresettable
160 | ```
161 | - iOS13Preset - Stylizes to iOS13 system style.
162 |
163 | ``` swift
164 | struct iOS13Preset: SegmentedControlPresettable
165 | ```
166 | - MaterialPreset - Stylizes to Material style.
167 |
168 | ``` swift
169 | struct MaterialPreset: SegmentedControlPresettable
170 | ```
171 |
172 | - BootstapPreset - Preset with minimal pre-stylization, designed to customize the preset to fit your needs.
173 |
174 | ``` swift
175 | struct BootstapPreset: SegmentedControlPresettable
176 | ```
177 |
178 | > *For more information, see `PresetsViewController` in the demo project.*
179 |
180 |
181 |
182 | To learn more about how to create a preset, follow the [**Advanced Style Guide**](/Documentation/Style.md).
183 |
184 |
185 | ## Installation
186 |
187 | To learn more see a full 
24 | Data Extension Reference
25 | Data
172 |
173 |
178 |
179 |
174 |
177 | extension Data
182 |
212 | -
183 |
-
184 | 185 |191 |
186 | 187 | 188 | hexEncodedString() 189 |190 |192 | 193 |209 |194 | 195 | 208 |196 |199 |Undocumented
197 | 198 |200 |207 |Declaration
201 |202 |206 |Swift
203 |
204 | 205 |func hexEncodedString() -> String
210 |