GitHub/StepperView
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Files
d372c8295ac2561dc1acac69e3e2ff46b70d3ec7
StepperView/docs/docsets/StepperView.docset/Contents/Resources/Documents/Extensions/View.html
T
Badarinath Venkatnarayansetty d372c8295a Updating version to 1.6.5
2021-05-20 13:02:23 -07:00

1072 lines
56 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="en">
<head>
<title>View Extension 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/Extension/View" class="dashAnchor"></a>
<a title="View Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">StepperView 1.6.5 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" />
View Extension 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>View</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">extension</span> <span class="kt">View</span></code></pre>
</div>
</div>
<p>Helper function of <code>View</code> to operate on</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E16heightPreference6columnQrSi_tF"></a>
<a name="//apple_ref/swift/Method/heightPreference(column:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E16heightPreference6columnQrSi_tF">heightPreference(column:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Stores the height for each of column which will be passed as part of onPreference change parent 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">func</span> <span class="nf">heightPreference</span><span class="p">(</span><span class="nv">column</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E15widthPreference6columnQrSi_tF"></a>
<a name="//apple_ref/swift/Method/widthPreference(column:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E15widthPreference6columnQrSi_tF">widthPreference(column:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Stores the width for each of column which will be passed as part of onPreference change to parent 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">func</span> <span class="nf">widthPreference</span><span class="p">(</span><span class="nv">column</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E8widthKeyQryF"></a>
<a name="//apple_ref/swift/Method/widthKey()" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E8widthKeyQryF">widthKey()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Stores the width which will be passed as part of onPreference change to parent 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">func</span> <span class="nf">widthKey</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E9heightKeyQryF"></a>
<a name="//apple_ref/swift/Method/heightKey()" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E9heightKeyQryF">heightKey()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Stores the height for each of column which will be passed as part of onPreference change to parent 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">func</span> <span class="nf">heightKey</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E24verticalHeightPreference6columnQrSiSg_tF"></a>
<a name="//apple_ref/swift/Method/verticalHeightPreference(column:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E24verticalHeightPreference6columnQrSiSg_tF">verticalHeightPreference(column:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Stores the height for each of column which will be passed as part of onPreferenceChange to parent 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">func</span> <span class="nf">verticalHeightPreference</span><span class="p">(</span><span class="nv">column</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E23pitstopHeightPreference6columnQrSiSg_tF"></a>
<a name="//apple_ref/swift/Method/pitstopHeightPreference(column:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E23pitstopHeightPreference6columnQrSiSg_tF">pitstopHeightPreference(column:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Stores the height for each of column which will be passed as part of onPreferenceChange to parent 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">func</span> <span class="nf">pitstopHeightPreference</span><span class="p">(</span><span class="nv">column</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E16cgRectPreferenceQryF"></a>
<a name="//apple_ref/swift/Method/cgRectPreference()" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E16cgRectPreferenceQryF">cgRectPreference()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Stores CGRect data for each cell which will be passed as part of onPreferenceChange to the parent 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">func</span> <span class="nf">cgRectPreference</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E12setAlignment4typeQrAD0dF0O_tF"></a>
<a name="//apple_ref/swift/Method/setAlignment(type:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E12setAlignment4typeQrAD0dF0O_tF">setAlignment(type:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>returns the alignment guide based on the alignemnt type.</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">func</span> <span class="nf">setAlignment</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Enums/StepperAlignment.html">StepperAlignment</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>type</em>
</code>
</td>
<td>
<div>
<p>sets the aligment guide.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E12getAlignment4typeAA08VerticalF0VAD0dF0O_tF"></a>
<a name="//apple_ref/swift/Method/getAlignment(type:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E12getAlignment4typeAA08VerticalF0VAD0dF0O_tF">getAlignment(type:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>returmns the alginment based ont he Stepper Alignment</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">func</span> <span class="nf">getAlignment</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Enums/StepperAlignment.html">StepperAlignment</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">VerticalAlignment</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>type</em>
</code>
</td>
<td>
<div>
<p>StepperAlignment enum</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E017embedINNavigationC0QryF"></a>
<a name="//apple_ref/swift/Method/embedINNavigationView()" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E017embedINNavigationC0QryF">embedINNavigationView()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Embeds the view in navigationView</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">func</span> <span class="nf">embedINNavigationView</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E010eraseToAnyC0AA0gC0VyF"></a>
<a name="//apple_ref/swift/Method/eraseToAnyView()" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E010eraseToAnyC0AA0gC0VyF">eraseToAnyView()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Wrapper to AnyView</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">func</span> <span class="nf">eraseToAnyView</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">AnyView</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E12getYPosition3for12CoreGraphics7CGFloatVAD0D9AlignmentO_tF"></a>
<a name="//apple_ref/swift/Method/getYPosition(for:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E12getYPosition3for12CoreGraphics7CGFloatVAD0D9AlignmentO_tF">getYPosition(for:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns either <code>top</code>, <code>center</code> <code>bottom</code> bound positions</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">func</span> <span class="nf">getYPosition</span><span class="p">(</span><span class="k">for</span> <span class="nv">alignment</span><span class="p">:</span> <span class="kt"><a href="../Enums/StepperAlignment.html">StepperAlignment</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">CGFloat</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E8addStepsyQrSayqd__GAaBRd__lF"></a>
<a name="//apple_ref/swift/Method/addSteps(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E8addStepsyQrSayqd__GAaBRd__lF">addSteps(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Configures Steps to environment value</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">func</span> <span class="n">addSteps</span><span class="o">&lt;</span><span class="kt">Cell</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">steps</span><span class="p">:</span> <span class="p">[</span><span class="kt">Cell</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span> <span class="k">where</span> <span class="kt">Cell</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:7SwiftUI4ViewP07StepperC0E10alignmentsyQrSayAD0D9AlignmentOGF"></a>
<a name="//apple_ref/swift/Method/alignments(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E10alignmentsyQrSayAD0D9AlignmentOGF">alignments(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Sets alignments to environment value</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">func</span> <span class="nf">alignments</span><span class="p">(</span><span class="n">_</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="o">=</span> <span class="p">[])</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E14stepLifeCyclesyQrSayAD04StepF5CycleOGF"></a>
<a name="//apple_ref/swift/Method/stepLifeCycles(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E14stepLifeCyclesyQrSayAD04StepF5CycleOGF">stepLifeCycles(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Sets lifecycle status to environment value</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">func</span> <span class="nf">stepLifeCycles</span><span class="p">(</span><span class="n">_</span> <span class="nv">lifecycle</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Enums/StepLifeCycle.html">StepLifeCycle</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="o">.</span><span class="n">completed</span><span class="p">,</span> <span class="o">.</span><span class="n">completed</span><span class="p">,</span> <span class="o">.</span><span class="n">completed</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E10indicatorsyQrSayAD0D14IndicationTypeOyqd__GGAaBRd__lF"></a>
<a name="//apple_ref/swift/Method/indicators(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E10indicatorsyQrSayAD0D14IndicationTypeOyqd__GGAaBRd__lF">indicators(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Sets indicators to environment value</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">func</span> <span class="n">indicators</span><span class="o">&lt;</span><span class="kt">Cell</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">indicators</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Enums/StepperIndicationType.html">StepperIndicationType</a></span><span class="o">&lt;</span><span class="kt">Cell</span><span class="o">&gt;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[])</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span> <span class="k">where</span> <span class="kt">Cell</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:7SwiftUI4ViewP07StepperC0E17stepIndicatorModeyQrAD0dG0OF"></a>
<a name="//apple_ref/swift/Method/stepIndicatorMode(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E17stepIndicatorModeyQrAD0dG0OF">stepIndicatorMode(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Configures step Indicator mode to environment value</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">func</span> <span class="nf">stepIndicatorMode</span><span class="p">(</span><span class="n">_</span> <span class="nv">mode</span><span class="p">:</span> <span class="kt"><a href="../Enums/StepperMode.html">StepperMode</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E7spacingyQr12CoreGraphics7CGFloatVF"></a>
<a name="//apple_ref/swift/Method/spacing(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E7spacingyQr12CoreGraphics7CGFloatVF">spacing(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Configures spacing to environment value</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">func</span> <span class="nf">spacing</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">CGFloat</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E11autoSpacingyQrSbF"></a>
<a name="//apple_ref/swift/Method/autoSpacing(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E11autoSpacingyQrSbF">autoSpacing(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Configures auto spacing to environment value</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">func</span> <span class="nf">autoSpacing</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E11lineOptionsyQrAD0d4LineF0OF"></a>
<a name="//apple_ref/swift/Method/lineOptions(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E11lineOptionsyQrAD0d4LineF0OF">lineOptions(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Configures line options to environment value</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">func</span> <span class="nf">lineOptions</span><span class="p">(</span><span class="n">_</span> <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Enums/StepperLineOptions.html">StepperLineOptions</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E6ifTrue_7contentQrSb_qd__xXEtAaBRd__lF"></a>
<a name="//apple_ref/swift/Method/ifTrue(_:content:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E6ifTrue_7contentQrSb_qd__xXEtAaBRd__lF">ifTrue(_:<wbr>content:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Conditional modifier</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">func</span> <span class="n">ifTrue</span><span class="o">&lt;</span><span class="kt">Content</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">conditional</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">content</span><span class="p">:</span> <span class="p">(</span><span class="k">Self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Content</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</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:7SwiftUI4ViewP07StepperC0E11addPitStopsyQrSayAA03AnyC0VGF"></a>
<a name="//apple_ref/swift/Method/addPitStops(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E11addPitStopsyQrSayAA03AnyC0VGF">addPitStops(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Custom behavior for pitstops</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">func</span> <span class="nf">addPitStops</span><span class="p">(</span><span class="n">_</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="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>steps</em>
</code>
</td>
<td>
<div>
<p>list of pitstop step views</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E18pitStopLineOptionsyQrSayAD0dgH0OGF"></a>
<a name="//apple_ref/swift/Method/pitStopLineOptions(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E18pitStopLineOptionsyQrSayAD0dgH0OGF">pitStopLineOptions(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Custom behavior for pitstops</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">func</span> <span class="nf">pitStopLineOptions</span><span class="p">(</span><span class="n">_</span> <span class="nv">options</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Enums/StepperLineOptions.html">StepperLineOptions</a></span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>steps</em>
</code>
</td>
<td>
<div>
<p>list of pitstop line options views</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E12animateStepsyQrSiF"></a>
<a name="//apple_ref/swift/Method/animateSteps(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E12animateStepsyQrSiF">animateSteps(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Custom behavior for pitstops</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">func</span> <span class="nf">animateSteps</span><span class="p">(</span><span class="n">_</span> <span class="nv">count</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>steps</em>
</code>
</td>
<td>
<div>
<p>list of pitstop step views</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E20loadingAnimationTimeyQrSdF"></a>
<a name="//apple_ref/swift/Method/loadingAnimationTime(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E20loadingAnimationTimeyQrSdF">loadingAnimationTime(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Custom behavior for pitstops</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">func</span> <span class="nf">loadingAnimationTime</span><span class="p">(</span><span class="n">_</span> <span class="nv">time</span><span class="p">:</span> <span class="kt">Double</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">some</span> <span class="kt">View</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>steps</em>
</code>
</td>
<td>
<div>
<p>list of pitstop step views</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:7SwiftUI4ViewP07StepperC0E3logyAA05EmptyC0VSSF"></a>
<a name="//apple_ref/swift/Method/log(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:7SwiftUI4ViewP07StepperC0E3logyAA05EmptyC0VSSF">log(_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Method to add logging in 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">func</span> <span class="nf">log</span><span class="p">(</span><span class="n">_</span> <span class="nv">log</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">EmptyView</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>log</em>
</code>
</td>
<td>
<div>
<p>logging string to be displayed</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://github.com/badrinathvm/StepperView" target="_blank" rel="external">badrinathvm</a>. All rights reserved. (Last updated: 2021-05-20)</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>
Reference in New Issue View Git Blame Copy Permalink