updated docs

This commit is contained in:
Alex.k
2016-06-15 10:33:04 +03:00
parent 836c4f80e5
commit 83e3cb88c8
20 changed files with 69 additions and 65 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'FoldingCell'
s.version = '0.8.7'
s.version = '1.0.0'
s.summary = 'UITableViewCell with folding animation.'
s.homepage = 'https://github.com/Ramotion/folding-cell'
s.license = 'MIT'
+5 -5
View File
@@ -13,12 +13,12 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">FoldingCellDemo Docs</a> (47% documented)</p>
<p><a href="index.html">FoldingCell Docs</a> (42% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">FoldingCellDemo Reference</a>
<a href="index.html">FoldingCell Reference</a>
<img id="carat" src="img/carat.png" />
Classes Reference
</p>
@@ -49,9 +49,9 @@
<li class="item">
<div>
<code>
<a name="/s:C15FoldingCellDemo11FoldingCell"></a>
<a name="/s:C11FoldingCell11FoldingCell"></a>
<a name="//apple_ref/swift/Class/FoldingCell" class="dashAnchor"></a>
<a class="token" href="#/s:C15FoldingCellDemo11FoldingCell">FoldingCell</a>
<a class="token" href="#/s:C11FoldingCell11FoldingCell">FoldingCell</a>
</code>
</div>
<div class="height-container">
@@ -79,7 +79,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-10)</p>
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
+17 -17
View File
@@ -14,12 +14,12 @@
<a title="FoldingCell Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">FoldingCellDemo Docs</a> (47% documented)</p>
<p><a href="../index.html">FoldingCell Docs</a> (42% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">FoldingCellDemo Reference</a>
<a href="../index.html">FoldingCell Reference</a>
<img id="carat" src="../img/carat.png" />
FoldingCell Class Reference
</p>
@@ -56,9 +56,9 @@
<li class="item">
<div>
<code>
<a name="/s:vC15FoldingCellDemo11FoldingCell13containerViewXwGSQCSo6UIView_"></a>
<a name="/s:vC11FoldingCell11FoldingCell13containerViewXwGSQCSo6UIView_"></a>
<a name="//apple_ref/swift/Property/containerView" class="dashAnchor"></a>
<a class="token" href="#/s:vC15FoldingCellDemo11FoldingCell13containerViewXwGSQCSo6UIView_">containerView</a>
<a class="token" href="#/s:vC11FoldingCell11FoldingCell13containerViewXwGSQCSo6UIView_">containerView</a>
</code>
</div>
<div class="height-container">
@@ -83,9 +83,9 @@
<li class="item">
<div>
<code>
<a name="/s:vC15FoldingCellDemo11FoldingCell14foregroundViewXwGSQCS_11RotatedView_"></a>
<a name="/s:vC11FoldingCell11FoldingCell14foregroundViewXwGSQCS_11RotatedView_"></a>
<a name="//apple_ref/swift/Property/foregroundView" class="dashAnchor"></a>
<a class="token" href="#/s:vC15FoldingCellDemo11FoldingCell14foregroundViewXwGSQCS_11RotatedView_">foregroundView</a>
<a class="token" href="#/s:vC11FoldingCell11FoldingCell14foregroundViewXwGSQCS_11RotatedView_">foregroundView</a>
</code>
</div>
<div class="height-container">
@@ -110,9 +110,9 @@
<li class="item">
<div>
<code>
<a name="/s:vC15FoldingCellDemo11FoldingCell9itemCountSi"></a>
<a name="/s:vC11FoldingCell11FoldingCell9itemCountSi"></a>
<a name="//apple_ref/swift/Property/itemCount" class="dashAnchor"></a>
<a class="token" href="#/s:vC15FoldingCellDemo11FoldingCell9itemCountSi">itemCount</a>
<a class="token" href="#/s:vC11FoldingCell11FoldingCell9itemCountSi">itemCount</a>
</code>
</div>
<div class="height-container">
@@ -137,9 +137,9 @@
<li class="item">
<div>
<code>
<a name="/s:vC15FoldingCellDemo11FoldingCell13backViewColorCSo7UIColor"></a>
<a name="/s:vC11FoldingCell11FoldingCell13backViewColorCSo7UIColor"></a>
<a name="//apple_ref/swift/Property/backViewColor" class="dashAnchor"></a>
<a class="token" href="#/s:vC15FoldingCellDemo11FoldingCell13backViewColorCSo7UIColor">backViewColor</a>
<a class="token" href="#/s:vC11FoldingCell11FoldingCell13backViewColorCSo7UIColor">backViewColor</a>
</code>
</div>
<div class="height-container">
@@ -164,9 +164,9 @@
<li class="item">
<div>
<code>
<a name="/s:OC15FoldingCellDemo11FoldingCell13AnimationType"></a>
<a name="/s:OC11FoldingCell11FoldingCell13AnimationType"></a>
<a name="//apple_ref/swift/Enum/AnimationType" class="dashAnchor"></a>
<a class="token" href="#/s:OC15FoldingCellDemo11FoldingCell13AnimationType">AnimationType</a>
<a class="token" href="#/s:OC11FoldingCell11FoldingCell13AnimationType">AnimationType</a>
</code>
</div>
<div class="height-container">
@@ -207,9 +207,9 @@
<li class="item">
<div>
<code>
<a name="/s:FC15FoldingCellDemo11FoldingCell10commonInitFT_T_"></a>
<a name="/s:FC11FoldingCell11FoldingCell10commonInitFT_T_"></a>
<a name="//apple_ref/swift/Method/commonInit()" class="dashAnchor"></a>
<a class="token" href="#/s:FC15FoldingCellDemo11FoldingCell10commonInitFT_T_">commonInit()</a>
<a class="token" href="#/s:FC11FoldingCell11FoldingCell10commonInitFT_T_">commonInit()</a>
</code>
</div>
<div class="height-container">
@@ -245,9 +245,9 @@
<li class="item">
<div>
<code>
<a name="/s:FC15FoldingCellDemo11FoldingCell17selectedAnimationFTSb8animatedSb10completionGSqFT_T___T_"></a>
<a name="/s:FC11FoldingCell11FoldingCell17selectedAnimationFTSb8animatedSb10completionGSqFT_T___T_"></a>
<a name="//apple_ref/swift/Method/selectedAnimation(_:animated:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC15FoldingCellDemo11FoldingCell17selectedAnimationFTSb8animatedSb10completionGSqFT_T___T_">selectedAnimation(_:animated:completion:)</a>
<a class="token" href="#/s:FC11FoldingCell11FoldingCell17selectedAnimationFTSb8animatedSb10completionGSqFT_T___T_">selectedAnimation(_:animated:completion:)</a>
</code>
</div>
<div class="height-container">
@@ -320,7 +320,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-10)</p>
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
@@ -3,9 +3,9 @@
<plist version="1.0">
<dict>
<key>CFBundleIdentifier</key>
<string>com.jazzy.foldingcelldemo</string>
<string>com.jazzy.foldingcell</string>
<key>CFBundleName</key>
<string>FoldingCellDemo</string>
<string>FoldingCell</string>
<key>DocSetPlatformFamily</key>
<string>jazzy</string>
<key>isDashDocset</key>
@@ -13,12 +13,12 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">FoldingCellDemo Docs</a> (47% documented)</p>
<p><a href="index.html">FoldingCell Docs</a> (42% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">FoldingCellDemo Reference</a>
<a href="index.html">FoldingCell Reference</a>
<img id="carat" src="img/carat.png" />
Classes Reference
</p>
@@ -49,9 +49,9 @@
<li class="item">
<div>
<code>
<a name="/s:C15FoldingCellDemo11FoldingCell"></a>
<a name="/s:C11FoldingCell11FoldingCell"></a>
<a name="//apple_ref/swift/Class/FoldingCell" class="dashAnchor"></a>
<a class="token" href="#/s:C15FoldingCellDemo11FoldingCell">FoldingCell</a>
<a class="token" href="#/s:C11FoldingCell11FoldingCell">FoldingCell</a>
</code>
</div>
<div class="height-container">
@@ -79,7 +79,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-10)</p>
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
@@ -14,12 +14,12 @@
<a title="FoldingCell Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">FoldingCellDemo Docs</a> (47% documented)</p>
<p><a href="../index.html">FoldingCell Docs</a> (42% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">FoldingCellDemo Reference</a>
<a href="../index.html">FoldingCell Reference</a>
<img id="carat" src="../img/carat.png" />
FoldingCell Class Reference
</p>
@@ -56,9 +56,9 @@
<li class="item">
<div>
<code>
<a name="/s:vC15FoldingCellDemo11FoldingCell13containerViewXwGSQCSo6UIView_"></a>
<a name="/s:vC11FoldingCell11FoldingCell13containerViewXwGSQCSo6UIView_"></a>
<a name="//apple_ref/swift/Property/containerView" class="dashAnchor"></a>
<a class="token" href="#/s:vC15FoldingCellDemo11FoldingCell13containerViewXwGSQCSo6UIView_">containerView</a>
<a class="token" href="#/s:vC11FoldingCell11FoldingCell13containerViewXwGSQCSo6UIView_">containerView</a>
</code>
</div>
<div class="height-container">
@@ -83,9 +83,9 @@
<li class="item">
<div>
<code>
<a name="/s:vC15FoldingCellDemo11FoldingCell14foregroundViewXwGSQCS_11RotatedView_"></a>
<a name="/s:vC11FoldingCell11FoldingCell14foregroundViewXwGSQCS_11RotatedView_"></a>
<a name="//apple_ref/swift/Property/foregroundView" class="dashAnchor"></a>
<a class="token" href="#/s:vC15FoldingCellDemo11FoldingCell14foregroundViewXwGSQCS_11RotatedView_">foregroundView</a>
<a class="token" href="#/s:vC11FoldingCell11FoldingCell14foregroundViewXwGSQCS_11RotatedView_">foregroundView</a>
</code>
</div>
<div class="height-container">
@@ -110,9 +110,9 @@
<li class="item">
<div>
<code>
<a name="/s:vC15FoldingCellDemo11FoldingCell9itemCountSi"></a>
<a name="/s:vC11FoldingCell11FoldingCell9itemCountSi"></a>
<a name="//apple_ref/swift/Property/itemCount" class="dashAnchor"></a>
<a class="token" href="#/s:vC15FoldingCellDemo11FoldingCell9itemCountSi">itemCount</a>
<a class="token" href="#/s:vC11FoldingCell11FoldingCell9itemCountSi">itemCount</a>
</code>
</div>
<div class="height-container">
@@ -137,9 +137,9 @@
<li class="item">
<div>
<code>
<a name="/s:vC15FoldingCellDemo11FoldingCell13backViewColorCSo7UIColor"></a>
<a name="/s:vC11FoldingCell11FoldingCell13backViewColorCSo7UIColor"></a>
<a name="//apple_ref/swift/Property/backViewColor" class="dashAnchor"></a>
<a class="token" href="#/s:vC15FoldingCellDemo11FoldingCell13backViewColorCSo7UIColor">backViewColor</a>
<a class="token" href="#/s:vC11FoldingCell11FoldingCell13backViewColorCSo7UIColor">backViewColor</a>
</code>
</div>
<div class="height-container">
@@ -164,9 +164,9 @@
<li class="item">
<div>
<code>
<a name="/s:OC15FoldingCellDemo11FoldingCell13AnimationType"></a>
<a name="/s:OC11FoldingCell11FoldingCell13AnimationType"></a>
<a name="//apple_ref/swift/Enum/AnimationType" class="dashAnchor"></a>
<a class="token" href="#/s:OC15FoldingCellDemo11FoldingCell13AnimationType">AnimationType</a>
<a class="token" href="#/s:OC11FoldingCell11FoldingCell13AnimationType">AnimationType</a>
</code>
</div>
<div class="height-container">
@@ -207,9 +207,9 @@
<li class="item">
<div>
<code>
<a name="/s:FC15FoldingCellDemo11FoldingCell10commonInitFT_T_"></a>
<a name="/s:FC11FoldingCell11FoldingCell10commonInitFT_T_"></a>
<a name="//apple_ref/swift/Method/commonInit()" class="dashAnchor"></a>
<a class="token" href="#/s:FC15FoldingCellDemo11FoldingCell10commonInitFT_T_">commonInit()</a>
<a class="token" href="#/s:FC11FoldingCell11FoldingCell10commonInitFT_T_">commonInit()</a>
</code>
</div>
<div class="height-container">
@@ -245,9 +245,9 @@
<li class="item">
<div>
<code>
<a name="/s:FC15FoldingCellDemo11FoldingCell17selectedAnimationFTSb8animatedSb10completionGSqFT_T___T_"></a>
<a name="/s:FC11FoldingCell11FoldingCell17selectedAnimationFTSb8animatedSb10completionGSqFT_T___T_"></a>
<a name="//apple_ref/swift/Method/selectedAnimation(_:animated:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC15FoldingCellDemo11FoldingCell17selectedAnimationFTSb8animatedSb10completionGSqFT_T___T_">selectedAnimation(_:animated:completion:)</a>
<a class="token" href="#/s:FC11FoldingCell11FoldingCell17selectedAnimationFTSb8animatedSb10completionGSqFT_T___T_">selectedAnimation(_:animated:completion:)</a>
</code>
</div>
<div class="height-container">
@@ -320,7 +320,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-10)</p>
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.3 KiB

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.5 KiB

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>FoldingCellDemo Reference</title>
<title>FoldingCell Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
@@ -10,17 +10,17 @@
</head>
<body>
<a title="FoldingCellDemo Reference"></a>
<a title="FoldingCell Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">FoldingCellDemo Docs</a> (47% documented)</p>
<p><a href="index.html">FoldingCell Docs</a> (42% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">FoldingCellDemo Reference</a>
<a href="index.html">FoldingCell Reference</a>
<img id="carat" src="img/carat.png" />
FoldingCellDemo Reference
FoldingCell Reference
</p>
</div>
<div class="content-wrapper">
@@ -88,15 +88,15 @@ Add constraints from this view to the superview, as in this picture:</p>
<p><img src="https://raw.githubusercontent.com/Ramotion/folding-cell/master/Tutorial-resources/1.1.png" alt="1.1"></p>
<p>(constants of constraints may be different). Add the identifier <code>ForegroundViewTop</code>
for the top constraint. (This view will be shown when the cell is in its normal state).</p>
<p>(constants of constraints may be different). Connect the outlet from this top constraint to the cell property <code>foregroundViewTop</code>
. (This view will be shown when the cell is in its normal state).</p>
<p>3) Add other UIViews to your cell, connect the outlet from this view to the cell
property <code>containerView</code>. Add constraints from this view to the superview like in the picture:</p>
<p><img src="https://raw.githubusercontent.com/Ramotion/folding-cell/master/Tutorial-resources/1.2.png" alt="1.2"></p>
<p>(constants of constraints may be different). Add the identifier <q>ContainerViewTop</q> for the top constraint.
<p>(constants of constraints may be different). Connect the outlet from this top constraint to the cell property <code>containerViewTop</code>.
(This view will be shown when the cell is opened)</p>
<p>Your result should be something like this picture:</p>
@@ -206,7 +206,7 @@ See our other [open-source projects](https://github.com/ramotion) or [hire](http
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-10)</p>
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
@@ -1,4 +1,6 @@
FoldingCell.swift
@IBOutlet weak public var containerViewTop: NSLayoutConstraint!
@IBOutlet weak public var foregroundViewTop: NSLayoutConstraint!
case Open
case Close
override public init(style: UITableViewCellStyle, reuseIdentifier: String?)
Binary file not shown.
Binary file not shown.
+9 -9
View File
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>FoldingCellDemo Reference</title>
<title>FoldingCell Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
@@ -10,17 +10,17 @@
</head>
<body>
<a title="FoldingCellDemo Reference"></a>
<a title="FoldingCell Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">FoldingCellDemo Docs</a> (47% documented)</p>
<p><a href="index.html">FoldingCell Docs</a> (42% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">FoldingCellDemo Reference</a>
<a href="index.html">FoldingCell Reference</a>
<img id="carat" src="img/carat.png" />
FoldingCellDemo Reference
FoldingCell Reference
</p>
</div>
<div class="content-wrapper">
@@ -88,15 +88,15 @@ Add constraints from this view to the superview, as in this picture:</p>
<p><img src="https://raw.githubusercontent.com/Ramotion/folding-cell/master/Tutorial-resources/1.1.png" alt="1.1"></p>
<p>(constants of constraints may be different). Add the identifier <code>ForegroundViewTop</code>
for the top constraint. (This view will be shown when the cell is in its normal state).</p>
<p>(constants of constraints may be different). Connect the outlet from this top constraint to the cell property <code>foregroundViewTop</code>
. (This view will be shown when the cell is in its normal state).</p>
<p>3) Add other UIViews to your cell, connect the outlet from this view to the cell
property <code>containerView</code>. Add constraints from this view to the superview like in the picture:</p>
<p><img src="https://raw.githubusercontent.com/Ramotion/folding-cell/master/Tutorial-resources/1.2.png" alt="1.2"></p>
<p>(constants of constraints may be different). Add the identifier <q>ContainerViewTop</q> for the top constraint.
<p>(constants of constraints may be different). Connect the outlet from this top constraint to the cell property <code>containerViewTop</code>.
(This view will be shown when the cell is opened)</p>
<p>Your result should be something like this picture:</p>
@@ -206,7 +206,7 @@ See our other [open-source projects](https://github.com/ramotion) or [hire](http
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-10)</p>
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">AlexKalinkin</a>. All rights reserved. (Last updated: 2016-06-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
+2
View File
@@ -1,4 +1,6 @@
FoldingCell.swift
@IBOutlet weak public var containerViewTop: NSLayoutConstraint!
@IBOutlet weak public var foregroundViewTop: NSLayoutConstraint!
case Open
case Close
override public init(style: UITableViewCellStyle, reuseIdentifier: String?)