Badarinath Venkatnarayansetty
c27f38c7a4
* Refactoring onf PitStop cases * Removed Pitstop step as code is refactored * Updated readme for the pitstop view modifiers * Updated jazzy diocs for pitstops Co-authored-by: Badarinath Venkatnarayansetty <Badarinath_Venkatnarayansetty@intuit.com>
462 lines
22 KiB
HTML
462 lines
22 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>StepperView Structure 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/Struct/StepperView" class="dashAnchor"></a>
|
||
<a title="StepperView Structure Reference"></a>
|
||
<header>
|
||
<div class="content-wrapper">
|
||
<p><a href="../index.html">StepperView 1.6.1 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" />
|
||
StepperView Structure 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/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>StepperView</h1>
|
||
<div class="declaration">
|
||
<div class="language">
|
||
|
||
<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">struct</span> <span class="kt">StepperView</span> <span class="p">:</span> <span class="kt">View</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<p>A View for Step Indications.</p>
|
||
|
||
<p>You create step indicator view either in <code>vertical</code> or <code>horizontal</code> mode</p>
|
||
|
||
</section>
|
||
<section class="section task-group-section">
|
||
<div class="task-group">
|
||
<ul>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperViewAAV5stepsSay7SwiftUI03AnyB0VGvp"></a>
|
||
<a name="//apple_ref/swift/Property/steps" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperViewAAV5stepsSay7SwiftUI03AnyB0VGvp">steps</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>contains list of steps to be rendered next to Indicators</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">@Environment</span>
|
||
<span class="k">var</span> <span class="nv">steps</span><span class="p">:</span> <span class="p">[</span><span class="kt">AnyView</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperViewAAV10alignmentsSayAA0A9AlignmentOGvp"></a>
|
||
<a name="//apple_ref/swift/Property/alignments" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperViewAAV10alignmentsSayAA0A9AlignmentOGvp">alignments</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>alignments to place the step indicators</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">@Environment</span>
|
||
<span class="k">var</span> <span class="nv">alignments</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Enums/StepperAlignment.html">StepperAlignment</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperViewAAV14indicationTypeSayAA0a10IndicationD0Oy7SwiftUI03AnyB0VGGvp"></a>
|
||
<a name="//apple_ref/swift/Property/indicationType" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperViewAAV14indicationTypeSayAA0a10IndicationD0Oy7SwiftUI03AnyB0VGGvp">indicationType</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>step indicator type can be a <code>Circle</code> , <code>Image</code> or <code>Custom</code></p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">@Environment</span>
|
||
<span class="k">var</span> <span class="nv">indicationType</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Enums/StepperIndicationType.html">StepperIndicationType</a></span><span class="o"><</span><span class="kt">AnyView</span><span class="o">></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperViewAAV11lineOptionsAA0a4LineD0Ovp"></a>
|
||
<a name="//apple_ref/swift/Property/lineOptions" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperViewAAV11lineOptionsAA0a4LineD0Ovp">lineOptions</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>to customise the <code>width</code> , <code>Color</code> of the line</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">@Environment</span>
|
||
<span class="k">var</span> <span class="nv">lineOptions</span><span class="p">:</span> <span class="kt"><a href="../Enums/StepperLineOptions.html">StepperLineOptions</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperViewAAV11stepperModeAA0aD0Ovp"></a>
|
||
<a name="//apple_ref/swift/Property/stepperMode" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperViewAAV11stepperModeAA0aD0Ovp">stepperMode</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>aligns the step indicator either in <code>vertical</code> or <code>horizontal</code></p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">@Environment</span>
|
||
<span class="k">var</span> <span class="nv">stepperMode</span><span class="p">:</span> <span class="kt"><a href="../Enums/StepperMode.html">StepperMode</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperViewAAV7spacing12CoreGraphics7CGFloatVvp"></a>
|
||
<a name="//apple_ref/swift/Property/spacing" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperViewAAV7spacing12CoreGraphics7CGFloatVvp">spacing</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>spacing between each of the step indicators</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">@Environment</span>
|
||
<span class="k">var</span> <span class="nv">spacing</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperViewAAVABycfc"></a>
|
||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperViewAAVABycfc">init()</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>empty initilazer</p>
|
||
|
||
</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="nf">init</span><span class="p">()</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:11StepperViewAAV4bodyQrvp"></a>
|
||
<a name="//apple_ref/swift/Property/body" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:11StepperViewAAV4bodyQrvp">body</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>provides the content and behavior of this view.</p>
|
||
|
||
</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="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="n">some</span> <span class="kt">View</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</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-04-05)</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>
|