textual_extras
textual_extras copied to clipboard
kraanzu
(WIP) A collection of widgets for the awesome textual framework !
Textual_Extras
This is a hobby projects where I am building some usable widgets that could come in handy
when building projects with textual (This project will most likely never merge in the original repo)
There is a repo that does the same kind of thing for inputs named - textual_inputs but...
there were so many things i wanted to modify... so I created my own little library
⚠️ NOTE: Textual is going under rapid development and some things, at some point of time, might break..
so PRs are more than welcome :)
What is Textual?
Textual is a TUI (Text User Interface) framework for Python inspired by modern web development.
Installation
One Liner
python -m pip install git+https://github.com/kraanzu/textual_extras.git
Or if you prefer Manual Installation
git clone https://github.com/kraanzu/textual_extras.git
cd termtyper
pip install .
💡 Widget Ideas:
✔️ Text Input
A Simple, Single Line Text Input Box
Features:
- [x] Have shortcuts for smooth travelling in the input area (see at the end of the section for more details)
- [x] Support for placeholders and title customization
- [x] Support for password protected texts
- [x] Movable view with respect to the cursor
- [x] Fully responsive
- [x] Blacklisting and whitelisting of letters
- [ ] Inline Syntax highlighing
- [ ] Inline passwords
- [ ] Simultaneous update of rich markup
Controls
- home => Moves cursor to the start of the text
- end => Moves cursor to the end of the text
- left/right arrow => Moves cursor by one position in the specified direction
- ctrl + left/right => Moves cursor to the next space in the specified direction
- backspace/delete => Delete one letter in the specified direction
- ctrl + w => Delte a whole word to the left (Space serves as the delimiter)
- ctrl + del => Delte a whole word to the right (Space serves as the delimiter)
- ctrl + v => Paste the content from your system clipboard
⚠️(WIP) Multi-Line Text Input
A Simple, Multi Line Text Input Box..
Features:
- [x] Have shortcuts for smooth travelling in the input area (see at the end of the section for more details)
- [x] Support for placeholders and title customization
- [x] Support for password protected texts
- [x] Movable view with respect to the cursor
- [x] Both fixed and auto-change mode available for height
- [x] Blacklisting and whitelisting of letters
- [x] Fully responsive
- [ ] Inline Syntax highlighing
- [ ] Inline passwords
- [ ] Simultaneous update of rich markup
Controls
- home => Moves cursor to the start of the current line
- ctrl+home => Moves cursor to the start of the first line
- end => Moves cursor to the end of the current line
- ctrl+end => Moves cursor to the end of the last line
- left/right arrow => Moves cursor by one position in the specified direction
- ctrl + left/right => Moves cursor to the next space in the specified direction
- up/down arrow => Moves up or down at the same cursor position in the specified direction
- backspace/delete => Delete one letter in the specified direction
- ctrl + del => Delte a whole word to the right (Space serves as the delimiter)
- ctrl + v => Paste the content from your system clipboard
TODO
- [ ] Implenent proper handling for newline character, currently it only provides writing without "\n"
🚫(TODO) Syntax Box
A Simple, Mutli Line Code Input Box with syntax highlighting..
Features:
- TODO
🚫(TODO) List
A List View to show, add, delete and modify items..
Features:
- TODO
🚫(TODO) Searchable List
A List with a bar to search for items in the list..
Features:
- TODO
🚫(TODO) Notification
A notification with a timeout animation
Features:
- TODO
Emits
TextChanged => Emitted when the text in the input area is changed
PyperclipError => Emitted when there is a problem when pasting text from system clipboard (see Some caveats)
InvalidInputAttempt => Emitted when there is an attempt to input a letter which is in blacklist or not in the whitelist
Some caveats
⚠️ NOTE: ctrl+v should work just fine on windows and mac.. On linux if you are on X11 system.. consider adding
xclipfor this feature
On Ubuntu : sudo apt install xclip
On ArchLinux : well you should know it already if you use Arch.. I use Arch btw :)
kraanzu