Skip to content

KeyboardType

Inherits: Enum

The type of information for which to optimize the text input control.

On Android, behavior may vary across device and keyboard provider.

Properties

  • DATETIME

    Optimized for date and time information.

  • EMAIL

    Optimized for email addresses.

  • MULTILINE

    Optimized for multiline textual information.

  • NAME

    Optimized for a person's name.

  • NONE

    Prevents the OS from showing the on-screen virtual keyboard.

  • NUMBER

    Optimized for unsigned numerical information without a decimal point.

  • PHONE

    Optimized for telephone numbers.

  • STREET_ADDRESS

    Optimized for postal mailing addresses.

  • TEXT

    Optimized for textual information.

  • TWITTER

    Optimized for social media.

  • URL

    Optimized for URLs.

  • VISIBLE_PASSWORD

    Optimized for passwords that are visible to the user.

  • WEB_SEARCH

    Optimized for web searches.

Properties#

DATETIME = 'datetime' class-attribute instance-attribute #

Optimized for date and time information.

  • On iOS, requests the default keyboard.
  • On Android, requests a keyboard with ready access to the number keys, ":", and "-".

EMAIL = 'email' class-attribute instance-attribute #

Optimized for email addresses.

Requests a keyboard with ready access to the "@" and "." keys.

MULTILINE = 'multiline' class-attribute instance-attribute #

Optimized for multiline textual information.

Requests the default platform keyboard, but accepts newlines when the enter key is pressed. This is the input type used for all multiline text fields.

NAME = 'name' class-attribute instance-attribute #

Optimized for a person's name.

NONE = 'none' class-attribute instance-attribute #

Prevents the OS from showing the on-screen virtual keyboard.

NUMBER = 'number' class-attribute instance-attribute #

Optimized for unsigned numerical information without a decimal point.

Requests a default keyboard with ready access to the number keys.

PHONE = 'phone' class-attribute instance-attribute #

Optimized for telephone numbers.

Requests a keyboard with ready access to the number keys, "*", and "#".

STREET_ADDRESS = 'streetAddress' class-attribute instance-attribute #

Optimized for postal mailing addresses.

TEXT = 'text' class-attribute instance-attribute #

Optimized for textual information.

Requests the default platform keyboard.

TWITTER = 'twitter' class-attribute instance-attribute #

Optimized for social media.

Requests a keyboard that includes keys useful for handles and tags.

  • On iOS, requests a default keyboard with ready access to the "@" and "#" keys.
  • On Android this is remapped to the EMAIL keyboard type as it always shows the "@" key.

URL = 'url' class-attribute instance-attribute #

Optimized for URLs.

Requests a keyboard with ready access to the "/" and "." keys.

VISIBLE_PASSWORD = 'visiblePassword' class-attribute instance-attribute #

Optimized for passwords that are visible to the user.

Requests a keyboard with ready access to both letters and numbers.

Optimized for web searches.

Requests a keyboard that includes keys useful for web searches as well as URLs.

  • On iOS, requests a default keyboard with ready access to the "." key. In contrast to URL, a space bar is available.
  • On Android this is remapped to the URL keyboard type as it always shows a space bar.