site updates

ionic-team · Jan 31, 2020 · 64286f8 · 64286f8
1 parent e603032
commit 64286f8
Show file tree

Hide file tree

Showing 29 changed files with 755 additions and 1,126 deletions.
diff --git a/site/package-lock.json b/site/package-lock.json
diff --git a/site/package.json b/site/package.json
@@ -15,7 +15,7 @@
   "devDependencies": {
     "@stencil/core": "^0.17.0",
     "@stencil/router": "^0.3.1",
-    "@stencil/sass": "^0.1.1",
+    "@stencil/sass": "^1.1.1",
     "@stencil/state-tunnel": "0.0.9-1",
     "@stencil/utils": "0.0.5",
     "@types/glob": "^7.1.0",

diff --git a/site/src/assets/docs-content/apis/accessibility/api.html b/site/src/assets/docs-content/apis/accessibility/api.html
@@ -4,27 +4,27 @@
 <div class="avc-code-method">
                     <h3 class="avc-code-method-header" id="method-isScreenReaderEnabled-0">isScreenReaderEnabled</h3>
                     <div class="avc-code-method-signature">
-                      <span class="avc-code-method-name">isScreenReaderEnabled</span><span class="avc-code-paren">(</span><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="168">ScreenReaderEnabledResult</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
+                      <span class="avc-code-method-name">isScreenReaderEnabled</span><span class="avc-code-paren">(</span><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="172">ScreenReaderEnabledResult</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
     </div>
     <div class="avc-code-method-comment">Check if a screen reader is enabled on the device</div>
   <div class="avc-code-method-params">
 
   <div class="avc-code-method-returns-info">
-    <span class="avc-code-method-returns-label">Returns:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="168">ScreenReaderEnabledResult</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
+    <span class="avc-code-method-returns-label">Returns:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="172">ScreenReaderEnabledResult</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
   </div>
 
 </div></div>
 <div class="avc-code-method">
                     <h3 class="avc-code-method-header" id="method-speak-0">speak</h3>
                     <div class="avc-code-method-signature">
-                      <span class="avc-code-method-name">speak</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">options</span><span class="avc-code-param-colon">:</span> <avc-code-type type-id="165">AccessibilitySpeakOptions</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span>void<span class="avc-code-typearg-bracket">&gt;</span>
+                      <span class="avc-code-method-name">speak</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">options</span><span class="avc-code-param-colon">:</span> <avc-code-type type-id="169">AccessibilitySpeakOptions</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span>void<span class="avc-code-typearg-bracket">&gt;</span>
     </div>
     <div class="avc-code-method-comment">Speak a string with a connected screen reader.</div>
   <div class="avc-code-method-params">
 <div class="avc-code-method-param-info">
                 <span class="avc-code-method-param-info-name">options</span>
 
-<avc-code-type type-id="165">AccessibilitySpeakOptions</avc-code-type>
+<avc-code-type type-id="169">AccessibilitySpeakOptions</avc-code-type>
 </div>
 
   <div class="avc-code-method-returns-info">
@@ -35,7 +35,7 @@ <h3 class="avc-code-method-header" id="method-speak-0">speak</h3>
 <div class="avc-code-method">
                     <h3 class="avc-code-method-header" id="method-addListener-0">addListener</h3>
                     <div class="avc-code-method-signature">
-                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"accessibilityScreenReaderStateChange"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type type-id="1044">ScreenReaderStateChangeCallback</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
+                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"accessibilityScreenReaderStateChange"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type type-id="1121">ScreenReaderStateChangeCallback</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
     </div>
     <div class="avc-code-method-comment">Listen for screen reader state change (on/off)</div>
   <div class="avc-code-method-params">
@@ -47,7 +47,7 @@ <h3 class="avc-code-method-header" id="method-addListener-0">addListener</h3>
 <div class="avc-code-method-param-info">
                 <span class="avc-code-method-param-info-name">listenerFunc</span>
 
-<avc-code-type type-id="1044">ScreenReaderStateChangeCallback</avc-code-type>
+<avc-code-type type-id="1121">ScreenReaderStateChangeCallback</avc-code-type>
 </div>
 
   <div class="avc-code-method-returns-info">
@@ -57,7 +57,7 @@ <h3 class="avc-code-method-header" id="method-addListener-0">addListener</h3>
 </div></div>
 <h3 id="interfaces">Interfaces Used</h3>
 
-    <div class="avc-code-interface" id="type-168">
+    <div class="avc-code-interface" id="type-172">
       <h4 class="avc-code-interface-name">ScreenReaderEnabledResult</h4>
       <div class="avc-code-line">
         <span class="avc-code-keyword">interface</span> <span class="avc-code-type-name">ScreenReaderEnabledResult</span>
@@ -74,7 +74,7 @@ <h4 class="avc-code-interface-name">ScreenReaderEnabledResult</h4>
           </div>
 <span class="avc-code-line"><span class="avc-code-brace">}</span></span>
 
-    <div class="avc-code-interface" id="type-165">
+    <div class="avc-code-interface" id="type-169">
       <h4 class="avc-code-interface-name">AccessibilitySpeakOptions</h4>
       <div class="avc-code-line">
         <span class="avc-code-keyword">interface</span> <span class="avc-code-type-name">AccessibilitySpeakOptions</span>
@@ -100,7 +100,7 @@ <h4 class="avc-code-interface-name">AccessibilitySpeakOptions</h4>
           </div>
 <span class="avc-code-line"><span class="avc-code-brace">}</span></span>
 
-    <div class="avc-code-interface" id="type-1044">
+    <div class="avc-code-interface" id="type-1121">
       <h4 class="avc-code-interface-name">ScreenReaderStateChangeCallback</h4>
       <div class="avc-code-line">
         <span class="avc-code-keyword">type alias</span> <span class="avc-code-type-name">ScreenReaderStateChangeCallback</span>

diff --git a/site/src/assets/docs-content/apis/app/api.html b/site/src/assets/docs-content/apis/app/api.html
@@ -36,13 +36,13 @@ <h3 class="avc-code-method-header" id="method-exitApp-0">exitApp</h3>
 <div class="avc-code-method">
                     <h3 class="avc-code-method-header" id="method-getLaunchUrl-0">getLaunchUrl</h3>
                     <div class="avc-code-method-signature">
-                      <span class="avc-code-method-name">getLaunchUrl</span><span class="avc-code-paren">(</span><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="223">AppLaunchUrl</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
+                      <span class="avc-code-method-name">getLaunchUrl</span><span class="avc-code-paren">(</span><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="227">AppLaunchUrl</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
     </div>
     <div class="avc-code-method-comment">Get the URL the app was launched with, if any</div>
   <div class="avc-code-method-params">
 
   <div class="avc-code-method-returns-info">
-    <span class="avc-code-method-returns-label">Returns:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="223">AppLaunchUrl</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
+    <span class="avc-code-method-returns-label">Returns:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="227">AppLaunchUrl</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
   </div>
 
 </div></div>
@@ -67,7 +67,7 @@ <h3 class="avc-code-method-header" id="method-openUrl-0">openUrl</h3>
 <div class="avc-code-method">
                     <h3 class="avc-code-method-header" id="method-addListener-0">addListener</h3>
                     <div class="avc-code-method-signature">
-                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"appStateChange"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type>(state: <avc-code-type type-id="217">AppState</avc-code-type>) => void</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
+                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"appStateChange"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type>(state: <avc-code-type type-id="221">AppState</avc-code-type>) => void</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
     </div>
     <div class="avc-code-method-comment">Listen for changes in the App's active state (whether the app is in the foreground or background)</div>
   <div class="avc-code-method-params">
@@ -79,7 +79,7 @@ <h3 class="avc-code-method-header" id="method-addListener-0">addListener</h3>
 <div class="avc-code-method-param-info">
                 <span class="avc-code-method-param-info-name">listenerFunc</span>
 
-<avc-code-type>(state: <avc-code-type type-id="217">AppState</avc-code-type>) => void</avc-code-type>
+<avc-code-type>(state: <avc-code-type type-id="221">AppState</avc-code-type>) => void</avc-code-type>
 </div>
 
   <div class="avc-code-method-returns-info">
@@ -90,7 +90,7 @@ <h3 class="avc-code-method-header" id="method-addListener-0">addListener</h3>
 <div class="avc-code-method">
                     <h3 class="avc-code-method-header" id="method-addListener-1">addListener</h3>
                     <div class="avc-code-method-signature">
-                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"appUrlOpen"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type>(data: <avc-code-type type-id="219">AppUrlOpen</avc-code-type>) => void</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
+                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"appUrlOpen"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type>(data: <avc-code-type type-id="223">AppUrlOpen</avc-code-type>) => void</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
     </div>
     <div class="avc-code-method-comment">Listen for url open events for the app. This handles both custom URL scheme links as well
 as URLs your app handles (Universal Links on iOS and App Links on Android)</div>
@@ -103,7 +103,7 @@ <h3 class="avc-code-method-header" id="method-addListener-1">addListener</h3>
 <div class="avc-code-method-param-info">
                 <span class="avc-code-method-param-info-name">listenerFunc</span>
 
-<avc-code-type>(data: <avc-code-type type-id="219">AppUrlOpen</avc-code-type>) => void</avc-code-type>
+<avc-code-type>(data: <avc-code-type type-id="223">AppUrlOpen</avc-code-type>) => void</avc-code-type>
 </div>
 
   <div class="avc-code-method-returns-info">
@@ -114,7 +114,7 @@ <h3 class="avc-code-method-header" id="method-addListener-1">addListener</h3>
 <div class="avc-code-method">
                     <h3 class="avc-code-method-header" id="method-addListener-2">addListener</h3>
                     <div class="avc-code-method-signature">
-                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"appRestoredResult"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type>(data: <avc-code-type type-id="225">AppRestoredResult</avc-code-type>) => void</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
+                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"appRestoredResult"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type>(data: <avc-code-type type-id="229">AppRestoredResult</avc-code-type>) => void</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
     </div>
     <div class="avc-code-method-comment">If the app was launched with previously persisted plugin call data, such as on Android
 when an activity returns to an app that was closed, this call will return any data
@@ -128,7 +128,7 @@ <h3 class="avc-code-method-header" id="method-addListener-2">addListener</h3>
 <div class="avc-code-method-param-info">
                 <span class="avc-code-method-param-info-name">listenerFunc</span>
 
-<avc-code-type>(data: <avc-code-type type-id="225">AppRestoredResult</avc-code-type>) => void</avc-code-type>
+<avc-code-type>(data: <avc-code-type type-id="229">AppRestoredResult</avc-code-type>) => void</avc-code-type>
 </div>
 
   <div class="avc-code-method-returns-info">
@@ -139,9 +139,11 @@ <h3 class="avc-code-method-header" id="method-addListener-2">addListener</h3>
 <div class="avc-code-method">
                     <h3 class="avc-code-method-header" id="method-addListener-3">addListener</h3>
                     <div class="avc-code-method-signature">
-                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"backButton"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type>(data: <avc-code-type type-id="219">AppUrlOpen</avc-code-type>) => void</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
+                      <span class="avc-code-method-name">addListener</span><span class="avc-code-paren">(</span><span class="avc-code-param-name">eventName</span><span class="avc-code-param-colon">:</span> <span class="avc-code-string">"backButton"</span>, <span class="avc-code-param-name">listenerFunc</span><span class="avc-code-param-colon">:</span> <avc-code-type>(data: <avc-code-type type-id="223">AppUrlOpen</avc-code-type>) => void</avc-code-type><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> <avc-code-type type-id="12">PluginListenerHandle</avc-code-type>
     </div>
-    <div class="avc-code-method-comment">Listen for the hardware back button event (Android only). If you want to close the app, call `App.exitApp()`</div>
+    <div class="avc-code-method-comment">Listen for the hardware back button event (Android only). Listening for this event will disable the
+default back button behaviour, so you might want to call `window.history.back()` manually.
+If you want to close the app, call `App.exitApp()`.</div>
   <div class="avc-code-method-params">
 <div class="avc-code-method-param-info">
                 <span class="avc-code-method-param-info-name">eventName</span>
@@ -151,7 +153,7 @@ <h3 class="avc-code-method-header" id="method-addListener-3">addListener</h3>
 <div class="avc-code-method-param-info">
                 <span class="avc-code-method-param-info-name">listenerFunc</span>
 
-<avc-code-type>(data: <avc-code-type type-id="219">AppUrlOpen</avc-code-type>) => void</avc-code-type>
+<avc-code-type>(data: <avc-code-type type-id="223">AppUrlOpen</avc-code-type>) => void</avc-code-type>
 </div>
 
   <div class="avc-code-method-returns-info">
@@ -161,7 +163,7 @@ <h3 class="avc-code-method-header" id="method-addListener-3">addListener</h3>
 </div></div>
 <h3 id="interfaces">Interfaces Used</h3>
 
-    <div class="avc-code-interface" id="type-223">
+    <div class="avc-code-interface" id="type-227">
       <h4 class="avc-code-interface-name">AppLaunchUrl</h4>
       <div class="avc-code-line">
         <span class="avc-code-keyword">interface</span> <span class="avc-code-type-name">AppLaunchUrl</span>