An open API service indexing awesome lists of open source software.

https://github.com/mingrammer/python-curses-scroll-example

:tv: How to implement the scroll and paging in Python curses
https://github.com/mingrammer/python-curses-scroll-example

curses example paging python scroll

Last synced: 9 months ago
JSON representation

:tv: How to implement the scroll and paging in Python curses

Awesome Lists containing this project

README

          

# Python Curses Scroll Example

I'll introduce how to implement the scroll and paging in Python curses.

## What is purpose?

Scroll and paging are little a bit cumbersome to implement with curses. So, I'd like to share the code snippets to help for building the scroll and paging feature for your TUI based application.

## Key Idea

The key idea is simple. The idea is that compare the length of item list and current cursor position, then just calculate the next cursor position. Of course, there are some exceptions such as scroll overflow we must deal with.

## Run & Test

Clone this repository and run `python3 tui.py`

> It supports Python 3+ only. With Python 2, It might not be work correctly.

* Scroll
* KEY_UP (↑) for scroll up
* KEY_DOWN (↓) for scroll down
* Paging
* KEY_LEFT (←) for page up
* KEY_RIGHT (→) for page down

## Scroll Demo

[Scroll implementation](/tui.py#L86-L110)

[![Scroll In Python Curses](https://asciinema.org/a/166994.png)](https://asciinema.org/a/166994)

## Paging Demo

[Paging implementation](/tui.py#L112-L132)

[![Paging In Python Curses](https://asciinema.org/a/166995.png)](https://asciinema.org/a/166995)

## License

MIT