Skip to content

Commit c5b0b49

Browse files
committed
Updated docs
1 parent 6cceac9 commit c5b0b49

File tree

12 files changed

+102
-14
lines changed

12 files changed

+102
-14
lines changed

Docs/Classes/ThemeManager.html

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -851,6 +851,47 @@ <h4>Declaration</h4>
851851
</li>
852852
</ul>
853853
</div>
854+
<div class="task-group">
855+
<div class="task-name-container">
856+
<a name="/Theme%20Switching"></a>
857+
<a name="//apple_ref/swift/Section/Theme Switching" class="dashAnchor"></a>
858+
<a href="#/Theme%20Switching">
859+
<h3 class="section-name">Theme Switching</h3>
860+
</a>
861+
</div>
862+
<ul>
863+
<li class="item">
864+
<div>
865+
<code>
866+
<a name="/s:8ThemeKit0A7ManagerC07animateA11TransitionsSbvp"></a>
867+
<a name="//apple_ref/swift/Property/animateThemeTransitions" class="dashAnchor"></a>
868+
<a class="token" href="#/s:8ThemeKit0A7ManagerC07animateA11TransitionsSbvp">animateThemeTransitions</a>
869+
</code>
870+
</div>
871+
<div class="height-container">
872+
<div class="pointer-container"></div>
873+
<section class="section">
874+
<div class="pointer"></div>
875+
<div class="abstract">
876+
<p>Animate theme transitions?</p>
877+
878+
</div>
879+
<div class="declaration">
880+
<h4>Declaration</h4>
881+
<div class="language">
882+
<p class="aside-title">Swift</p>
883+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">animateThemeTransitions</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span></code></pre>
884+
885+
</div>
886+
</div>
887+
<div class="slightly-smaller">
888+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L424">Show on GitHub</a>
889+
</div>
890+
</section>
891+
</div>
892+
</li>
893+
</ul>
894+
</div>
854895
<div class="task-group">
855896
<div class="task-name-container">
856897
<a name="/Notifications"></a>
@@ -885,7 +926,7 @@ <h4>Declaration</h4>
885926
</div>
886927
</div>
887928
<div class="slightly-smaller">
888-
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L552">Show on GitHub</a>
929+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L557">Show on GitHub</a>
889930
</div>
890931
</section>
891932
</div>
@@ -915,7 +956,7 @@ <h4>Declaration</h4>
915956
</div>
916957
</div>
917958
<div class="slightly-smaller">
918-
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L555">Show on GitHub</a>
959+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L560">Show on GitHub</a>
919960
</div>
920961
</section>
921962
</div>
@@ -945,7 +986,7 @@ <h4>Declaration</h4>
945986
</div>
946987
</div>
947988
<div class="slightly-smaller">
948-
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L558">Show on GitHub</a>
989+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L563">Show on GitHub</a>
949990
</div>
950991
</section>
951992
</div>

Docs/ThemeKit.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h4>Declaration</h4>
135135
</div>
136136
</div>
137137
<div class="slightly-smaller">
138-
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L23-L560">Show on GitHub</a>
138+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L23-L565">Show on GitHub</a>
139139
</div>
140140
</section>
141141
</div>

Docs/docsets/ThemeKit.docset/Contents/Resources/Documents/Classes/ThemeManager.html

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -851,6 +851,47 @@ <h4>Declaration</h4>
851851
</li>
852852
</ul>
853853
</div>
854+
<div class="task-group">
855+
<div class="task-name-container">
856+
<a name="/Theme%20Switching"></a>
857+
<a name="//apple_ref/swift/Section/Theme Switching" class="dashAnchor"></a>
858+
<a href="#/Theme%20Switching">
859+
<h3 class="section-name">Theme Switching</h3>
860+
</a>
861+
</div>
862+
<ul>
863+
<li class="item">
864+
<div>
865+
<code>
866+
<a name="/s:8ThemeKit0A7ManagerC07animateA11TransitionsSbvp"></a>
867+
<a name="//apple_ref/swift/Property/animateThemeTransitions" class="dashAnchor"></a>
868+
<a class="token" href="#/s:8ThemeKit0A7ManagerC07animateA11TransitionsSbvp">animateThemeTransitions</a>
869+
</code>
870+
</div>
871+
<div class="height-container">
872+
<div class="pointer-container"></div>
873+
<section class="section">
874+
<div class="pointer"></div>
875+
<div class="abstract">
876+
<p>Animate theme transitions?</p>
877+
878+
</div>
879+
<div class="declaration">
880+
<h4>Declaration</h4>
881+
<div class="language">
882+
<p class="aside-title">Swift</p>
883+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">animateThemeTransitions</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span></code></pre>
884+
885+
</div>
886+
</div>
887+
<div class="slightly-smaller">
888+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L424">Show on GitHub</a>
889+
</div>
890+
</section>
891+
</div>
892+
</li>
893+
</ul>
894+
</div>
854895
<div class="task-group">
855896
<div class="task-name-container">
856897
<a name="/Notifications"></a>
@@ -885,7 +926,7 @@ <h4>Declaration</h4>
885926
</div>
886927
</div>
887928
<div class="slightly-smaller">
888-
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L552">Show on GitHub</a>
929+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L557">Show on GitHub</a>
889930
</div>
890931
</section>
891932
</div>
@@ -915,7 +956,7 @@ <h4>Declaration</h4>
915956
</div>
916957
</div>
917958
<div class="slightly-smaller">
918-
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L555">Show on GitHub</a>
959+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L560">Show on GitHub</a>
919960
</div>
920961
</section>
921962
</div>
@@ -945,7 +986,7 @@ <h4>Declaration</h4>
945986
</div>
946987
</div>
947988
<div class="slightly-smaller">
948-
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L558">Show on GitHub</a>
989+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L563">Show on GitHub</a>
949990
</div>
950991
</section>
951992
</div>

Docs/docsets/ThemeKit.docset/Contents/Resources/Documents/ThemeKit.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h4>Declaration</h4>
135135
</div>
136136
</div>
137137
<div class="slightly-smaller">
138-
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L23-L560">Show on GitHub</a>
138+
<a href="https://github.com/luckymarmot/ThemeKit/blob/master/Sources/ThemeManager.swift#L23-L565">Show on GitHub</a>
139139
</div>
140140
</section>
141141
</div>

Docs/docsets/ThemeKit.docset/Contents/Resources/Documents/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102

103103
<p><img src="https://img.shields.io/badge/os-macOS%2010.10%2B-green.svg?style=flat" alt="macOS">
104104
<img src="https://img.shields.io/badge/swift-4-green.svg?style=flat" alt="Swift3">
105-
<img src="https://img.shields.io/badge/release-1.2.0-blue.svg?style=flat" alt="Release">
105+
<img src="https://img.shields.io/badge/release-1.2.1-blue.svg?style=flat" alt="Release">
106106
<img src="https://img.shields.io/badge/license-MIT-lightgray.svg" alt="MIT">
107107
<img src="https://img.shields.io/badge/dep-CocoaPods-orange.svg" alt="CocoaPods">
108108
<img src="https://img.shields.io/badge/dep-Carthage-orange.svg" alt="Carthage"></p>
@@ -543,6 +543,9 @@ <h3 id='strong-can-i-make-custom-drawing-views-controls-theme-aware-strong' clas
543543
<p>Yes, you can! Implement your own custom controls drawing using <a href="#theme-aware-assets">Theme-aware Assets</a> (<code><a href="Classes/ThemeColor.html">ThemeColor</a></code> and <code><a href="Classes/ThemeGradient.html">ThemeGradient</a></code>) so that your controls drawing will always adapt to your current theme&hellip; automatically!</p>
544544

545545
<p>In case needed (for example, if drawing is being cached), you can observe when theme changes to refresh the UI or to perform any theme related operation. Check <em><q>Observing theme changes</q></em> on <a href="#usage">Usage</a> section above.</p>
546+
<h3 id='strong-nstableview-cells-are-getting-a-background-color-after-being-themed-strong' class='heading'><strong>NSTableView cells are getting a background color after being themed!</strong></h3>
547+
548+
<p>Please check <a href="https://github.com/luckymarmot/ThemeKit/issues/18">this issue</a>. This theming issue only affects view-based <code>NSTableView</code>s, when placed on sheets, on macOS &lt; 10.14. Please check <a href="https://github.com/luckymarmot/ThemeKit/issues/18#issuecomment-396553982">this comment</a> for a brief explanation on how to fix it, and a small project demonstrating the issue and the fix.</p>
546549
<h3 id='strong-scrollbars-appear-all-white-on-dark-themes-strong' class='heading'><strong>Scrollbars appear all white on dark themes!</strong></h3>
547550

548551
<p>If the user opts for always showing the scrollbars on <em>System Preferences</em>, scrollbars may render all white on dark themes. To bypass this, we need to observe for theme changes and change its background color directly. E.g.,</p>

Docs/docsets/ThemeKit.docset/Contents/Resources/Documents/search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Binary file not shown.

Docs/docsets/ThemeKit.tgz

1018 Bytes
Binary file not shown.

Docs/docsets/ThemeKit.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<entry><version>1.2.0</version><url>http://themekit.nunogrilo.com/docsets/ThemeKit.tgz</url></entry>
1+
<entry><version>1.2.1</version><url>http://themekit.nunogrilo.com/docsets/ThemeKit.tgz</url></entry>

Docs/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102

103103
<p><img src="https://img.shields.io/badge/os-macOS%2010.10%2B-green.svg?style=flat" alt="macOS">
104104
<img src="https://img.shields.io/badge/swift-4-green.svg?style=flat" alt="Swift3">
105-
<img src="https://img.shields.io/badge/release-1.2.0-blue.svg?style=flat" alt="Release">
105+
<img src="https://img.shields.io/badge/release-1.2.1-blue.svg?style=flat" alt="Release">
106106
<img src="https://img.shields.io/badge/license-MIT-lightgray.svg" alt="MIT">
107107
<img src="https://img.shields.io/badge/dep-CocoaPods-orange.svg" alt="CocoaPods">
108108
<img src="https://img.shields.io/badge/dep-Carthage-orange.svg" alt="Carthage"></p>
@@ -543,6 +543,9 @@ <h3 id='strong-can-i-make-custom-drawing-views-controls-theme-aware-strong' clas
543543
<p>Yes, you can! Implement your own custom controls drawing using <a href="#theme-aware-assets">Theme-aware Assets</a> (<code><a href="Classes/ThemeColor.html">ThemeColor</a></code> and <code><a href="Classes/ThemeGradient.html">ThemeGradient</a></code>) so that your controls drawing will always adapt to your current theme&hellip; automatically!</p>
544544

545545
<p>In case needed (for example, if drawing is being cached), you can observe when theme changes to refresh the UI or to perform any theme related operation. Check <em><q>Observing theme changes</q></em> on <a href="#usage">Usage</a> section above.</p>
546+
<h3 id='strong-nstableview-cells-are-getting-a-background-color-after-being-themed-strong' class='heading'><strong>NSTableView cells are getting a background color after being themed!</strong></h3>
547+
548+
<p>Please check <a href="https://github.com/luckymarmot/ThemeKit/issues/18">this issue</a>. This theming issue only affects view-based <code>NSTableView</code>s, when placed on sheets, on macOS &lt; 10.14. Please check <a href="https://github.com/luckymarmot/ThemeKit/issues/18#issuecomment-396553982">this comment</a> for a brief explanation on how to fix it, and a small project demonstrating the issue and the fix.</p>
546549
<h3 id='strong-scrollbars-appear-all-white-on-dark-themes-strong' class='heading'><strong>Scrollbars appear all white on dark themes!</strong></h3>
547550

548551
<p>If the user opts for always showing the scrollbars on <em>System Preferences</em>, scrollbars may render all white on dark themes. To bypass this, we need to observe for theme changes and change its background color directly. E.g.,</p>

Docs/search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

Docs/undocumented.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@
576576
},
577577
{
578578
"file": "/Users/nfgrilo/Projects/luckymarmot/ThemeKit/Sources/ThemeManager.swift",
579-
"line": 427,
579+
"line": 430,
580580
"symbol": "ThemeManager.observeValue(forKeyPath:of:change:context:)",
581581
"symbol_kind": "source.lang.swift.decl.function.method.instance",
582582
"warning": "undocumented"

0 commit comments

Comments
 (0)