Badarinath Venkatnarayansetty
c701255d79
* Providing option for custom spacing * Updating Jazzy docs Co-authored-by: Badarinath Venkatnarayansetty <Badarinath_Venkatnarayansetty@intuit.com>
422 lines
20 KiB
HTML
422 lines
20 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>Enumerations 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'>
|
||
<script src="js/jquery.min.js" defer></script>
|
||
<script src="js/jazzy.js" defer></script>
|
||
|
||
<script src="js/lunr.min.js" defer></script>
|
||
<script src="js/typeahead.jquery.js" defer></script>
|
||
<script src="js/jazzy.search.js" defer></script>
|
||
</head>
|
||
<body>
|
||
<a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>
|
||
<a title="Enumerations Reference"></a>
|
||
<header>
|
||
<div class="content-wrapper">
|
||
<p><a href="index.html">StepperView 1.6.6 Docs</a> (100% documented)</p>
|
||
<p class="header-right">
|
||
<form role="search" action="search.json">
|
||
<input type="text" placeholder="Search documentation" data-typeahead>
|
||
</form>
|
||
</p>
|
||
</div>
|
||
</header>
|
||
<div class="content-wrapper">
|
||
<p id="breadcrumbs">
|
||
<a href="index.html">StepperView Reference</a>
|
||
<img id="carat" src="img/carat.png" />
|
||
Enumerations Reference
|
||
</p>
|
||
</div>
|
||
<div class="content-wrapper">
|
||
<nav class="sidebar">
|
||
<ul class="nav-groups">
|
||
<li class="nav-group-name">
|
||
<a href="Classes.html">Classes</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="Classes/LoadingTimer.html">LoadingTimer</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="Enums.html">Enumerations</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="Enums/Colors.html">Colors</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/Colors/GraySubType.html">– GraySubType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/Colors/GreenSubType.html">– GreenSubType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/Colors/BlueSubType.html">– BlueSubType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/Colors/YellowSubType.html">– YellowSubType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/Colors/RedSubType.html">– RedSubType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/StepLifeCycle.html">StepLifeCycle</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/StepperAlignment.html">StepperAlignment</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/StepperIndicationType.html">StepperIndicationType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/StepperLineOptions.html">StepperLineOptions</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Enums/StepperMode.html">StepperMode</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="Extensions.html">Extensions</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="Extensions/EnvironmentValues.html">EnvironmentValues</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Extensions/VerticalAlignment.html">VerticalAlignment</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Extensions/View.html">View</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/AlignmentKey.html">AlignmentKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/AnimatedCircle.html">AnimatedCircle</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/AutoSpacingKey.html">AutoSpacingKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/BoundsPreferenceKey.html">BoundsPreferenceKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/CGRectData.html">CGRectData</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/CGRectPreferenceKey.html">CGRectPreferenceKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/CircledIconView.html">CircledIconView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/HeightKey.html">HeightKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/HeightPreference.html">HeightPreference</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/HorizontalLineView.html">HorizontalLineView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/IndicatorKey.html">IndicatorKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/IndicatorView.html">IndicatorView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/LineOptionsKey.html">LineOptionsKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/LoadAnimationOptionsKey.html">LoadAnimationOptionsKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/NumberedCircleView.html">NumberedCircleView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/PitStopLineOptionsKey.html">PitStopLineOptionsKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/PitStopLineView.html">PitStopLineView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/PitStopOptionsKey.html">PitStopOptionsKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/PitStopView.html">PitStopView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/PitstopHeightPreference.html">PitstopHeightPreference</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/SpacingKey.html">SpacingKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/StepAnimationOptionsKey.html">StepAnimationOptionsKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/StepIndicatorHorizontalView.html">StepIndicatorHorizontalView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/StepIndicatorModeKey.html">StepIndicatorModeKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/StepIndicatorVerticalView.html">StepIndicatorVerticalView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/StepLifeCycleKey.html">StepLifeCycleKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/StepperEdgeInsetsKey.html">StepperEdgeInsetsKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/StepperView.html">StepperView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/StepsKey.html">StepsKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/TextView.html">TextView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/Utils.html">Utils</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/VerticalHeightPreference.html">VerticalHeightPreference</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/VerticalLineView.html">VerticalLineView</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/WidthKey.html">WidthKey</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Structs/WidthPreference.html">WidthPreference</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<article class="main-content">
|
||
<section>
|
||
<section class="section">
|
||
<h1>Enumerations</h1>
|
||
<p>The following enumerations are available globally.</p>
|
||
|
||
</section>
|
||
<section class="section task-group-section">
|
||
<div class="task-group">
|
||
<ul>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperView6ColorsO"></a>
|
||
<a name="//apple_ref/swift/Enum/Colors" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperView6ColorsO">Colors</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Color palette helper accessing colors and it’s variations.</p>
|
||
|
||
<a href="Enums/Colors.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">@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)</span>
|
||
<span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Colors</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperView0A9AlignmentO"></a>
|
||
<a name="//apple_ref/swift/Enum/StepperAlignment" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperView0A9AlignmentO">StepperAlignment</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Options for stepper view alignments</p>
|
||
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">top</span>
|
||
<span class="k">case</span> <span class="n">center</span>
|
||
<span class="k">case</span> <span class="n">bottoom</span>
|
||
</code></pre>
|
||
|
||
<a href="Enums/StepperAlignment.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">@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)</span>
|
||
<span class="kd">public</span> <span class="kd">enum</span> <span class="kt">StepperAlignment</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CaseIterable</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperView0A14IndicationTypeO"></a>
|
||
<a name="//apple_ref/swift/Enum/StepperIndicationType" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperView0A14IndicationTypeO">StepperIndicationType</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Options for displaying step indications can be either <code>Circle</code> or <code>Image</code>or <code>custom(View)</code></p>
|
||
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">circle</span><span class="p">(</span><span class="kt">Color</span><span class="p">,</span> <span class="kt">Width</span><span class="p">)</span><span class="n">op</span>
|
||
<span class="k">case</span> <span class="nf">image</span><span class="p">(</span><span class="kt">Image</span><span class="p">,</span> <span class="kt">Width</span><span class="p">)</span>
|
||
<span class="k">case</span> <span class="nf">custom</span><span class="p">(</span><span class="kt">Content</span><span class="p">)</span>
|
||
</code></pre>
|
||
|
||
<a href="Enums/StepperIndicationType.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">@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)</span>
|
||
<span class="kd">public</span> <span class="kd">enum</span> <span class="kt">StepperIndicationType</span><span class="o"><</span><span class="kt">Content</span><span class="o">></span> <span class="k">where</span> <span class="kt">Content</span> <span class="p">:</span> <span class="kt">View</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperView0A11LineOptionsO"></a>
|
||
<a name="//apple_ref/swift/Enum/StepperLineOptions" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperView0A11LineOptionsO">StepperLineOptions</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Options for customizing line with either <code>defaults</code> or custom <code>width</code> and <code>Color</code></p>
|
||
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">defaults</span>
|
||
<span class="k">case</span> <span class="nf">custom</span><span class="p">(</span><span class="kt">CGFloat</span><span class="p">,</span> <span class="kt">Color</span><span class="p">)</span>
|
||
</code></pre>
|
||
|
||
<a href="Enums/StepperLineOptions.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">@available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.0, *)</span>
|
||
<span class="kd">public</span> <span class="kd">enum</span> <span class="kt">StepperLineOptions</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperView0A4ModeO"></a>
|
||
<a name="//apple_ref/swift/Enum/StepperMode" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperView0A4ModeO">StepperMode</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Options for aligns the step indicator either in <code>vertical</code> or <code>horizontal</code></p>
|
||
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">vertical</span>
|
||
<span class="k">case</span> <span class="n">horizontal</span>
|
||
</code></pre>
|
||
|
||
<a href="Enums/StepperMode.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">public</span> <span class="kd">enum</span> <span class="kt">StepperMode</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CaseIterable</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperView13StepLifeCycleO"></a>
|
||
<a name="//apple_ref/swift/Enum/StepLifeCycle" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperView13StepLifeCycleO">StepLifeCycle</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Options for aligns the step indicator either in <code>pending</code> or <code>completed</code></p>
|
||
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">pending</span>
|
||
<span class="k">case</span> <span class="n">completed</span>
|
||
</code></pre>
|
||
|
||
<a href="Enums/StepLifeCycle.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">public</span> <span class="kd">enum</span> <span class="kt">StepLifeCycle</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CaseIterable</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="footer">
|
||
<p>© 2021 <a class="link" href="https://github.com/badrinathvm/StepperView" target="_blank" rel="external">badrinathvm</a>. All rights reserved. (Last updated: 2021-08-26)</p>
|
||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||
</section>
|
||
</article>
|
||
</div>
|
||
</body>
|
||
</div>
|
||
</html>
|