Skip to content

Fix for making textarea scroll for software keyboard #717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KenVanHoeylandt merged 1 commit into from
Oct 25, 2026
Merged

Fix for making textarea scroll for software keyboard #717

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion Modules/lvgl-module/source/devices/keyboard.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ static LvglSoftwareKeyboard last_software_keyboard = {
.object = nullptr
};

// The top-level object that is moved up to keep the textarea above the software keyboard
static lv_obj_t* panned_object;

static lv_group_t* keyboard_group;
// The group that keypad indevs are attached to: keyboard_group, or the group of an overlay
static lv_group_t* active_group;
Expand Down Expand Up @@ -240,6 +243,8 @@ void lvgl_hardware_keyboard_remove_custom(lv_indev_t* indev) {
delete wrapper;
}

static void lvgl_software_keyboard_unpan();

static void textarea_show_keyboard(lv_event_t* event) {
// Re-checked here rather than gated once at lvgl_keyboard_add_textarea() time, so a hardware
// keyboard that connects/disconnects after the textarea was created is honored immediately.
Expand All @@ -248,8 +253,8 @@ static void textarea_show_keyboard(lv_event_t* event) {
}
lv_obj_t* target = lv_event_get_current_target_obj(event);
if (last_software_keyboard.object != nullptr) {
lv_obj_scroll_to_view_recursive(target, LV_ANIM_OFF);
lvgl_software_keyboard_show(&last_software_keyboard, target);
lv_obj_scroll_to_view(target, LV_ANIM_ON);
}
}

Expand All @@ -276,6 +281,7 @@ void lvgl_software_keyboard_destruct(LvglSoftwareKeyboard* keyboard) {

lv_obj_delete(keyboard->object);
keyboard->object = nullptr;
panned_object = nullptr;

last_software_keyboard = *keyboard;
}
Expand All @@ -284,11 +290,40 @@ void lvgl_software_keyboard_show(LvglSoftwareKeyboard* keyboard, lv_obj_t* texta
assert(keyboard->object != nullptr);
lv_obj_set_hidden(keyboard->object, false);
lv_keyboard_set_textarea(keyboard->object, textarea);
lvgl_software_keyboard_unpan();

lv_obj_t* keyboard_parent = lv_obj_get_parent(keyboard->object);
lv_obj_t* top = textarea;
while (lv_obj_get_parent(top) != nullptr && lv_obj_get_parent(top) != keyboard_parent) {
top = lv_obj_get_parent(top);
}
if (lv_obj_get_parent(top) == nullptr) {
return;
}

lv_obj_update_layout(keyboard->object);
lv_area_t keyboard_area;
lv_area_t textarea_area;
lv_obj_get_coords(keyboard->object, &keyboard_area);
lv_obj_get_coords(textarea, &textarea_area);
const int32_t overlap = textarea_area.y2 + LV_DPX(4) - keyboard_area.y1;
if (overlap > 0) {
lv_obj_set_style_translate_y(top, -overlap, LV_STATE_DEFAULT);
panned_object = top;
}
}

static void lvgl_software_keyboard_unpan() {
if (panned_object != nullptr) {
lv_obj_set_style_translate_y(panned_object, 0, LV_STATE_DEFAULT);
panned_object = nullptr;
}
}

void lvgl_software_keyboard_hide(LvglSoftwareKeyboard* keyboard) {
assert(keyboard->object != nullptr);
lv_obj_set_hidden(keyboard->object, true);
lvgl_software_keyboard_unpan();
}

bool lvgl_software_keyboard_is_enabled() {
Expand Down
Loading