mirror of
https://github.com/realm/SwiftLint.git
synced 2026-05-07 20:12:49 +00:00
swiftlintbot@jpsim.com
627 lines
44 KiB
HTML
627 lines
44 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>accessibility_trait_for_button 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 title="accessibility_trait_for_button Reference"></a>
|
||
|
||
<header class="header">
|
||
<p class="header-col header-col--primary">
|
||
<a class="header-link" href="index.html">
|
||
SwiftLintCore 0.59.1 Docs
|
||
</a>
|
||
(100% documented)
|
||
</p>
|
||
|
||
<div class="header-col--secondary">
|
||
<form role="search" action="search.json">
|
||
<input type="text" placeholder="Search documentation" data-typeahead>
|
||
</form>
|
||
</div>
|
||
|
||
<p class="header-col header-col--secondary">
|
||
<a class="header-link" href="https://github.com/realm/SwiftLint">
|
||
<img class="header-icon" src="img/gh.png" alt="GitHub"/>
|
||
View on GitHub
|
||
</a>
|
||
</p>
|
||
|
||
<p class="header-col header-col--secondary">
|
||
<a class="header-link" href="dash-feed://https%3A%2F%2Frealm.github.io%2FSwiftLint%2Fdocsets%2FSwiftLintCore.xml">
|
||
<img class="header-icon" src="img/dash.png" alt="Dash"/>
|
||
Install in Dash
|
||
</a>
|
||
</p>
|
||
</header>
|
||
|
||
<p class="breadcrumbs">
|
||
<a class="breadcrumb" href="index.html">SwiftLintCore</a>
|
||
<img class="carat" src="img/carat.png" alt=""/>
|
||
<a class="breadcrumb" href="Guides.html">Guides</a>
|
||
<img class="carat" src="img/carat.png" alt=""/>
|
||
accessibility_trait_for_button Reference
|
||
</p>
|
||
|
||
<div class="content-wrapper">
|
||
<nav class="navigation">
|
||
<ul class="nav-groups">
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Rules.html">Rules</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="rule-directory.html">Rule Directory</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Classes.html">Classes</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/BodyLengthVisitor.html">BodyLengthVisitor</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/CodeBlockVisitor.html">CodeBlockVisitor</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/CodeIndentingRewriter.html">CodeIndentingRewriter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/CodeIndentingRewriter/IndentationStyle.html">– IndentationStyle</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/DeclaredIdentifiersTrackingVisitor.html">DeclaredIdentifiersTrackingVisitor</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/RuleRegistry.html">RuleRegistry</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/RuleStorage.html">RuleStorage</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/SwiftLintFile.html">SwiftLintFile</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/ViolationsSyntaxRewriter.html">ViolationsSyntaxRewriter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Classes/ViolationsSyntaxVisitor.html">ViolationsSyntaxVisitor</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/AccessControlLevel.html">AccessControlLevel</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/CurrentRule.html">CurrentRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/IdentifierDeclaration.html">IdentifierDeclaration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/Issue.html">Issue</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/OptionType.html">OptionType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/RuleIdentifier.html">RuleIdentifier</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/RuleKind.html">RuleKind</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/RuleListError.html">RuleListError</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/SwiftExpressionKind.html">SwiftExpressionKind</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/SwiftSyntaxKindBridge.html">SwiftSyntaxKindBridge</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Enums/ViolationSeverity.html">ViolationSeverity</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/Array.html">Array</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/Bool.html">Bool</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/Double.html">Double</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/Int.html">Int</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/Optional.html">Optional</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/Set.html">Set</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Extensions/String.html">String</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/ASTRule.html">ASTRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/AcceptableByConfigurationElement.html">AcceptableByConfigurationElement</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/AnalyzerRule.html">AnalyzerRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols.html#/s:13SwiftLintCore17AnyCollectingRuleP">AnyCollectingRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/CacheDescriptionProvider.html">CacheDescriptionProvider</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/CollectingRule.html">CollectingRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/ConditionallySourceKitFree.html">ConditionallySourceKitFree</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/CorrectableRule.html">CorrectableRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/Documentable.html">Documentable</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols.html#/s:13SwiftLintCore19InlinableOptionTypeP">InlinableOptionType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols.html#/s:13SwiftLintCore9OptInRuleP">OptInRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/Rule.html">Rule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/RuleConfiguration.html">RuleConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/SeverityBasedRuleConfiguration.html">SeverityBasedRuleConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols.html#/s:13SwiftLintCore17SourceKitFreeRuleP">SourceKitFreeRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/SubstitutionCorrectableRule.html">SubstitutionCorrectableRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/SwiftSyntaxCorrectableRule.html">SwiftSyntaxCorrectableRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/SwiftSyntaxRule.html">SwiftSyntaxRule</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Protocols/VersionComparable.html">VersionComparable</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Structs.html">Structures</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Baseline.html">Baseline</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/ChildOptionSeverityConfiguration.html">ChildOptionSeverityConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Command.html">Command</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Command/Action.html">– Action</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Command/Modifier.html">– Modifier</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/ConfigurationElement.html">ConfigurationElement</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/ConfigurationElement/DeprecationNotice.html">– DeprecationNotice</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Correction.html">Correction</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Example.html">Example</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Location.html">Location</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/ReasonedRuleViolation.html">ReasonedRuleViolation</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/ReasonedRuleViolation/ViolationCorrection.html">– ViolationCorrection</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/RegexConfiguration.html">RegexConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/RegexConfiguration/ExecutionMode.html">– ExecutionMode</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Region.html">Region</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/RuleConfigurationDescription.html">RuleConfigurationDescription</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs.html#/s:13SwiftLintCore35RuleConfigurationDescriptionBuilderV">RuleConfigurationDescriptionBuilder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/RuleConfigurationOption.html">RuleConfigurationOption</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/RuleDescription.html">RuleDescription</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/RuleList.html">RuleList</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/RuleParameter.html">RuleParameter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/SeverityConfiguration.html">SeverityConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/SeverityLevelsConfiguration.html">SeverityLevelsConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/Stack.html">Stack</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/StyleViolation.html">StyleViolation</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/SwiftLintSyntaxMap.html">SwiftLintSyntaxMap</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/SwiftLintSyntaxToken.html">SwiftLintSyntaxToken</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Structs/SwiftVersion.html">SwiftVersion</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a class="nav-group-name-link" href="Macros.html">Macros</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Macros.html#/s:13SwiftLintCore32AcceptableByConfigurationElementyycfm">AcceptableByConfigurationElement()</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Macros.html#/s:13SwiftLintCore16AutoConfigParseryycfm">AutoConfigParser()</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a class="nav-group-task-link" href="Macros.html#/s:13SwiftLintCore0A10SyntaxRule15foldExpressions16explicitRewriter11correctable5optInySb_S3btcfm">SwiftSyntaxRule(foldExpressions:explicitRewriter:correctable:optIn:)</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<article class="main-content">
|
||
|
||
<section class="section">
|
||
<div class="section-content top-matter">
|
||
|
||
<h1 id='accessibility-trait-for-button' class='heading'>Accessibility Trait for Button</h1>
|
||
|
||
<p>All views with tap gestures added should include the .isButton or the .isLink accessibility traits</p>
|
||
|
||
<ul>
|
||
<li><strong>Identifier:</strong> <code>accessibility_trait_for_button</code></li>
|
||
<li><strong>Enabled by default:</strong> No</li>
|
||
<li><strong>Supports autocorrection:</strong> No</li>
|
||
<li><strong>Kind:</strong> lint</li>
|
||
<li><strong>Analyzer rule:</strong> No</li>
|
||
<li><strong>Minimum Swift compiler version:</strong> 5.1.0</li>
|
||
<li><strong>Default configuration:</strong>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Key</th><th>Value</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
severity
|
||
</td>
|
||
<td>
|
||
warning
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></li>
|
||
</ul>
|
||
<h2 id='rationale' class='heading'>Rationale</h2>
|
||
|
||
<p>The accessibility button and link traits are used to tell assistive technologies that an element is tappable. When an element has one of these traits, VoiceOver will automatically read “button” or “link” after the element’s label to let the user know that they can activate it.</p>
|
||
|
||
<p>When using a UIKit <code>UIButton</code> or SwiftUI <code>Button</code> or <code>Link</code>, the button trait is added by default, but when you manually add a tap gesture recognizer to an element, you need to explicitly add the button or link trait.
|
||
In most cases the button trait should be used, but for buttons that open a URL in an external browser we use the link trait instead. This rule attempts to catch uses of the SwiftUI <code>.onTapGesture</code> modifier where the <code>.isButton</code> or <code>.isLink</code> trait is not explicitly applied.</p>
|
||
<h2 id='non-triggering-examples' class='heading'>Non Triggering Examples</h2>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Button</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span> <span class="nv">label</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Link</span><span class="p">(</span><span class="s">"Open link"</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="n">myUrl</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="n">onTapGesture</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped - open URL"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="o">.</span><span class="nf">accessibility</span><span class="p">(</span><span class="nv">addTraits</span><span class="p">:</span> <span class="o">.</span><span class="n">isLink</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">accessibilityAddTraits</span><span class="p">(</span><span class="o">.</span><span class="n">isButton</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="n">onTapGesture</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">accessibility</span><span class="p">(</span><span class="nv">addTraits</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="n">isButton</span><span class="p">,</span> <span class="o">.</span><span class="n">isHeader</span><span class="p">])</span>
|
||
<span class="o">.</span><span class="n">onTapGesture</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="n">onTapGesture</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped - open URL"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="o">.</span><span class="nf">accessibilityAddTraits</span><span class="p">([</span><span class="o">.</span><span class="n">isHeader</span><span class="p">,</span> <span class="o">.</span><span class="n">isLink</span><span class="p">])</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">onTapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="o">.</span><span class="nf">accessibility</span><span class="p">(</span><span class="nv">addTraits</span><span class="p">:</span> <span class="o">.</span><span class="n">isButton</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">onTapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="nv">perform</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="o">.</span><span class="nf">accessibility</span><span class="p">(</span><span class="nv">addTraits</span><span class="p">:</span> <span class="o">.</span><span class="n">isButton</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="c1">// This rule does not include tap gestures with multiple taps for now.</span>
|
||
<span class="c1">// Custom gestures like this are also not very accessible, but require</span>
|
||
<span class="c1">// alternative ways to accomplish the same task with assistive tech.</span>
|
||
<span class="o">.</span><span class="nf">onTapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">2</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"double-tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Label</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">,</span> <span class="nv">systemImage</span><span class="p">:</span> <span class="s">"info.circle"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">onTapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="o">.</span><span class="nf">accessibility</span><span class="p">(</span><span class="nv">addTraits</span><span class="p">:</span> <span class="o">.</span><span class="n">isButton</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">HStack</span> <span class="p">{</span>
|
||
<span class="kt">Image</span><span class="p">(</span><span class="nv">systemName</span><span class="p">:</span> <span class="s">"info.circle"</span><span class="p">)</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="o">.</span><span class="n">onTapGesture</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="c1">// This modifier is not strictly required — each subview will inherit the button trait.</span>
|
||
<span class="c1">// That said, grouping a tappable stack into a single element is a good way to reduce</span>
|
||
<span class="c1">// the number of swipes required for a VoiceOver user to navigate the page.</span>
|
||
<span class="o">.</span><span class="nf">accessibilityElement</span><span class="p">(</span><span class="nv">children</span><span class="p">:</span> <span class="o">.</span><span class="n">combine</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">accessibility</span><span class="p">(</span><span class="nv">addTraits</span><span class="p">:</span> <span class="o">.</span><span class="n">isButton</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">gesture</span><span class="p">(</span><span class="kt">TapGesture</span><span class="p">()</span><span class="o">.</span><span class="n">onEnded</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="o">.</span><span class="nf">accessibilityAddTraits</span><span class="p">(</span><span class="o">.</span><span class="n">isButton</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">simultaneousGesture</span><span class="p">(</span><span class="kt">TapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">onEnded</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped - open URL"</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="o">.</span><span class="nf">accessibilityAddTraits</span><span class="p">(</span><span class="o">.</span><span class="n">isLink</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">highPriorityGesture</span><span class="p">(</span><span class="kt">TapGesture</span><span class="p">()</span><span class="o">.</span><span class="n">onEnded</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="o">.</span><span class="nf">accessibility</span><span class="p">(</span><span class="nv">addTraits</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="n">isButton</span><span class="p">])</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">gesture</span><span class="p">(</span><span class="kt">TapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">onEnded</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<h2 id='triggering-examples' class='heading'>Triggering Examples</h2>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="err">↓</span><span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="n">onTapGesture</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="err">↓</span><span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">accessibility</span><span class="p">(</span><span class="nv">addTraits</span><span class="p">:</span> <span class="o">.</span><span class="n">isHeader</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="n">onTapGesture</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="err">↓</span><span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">onTapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="err">↓</span><span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">onTapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="nv">perform</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="err">↓</span><span class="kt">Label</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">,</span> <span class="nv">systemImage</span><span class="p">:</span> <span class="s">"info.circle"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">onTapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="err">↓</span><span class="kt">HStack</span> <span class="p">{</span>
|
||
<span class="kt">Image</span><span class="p">(</span><span class="nv">systemName</span><span class="p">:</span> <span class="s">"info.circle"</span><span class="p">)</span>
|
||
<span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="o">.</span><span class="n">onTapGesture</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="err">↓</span><span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">gesture</span><span class="p">(</span><span class="kt">TapGesture</span><span class="p">()</span><span class="o">.</span><span class="n">onEnded</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="err">↓</span><span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">simultaneousGesture</span><span class="p">(</span><span class="kt">TapGesture</span><span class="p">(</span><span class="nv">count</span><span class="p">:</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">onEnded</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyView</span><span class="p">:</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">body</span><span class="p">:</span> <span class="kd">some</span> <span class="kt">View</span> <span class="p">{</span>
|
||
<span class="err">↓</span><span class="kt">Text</span><span class="p">(</span><span class="s">"Learn more"</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">highPriorityGesture</span><span class="p">(</span><span class="kt">TapGesture</span><span class="p">()</span><span class="o">.</span><span class="n">onEnded</span> <span class="p">{</span>
|
||
<span class="nf">print</span><span class="p">(</span><span class="s">"tapped"</span><span class="p">)</span>
|
||
<span class="p">})</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
|
||
</div>
|
||
</section>
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<section class="footer">
|
||
<p>© 2023 <a class="link" href="https://jpsim.com" target="_blank" rel="external noopener">JP Simard</a> under MIT.</p>
|
||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
|
||
</section>
|
||
</body>
|
||
</html>
|