Keyboard (lv_keyboard)
An on-screen virtual keyboard, a specialized Button Matrix.
Overview
The Keyboard is a specialized Button Matrix with predefined keymaps that provides an on-screen virtual keyboard. It can be attached to a Text Area so key presses edit its text.
Learn more in the LVGL Open documentation.
Enumerations
lv_keyboard_mode — Keyboard layout modes
| Value | Description |
|---|---|
text_upper | Show uppercase letters |
text_lower | Show lowercase letters |
text_arabic | Show Arabic characters |
special | Show special characters and symbols |
number | Show numeric keys |
user_1 | User-defined layout 1 |
user_2 | User-defined layout 2 |
user_3 | User-defined layout 3 |
user_4 | User-defined layout 4 |
Properties
Parts
Style parts of the widget with local style (e.g. style_bg_color-knob="0xff0000") or with style sheets (e.g. <style name="style_knob" selector="knob">). See Styles to learn more.
| Part | Description |
|---|---|
main | The background behind the keys (extends lv_buttonmatrix): background properties. pad_row and pad_column set the gaps between keys. |
items | The keys: text and background properties. Combine with the 'checked', 'pressed', 'focused' and 'disabled' states, e.g. items|pressed. |
Properties below are the widget's XML <api>; see API for how properties, parameters and elements work.
| Property | Type | Description |
|---|---|---|
mode | enum:lv_keyboard_mode | Set the keyboard layout |
popovers | bool | Show enlarged key previews on press |
textarea | lv_obj | Connect a textare to the keyboard |
Last updated on