GitHub/StepperView
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Files
task/fix_Scrolling_pitstop
StepperView/docs/Structs/NumberedCircleView.html
T
Badarinath Venkatnarayansetty 16307d38e5 Implementation of animated step indicators
2020-05-11 16:46:21 -07:00

467 lines
23 KiB
HTML
Raw Permalink 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>NumberedCircleView 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>
</head>
<body>
<a name="//apple_ref/swift/Struct/NumberedCircleView" class="dashAnchor"></a>
<a title="NumberedCircleView Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">StepperView 1.4.0 Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">StepperView Reference</a>
<img id="carat" src="../img/carat.png" />
NumberedCircleView 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/PitStopLineOptions.html">PitStopLineOptions</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/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/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/PitStopStep.html">PitStopStep</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PitStopView.html">PitStopView</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/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>NumberedCircleView</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">@available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *)</span>
<span class="kd">public</span> <span class="kd">struct</span> <span class="kt">NumberedCircleView</span> <span class="p">:</span> <span class="kt">View</span></code></pre>
</div>
</div>
<p>Circle view with text inside for Step Indicator</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:11StepperView014NumberedCircleB0V4textSSvp"></a>
<a name="//apple_ref/swift/Property/text" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView014NumberedCircleB0V4textSSvp">text</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>text to be paced inside the circle</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">text</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView014NumberedCircleB0V5width12CoreGraphics7CGFloatVvp"></a>
<a name="//apple_ref/swift/Property/width" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView014NumberedCircleB0V5width12CoreGraphics7CGFloatVvp">width</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>width of the step indicator</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">CGFloat</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView014NumberedCircleB0V5color7SwiftUI5ColorVvp"></a>
<a name="//apple_ref/swift/Property/color" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView014NumberedCircleB0V5color7SwiftUI5ColorVvp">color</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>color of the step indicator</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">color</span><span class="p">:</span> <span class="kt">Color</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView014NumberedCircleB0V5delaySdvp"></a>
<a name="//apple_ref/swift/Property/delay" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView014NumberedCircleB0V5delaySdvp">delay</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>delay for the animation to happen</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">delay</span><span class="p">:</span> <span class="kt">Double</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView014NumberedCircleB0V16triggerAnimationSbvp"></a>
<a name="//apple_ref/swift/Property/triggerAnimation" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView014NumberedCircleB0V16triggerAnimationSbvp">triggerAnimation</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>flag to tigger animation or not.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">triggerAnimation</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView014NumberedCircleB0V7animateSbvp"></a>
<a name="//apple_ref/swift/Property/animate" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView014NumberedCircleB0V7animateSbvp">animate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>animation state to render the 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">@State</span>
<span class="k">var</span> <span class="nv">animate</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">nonmutating</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView014NumberedCircleB0V11loadingTimeSdvp"></a>
<a name="//apple_ref/swift/Property/loadingTime" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView014NumberedCircleB0V11loadingTimeSdvp">loadingTime</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>loading time for animations</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">loadingTime</span><span class="p">:</span> <span class="kt">Double</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:11StepperView014NumberedCircleB0V4text5width5color5delay16triggerAnimationACSS_12CoreGraphics7CGFloatV7SwiftUI5ColorVSdSbtcfc"></a>
<a name="//apple_ref/swift/Method/init(text:width:color:delay:triggerAnimation:)" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView014NumberedCircleB0V4text5width5color5delay16triggerAnimationACSS_12CoreGraphics7CGFloatV7SwiftUI5ColorVSdSbtcfc">init(text:<wbr>width:<wbr>color:<wbr>delay:<wbr>triggerAnimation:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>initilazes <code><a href="../Structs/NumberedCircleView.html#/s:11StepperView014NumberedCircleB0V4textSSvp">text</a></code> , <code><a href="../Structs/NumberedCircleView.html#/s:11StepperView014NumberedCircleB0V5width12CoreGraphics7CGFloatVvp">width</a></code>, <code><a href="../Structs/NumberedCircleView.html#/s:11StepperView014NumberedCircleB0V5color7SwiftUI5ColorVvp">color</a></code> , <code><a href="../Structs/NumberedCircleView.html#/s:11StepperView014NumberedCircleB0V5delaySdvp">delay</a></code> and <code><a href="../Structs/NumberedCircleView.html#/s:11StepperView014NumberedCircleB0V16triggerAnimationSbvp">triggerAnimation</a></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">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">text</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="o">=</span> <span class="mf">30.0</span><span class="p">,</span> <span class="nv">color</span><span class="p">:</span> <span class="kt">Color</span> <span class="o">=</span> <span class="kt"><a href="../Enums/Colors.html">Colors</a></span><span class="o">.</span><span class="n">teal</span><span class="o">.</span><span class="n">rawValue</span><span class="p">,</span>
<span class="nv">delay</span><span class="p">:</span><span class="kt">Double</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">,</span>
<span class="nv">triggerAnimation</span><span class="p">:</span><span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11StepperView014NumberedCircleB0V4bodyQrvp"></a>
<a name="//apple_ref/swift/Property/body" class="dashAnchor"></a>
<a class="token" href="#/s:11StepperView014NumberedCircleB0V4bodyQrvp">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>&copy; 2020 <a class="link" href="https://github.com/badrinathvm/StepperView" target="_blank" rel="external">badrinathvm</a>. All rights reserved. (Last updated: 2020-05-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</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