| <html devsite="true"> |
| <head> |
| <title>KeyboardOptions</title> |
| {% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} |
| {% include "_shared/_reference-head-tags.html" %} |
| </head> |
| <body> |
| <div id="metadata-info-block"></div> |
| <h1>KeyboardOptions</h1> |
| <p> |
| <pre>public final class <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html">KeyboardOptions</a></pre> |
| </p> |
| <hr> |
| <p>The keyboard configuration options for TextFields. It is not guaranteed if software keyboard will comply with the options provided here.</p> |
| <h2>Summary</h2> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%"><h3>Nested types</h3></th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td> |
| <div><code>public static class <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.Companion.html">KeyboardOptions.Companion</a></code></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%"><h3>Public fields</h3></th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td width="40%"><code>final boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#autoCorrect()">autoCorrect</a></code></div> |
| <p>informs the keyboard whether to enable auto correct.</p> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardCapitalization.html">KeyboardCapitalization</a></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#capitalization()">capitalization</a></code></div> |
| <p>informs the keyboard whether to automatically capitalize characters, words or sentences.</p> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/ImeAction.html">ImeAction</a></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#imeAction()">imeAction</a></code></div> |
| <p>The IME action.</p> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#keyboardType()">keyboardType</a></code></div> |
| <p>The keyboard type to be used in this text field.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%"><h3>Public constructors</h3></th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td> |
| <div><code><a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#KeyboardOptions(androidx.compose.ui.text.input.KeyboardCapitalization,kotlin.Boolean,androidx.compose.ui.text.input.KeyboardType,androidx.compose.ui.text.input.ImeAction)">KeyboardOptions</a>(<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardCapitalization.html">KeyboardCapitalization</a> capitalization,<br> boolean autoCorrect,<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a> keyboardType,<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/ImeAction.html">ImeAction</a> imeAction<br>)</code></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%"><h3>Public methods</h3></th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td width="40%"><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html">KeyboardOptions</a></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#copy(androidx.compose.ui.text.input.KeyboardCapitalization,kotlin.Boolean,androidx.compose.ui.text.input.KeyboardType,androidx.compose.ui.text.input.ImeAction)">copy</a>(<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardCapitalization.html">KeyboardCapitalization</a> capitalization,<br> boolean autoCorrect,<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a> keyboardType,<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/ImeAction.html">ImeAction</a> imeAction<br>)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#equals(kotlin.Any)">equals</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> other)</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>int</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#hashCode()">hashCode</a>()</code></div> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#toString()">toString</a>()</code></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="list"> |
| <h2>Public fields</h2> |
| <div class="api-item"><a name="getAutoCorrect()"></a><a name="setAutoCorrect()"></a><a name="getAutoCorrect--"></a><a name="setAutoCorrect--"></a> |
| <h3 class="api-name" id="autoCorrect()">autoCorrect</h3> |
| <pre class="api-signature no-pretty-print">public final boolean <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#autoCorrect()">autoCorrect</a></pre> |
| <p>informs the keyboard whether to enable auto correct. Only applicable to text based <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Email()">KeyboardType.Email</a></code>, <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Uri()">KeyboardType.Uri</a></code>. It will not be applied to <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Number()">KeyboardType.Number</a></code>. Most of keyboard implementations ignore this value for <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Text()">KeyboardType.Text</a></code>.</p> |
| </div> |
| <div class="api-item"><a name="getCapitalization()"></a><a name="setCapitalization()"></a><a name="getCapitalization--"></a><a name="setCapitalization--"></a> |
| <h3 class="api-name" id="capitalization()">capitalization</h3> |
| <pre class="api-signature no-pretty-print">public final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardCapitalization.html">KeyboardCapitalization</a> <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#capitalization()">capitalization</a></pre> |
| <p>informs the keyboard whether to automatically capitalize characters, words or sentences. Only applicable to only text based <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Text()">KeyboardType.Text</a></code>, <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Ascii()">KeyboardType.Ascii</a></code>. It will not be applied to <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Number()">KeyboardType.Number</a></code>.</p> |
| </div> |
| <div class="api-item"><a name="getImeAction()"></a><a name="setImeAction()"></a><a name="getImeAction--"></a><a name="setImeAction--"></a> |
| <h3 class="api-name" id="imeAction()">imeAction</h3> |
| <pre class="api-signature no-pretty-print">public final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/ImeAction.html">ImeAction</a> <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#imeAction()">imeAction</a></pre> |
| <p>The IME action. This IME action is honored by keyboard and may show specific icons on the keyboard. For example, search icon may be shown if <code><a href="/reference/androidx/compose/ui/text/input/ImeAction.Companion.html#Search()">ImeAction.Search</a></code> is specified. When <code><a href="/reference/androidx/compose/ui/text/input/ImeOptions.html#singleLine()">ImeOptions.singleLine</a></code> is false, the keyboard might show return key rather than the action requested here.</p> |
| </div> |
| <div class="api-item"><a name="getKeyboardType()"></a><a name="setKeyboardType()"></a><a name="getKeyboardType--"></a><a name="setKeyboardType--"></a> |
| <h3 class="api-name" id="keyboardType()">keyboardType</h3> |
| <pre class="api-signature no-pretty-print">public final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a> <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#keyboardType()">keyboardType</a></pre> |
| <p>The keyboard type to be used in this text field. Note that this input type is honored by keyboard and shows corresponding keyboard but this is not guaranteed. For example, some keyboards may send non-ASCII character even if you set <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Ascii()">KeyboardType.Ascii</a></code>.</p> |
| </div> |
| </div> |
| <div class="list"> |
| <h2>Public constructors</h2> |
| <div class="api-item"><a name="KeyboardOptions(androidx.compose.ui.text.input.KeyboardCapitalization, kotlin.Boolean, androidx.compose.ui.text.input.KeyboardType, androidx.compose.ui.text.input.ImeAction)"></a><a name="KeyboardOptions-androidx.compose.ui.text.input.KeyboardCapitalization-kotlin.Boolean-androidx.compose.ui.text.input.KeyboardType-androidx.compose.ui.text.input.ImeAction-"></a><a name="keyboardoptions"></a> |
| <h3 class="api-name" id="KeyboardOptions(androidx.compose.ui.text.input.KeyboardCapitalization,kotlin.Boolean,androidx.compose.ui.text.input.KeyboardType,androidx.compose.ui.text.input.ImeAction)">KeyboardOptions</h3> |
| <pre class="api-signature no-pretty-print">public <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#KeyboardOptions(androidx.compose.ui.text.input.KeyboardCapitalization,kotlin.Boolean,androidx.compose.ui.text.input.KeyboardType,androidx.compose.ui.text.input.ImeAction)">KeyboardOptions</a>(<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardCapitalization.html">KeyboardCapitalization</a> capitalization,<br> boolean autoCorrect,<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a> keyboardType,<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/ImeAction.html">ImeAction</a> imeAction<br>)</pre> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">Parameters</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td width="40%"><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardCapitalization.html">KeyboardCapitalization</a> capitalization</code></td> |
| <td> |
| <p>informs the keyboard whether to automatically capitalize characters, words or sentences. Only applicable to only text based <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Text()">KeyboardType.Text</a></code>, <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Ascii()">KeyboardType.Ascii</a></code>. It will not be applied to <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Number()">KeyboardType.Number</a></code>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>boolean autoCorrect</code></td> |
| <td> |
| <p>informs the keyboard whether to enable auto correct. Only applicable to text based <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Email()">KeyboardType.Email</a></code>, <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Uri()">KeyboardType.Uri</a></code>. It will not be applied to <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Number()">KeyboardType.Number</a></code>. Most of keyboard implementations ignore this value for <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a></code>s such as <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Text()">KeyboardType.Text</a></code>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a> keyboardType</code></td> |
| <td> |
| <p>The keyboard type to be used in this text field. Note that this input type is honored by keyboard and shows corresponding keyboard but this is not guaranteed. For example, some keyboards may send non-ASCII character even if you set <code><a href="/reference/androidx/compose/ui/text/input/KeyboardType.Companion.html#Ascii()">KeyboardType.Ascii</a></code>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/ImeAction.html">ImeAction</a> imeAction</code></td> |
| <td> |
| <p>The IME action. This IME action is honored by keyboard and may show specific icons on the keyboard. For example, search icon may be shown if <code><a href="/reference/androidx/compose/ui/text/input/ImeAction.Companion.html#Search()">ImeAction.Search</a></code> is specified. When <code><a href="/reference/androidx/compose/ui/text/input/ImeOptions.html#singleLine()">ImeOptions.singleLine</a></code> is false, the keyboard might show return key rather than the action requested here.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="list"> |
| <h2>Public methods</h2> |
| <div class="api-item"><a name="copy(androidx.compose.ui.text.input.KeyboardCapitalization, kotlin.Boolean, androidx.compose.ui.text.input.KeyboardType, androidx.compose.ui.text.input.ImeAction)"></a><a name="copy-androidx.compose.ui.text.input.KeyboardCapitalization-kotlin.Boolean-androidx.compose.ui.text.input.KeyboardType-androidx.compose.ui.text.input.ImeAction-"></a><a name="copy"></a> |
| <h3 class="api-name" id="copy(androidx.compose.ui.text.input.KeyboardCapitalization,kotlin.Boolean,androidx.compose.ui.text.input.KeyboardType,androidx.compose.ui.text.input.ImeAction)">copy</h3> |
| <pre class="api-signature no-pretty-print">public final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html">KeyboardOptions</a> <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#copy(androidx.compose.ui.text.input.KeyboardCapitalization,kotlin.Boolean,androidx.compose.ui.text.input.KeyboardType,androidx.compose.ui.text.input.ImeAction)">copy</a>(<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardCapitalization.html">KeyboardCapitalization</a> capitalization,<br> boolean autoCorrect,<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/KeyboardType.html">KeyboardType</a> keyboardType,<br> @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/text/input/ImeAction.html">ImeAction</a> imeAction<br>)</pre> |
| </div> |
| <div class="api-item"><a name="equals-kotlin.Any-"></a><a name="equals"></a> |
| <h3 class="api-name" id="equals(kotlin.Any)">equals</h3> |
| <pre class="api-signature no-pretty-print">public boolean <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#equals(kotlin.Any)">equals</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a> other)</pre> |
| </div> |
| <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a> |
| <h3 class="api-name" id="hashCode()">hashCode</h3> |
| <pre class="api-signature no-pretty-print">public int <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#hashCode()">hashCode</a>()</pre> |
| </div> |
| <div class="api-item"><a name="toString--"></a><a name="tostring"></a> |
| <h3 class="api-name" id="toString()">toString</h3> |
| <pre class="api-signature no-pretty-print">public @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a> <a href="/reference/androidx/compose/foundation/text/KeyboardOptions.html#toString()">toString</a>()</pre> |
| </div> |
| </div> |
| </body> |
| </html> |
