Updated docs for next

This commit is contained in:
Website Deployment Script
2016-12-17 02:18:48 +00:00
parent 06667b073a
commit 7970b13838
+5 -2
View File
@@ -4,7 +4,9 @@ button will be an &#x27;OK&#x27; button.</p><p>This is an API that works both on
alerts. To show an alert that prompts the user to enter some information,
see <code>AlertIOS</code>; entering text in an alert is common on iOS only.</p><h2><a class="anchor" name="ios"></a>iOS <a class="hash-link" href="docs/alert.html#ios">#</a></h2><p>On iOS you can specify any number of buttons. Each button can optionally
specify a style, which is one of &#x27;default&#x27;, &#x27;cancel&#x27; or &#x27;destructive&#x27;.</p><h2><a class="anchor" name="android"></a>Android <a class="hash-link" href="docs/alert.html#android">#</a></h2><p>On Android at most three buttons can be specified. Android has a concept
of a neutral, negative and a positive button:</p><ul><li>If you specify one button, it will be the &#x27;positive&#x27; one (such as &#x27;OK&#x27;)</li><li>Two buttons mean &#x27;negative&#x27;, &#x27;positive&#x27; (such as &#x27;Cancel&#x27;, &#x27;OK&#x27;)</li><li>Three buttons mean &#x27;neutral&#x27;, &#x27;negative&#x27;, &#x27;positive&#x27; (such as &#x27;Later&#x27;, &#x27;Cancel&#x27;, &#x27;OK&#x27;)</li></ul><div class="prism language-javascript"><span class="token comment" spellcheck="true">// Works on both iOS and Android
of a neutral, negative and a positive button:</p><ul><li>If you specify one button, it will be the &#x27;positive&#x27; one (such as &#x27;OK&#x27;)</li><li>Two buttons mean &#x27;negative&#x27;, &#x27;positive&#x27; (such as &#x27;Cancel&#x27;, &#x27;OK&#x27;)</li><li>Three buttons mean &#x27;neutral&#x27;, &#x27;negative&#x27;, &#x27;positive&#x27; (such as &#x27;Later&#x27;, &#x27;Cancel&#x27;, &#x27;OK&#x27;)</li></ul><p>Note that by default alerts on Android can be dismissed by clicking outside of their alert box.
To prevent this behavior, you can provide
an optional <code>options</code> parameter <code>{ cancelable: false }</code> to the Alert method.</p><p>Example usage:</p><div class="prism language-javascript"><span class="token comment" spellcheck="true">// Works on both iOS and Android
</span>Alert<span class="token punctuation">.</span><span class="token function">alert<span class="token punctuation">(</span></span>
<span class="token string">&#x27;Alert Title&#x27;</span><span class="token punctuation">,</span>
<span class="token string">&#x27;My Alert Msg&#x27;</span><span class="token punctuation">,</span>
@@ -12,7 +14,8 @@ of a neutral, negative and a positive button:</p><ul><li>If you specify one butt
<span class="token punctuation">{</span>text<span class="token punctuation">:</span> <span class="token string">&#x27;Ask me later&#x27;</span><span class="token punctuation">,</span> onPress<span class="token punctuation">:</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">&gt;</span> console<span class="token punctuation">.</span><span class="token function">log<span class="token punctuation">(</span></span><span class="token string">&#x27;Ask me later pressed&#x27;</span><span class="token punctuation">)</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token punctuation">{</span>text<span class="token punctuation">:</span> <span class="token string">&#x27;Cancel&#x27;</span><span class="token punctuation">,</span> onPress<span class="token punctuation">:</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">&gt;</span> console<span class="token punctuation">.</span><span class="token function">log<span class="token punctuation">(</span></span><span class="token string">&#x27;Cancel Pressed&#x27;</span><span class="token punctuation">)</span><span class="token punctuation">,</span> style<span class="token punctuation">:</span> <span class="token string">&#x27;cancel&#x27;</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token punctuation">{</span>text<span class="token punctuation">:</span> <span class="token string">&#x27;OK&#x27;</span><span class="token punctuation">,</span> onPress<span class="token punctuation">:</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">&gt;</span> console<span class="token punctuation">.</span><span class="token function">log<span class="token punctuation">(</span></span><span class="token string">&#x27;OK Pressed&#x27;</span><span class="token punctuation">)</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token punctuation">]</span>
<span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token punctuation">{</span> cancelable<span class="token punctuation">:</span> <span class="token boolean">false</span> <span class="token punctuation">}</span>
<span class="token punctuation">)</span></div></div><span><h3><a class="anchor" name="methods"></a>Methods <a class="hash-link" href="docs/alert.html#methods">#</a></h3><div class="props"><div class="prop"><h4 class="methodTitle"><a class="anchor" name="alert"></a><span class="methodType">static </span>alert<span class="methodType">(title, message?, buttons?, options?, type?)</span> <a class="hash-link" href="docs/alert.html#alert">#</a></h4></div></div></span></div><p class="edit-page-block">You can <a target="_blank" href="https://github.com/facebook/react-native/blob/master/Libraries/Alert/Alert.js">edit the content above on GitHub</a> and send us a pull request!</p><div><div><table width="100%"><tbody><tr><td><h3><a class="anchor" name="examples"></a>Examples <a class="hash-link" href="docs/alert.html#examples">#</a></h3></td><td style="text-align:right;"><a target="_blank" href="https://github.com/facebook/react-native/blob/master/Examples/UIExplorer/js/AlertExample.js">Edit on GitHub</a></td></tr></tbody></table><div class="example-container"><div class="prism language-javascript"><span class="token string">&#x27;use strict&#x27;</span><span class="token punctuation">;</span>
<span class="token keyword">var</span> React <span class="token operator">=</span> <span class="token function">require<span class="token punctuation">(</span></span><span class="token string">&#x27;react&#x27;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>