UI Screens Reference¶
The TUI application is built using Textual and organized into different screens for different views.
EntryListScreen¶
The main screen showing the list of entries.
Bases: Screen
Screen for displaying a list of feed entries with sorting.
Source code in miniflux_tui/ui/screens/entry_list.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 | |
app
property
¶
Get the app instance with proper type hints.
action_collapse_all()
¶
Collapse all feeds (Shift+Z).
Source code in miniflux_tui/ui/screens/entry_list.py
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 | |
action_collapse_feed()
¶
Collapse the highlighted feed (h or left arrow).
Source code in miniflux_tui/ui/screens/entry_list.py
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 | |
action_cursor_down()
¶
Move cursor down to next visible entry item, skipping collapsed entries.
Source code in miniflux_tui/ui/screens/entry_list.py
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 | |
action_cursor_up()
¶
Move cursor up to previous visible entry item, skipping collapsed entries.
Source code in miniflux_tui/ui/screens/entry_list.py
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 | |
action_cycle_sort()
¶
Cycle through sort modes.
Source code in miniflux_tui/ui/screens/entry_list.py
877 878 879 880 881 882 883 884 885 886 | |
action_expand_all()
¶
Expand all feeds (Shift+G).
If not in grouped mode, enable grouped mode first. Then expand all collapsed feeds.
Source code in miniflux_tui/ui/screens/entry_list.py
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 | |
action_expand_feed()
¶
Expand the highlighted feed (l or right arrow).
Source code in miniflux_tui/ui/screens/entry_list.py
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 | |
action_quit()
¶
Quit the application.
Source code in miniflux_tui/ui/screens/entry_list.py
1120 1121 1122 | |
action_refresh()
async
¶
Refresh the current feed on the server (Issue #55 - Feed operations).
Source code in miniflux_tui/ui/screens/entry_list.py
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 | |
action_refresh_all_feeds()
async
¶
Refresh all feeds on the server (Issue #55 - Feed operations).
Source code in miniflux_tui/ui/screens/entry_list.py
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 | |
action_save_entry()
async
¶
Save entry to third-party service.
Source code in miniflux_tui/ui/screens/entry_list.py
865 866 867 868 869 870 871 872 873 874 875 | |
action_search()
¶
Clear current search filter.
Toggles search mode off and refreshes the display to show all entries.
Source code in miniflux_tui/ui/screens/entry_list.py
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 | |
action_show_help()
¶
Show keyboard help.
Source code in miniflux_tui/ui/screens/entry_list.py
1112 1113 1114 | |
action_show_starred()
async
¶
Load and show only starred entries.
Source code in miniflux_tui/ui/screens/entry_list.py
1074 1075 1076 1077 1078 1079 1080 | |
action_show_status()
¶
Show system status and feed health.
Source code in miniflux_tui/ui/screens/entry_list.py
1116 1117 1118 | |
action_show_unread()
async
¶
Load and show only unread entries.
Source code in miniflux_tui/ui/screens/entry_list.py
1066 1067 1068 1069 1070 1071 1072 | |
action_toggle_category_group()
¶
Toggle grouping by category (Issue #54 - Category support).
Source code in miniflux_tui/ui/screens/entry_list.py
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 | |
action_toggle_fold()
¶
Toggle fold state of highlighted feed (only works in grouped mode).
Source code in miniflux_tui/ui/screens/entry_list.py
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 | |
action_toggle_group()
¶
Toggle grouping by feed.
Source code in miniflux_tui/ui/screens/entry_list.py
888 889 890 891 | |
action_toggle_read()
async
¶
Toggle read/unread status of current entry.
Source code in miniflux_tui/ui/screens/entry_list.py
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 | |
action_toggle_star()
async
¶
Toggle star status of current entry.
Source code in miniflux_tui/ui/screens/entry_list.py
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 | |
compose()
¶
Create child widgets.
Source code in miniflux_tui/ui/screens/entry_list.py
170 171 172 173 174 | |
on_list_view_selected(event)
¶
Handle ListView selection (Enter key).
Source code in miniflux_tui/ui/screens/entry_list.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | |
on_mount()
¶
Called when screen is mounted.
Source code in miniflux_tui/ui/screens/entry_list.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | |
on_screen_resume()
¶
Called when screen is resumed (e.g., after returning from entry reader).
Source code in miniflux_tui/ui/screens/entry_list.py
194 195 196 197 198 199 200 201 202 203 204 | |
set_search_term(search_term)
¶
Set search term and filter entries.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
search_term
|
str
|
The search term to filter entries by (title or content) |
required |
Source code in miniflux_tui/ui/screens/entry_list.py
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 | |
Key Features¶
- Entry display: Shows entries with status icons and formatting
- Sorting: Multiple sort modes (date, feed, status)
- Grouping: Optional grouping by feed with expand/collapse
- Filtering: Filter to unread or starred entries only
- Navigation: Vim-style cursor movement (j/k)
Actions¶
| Method | Binding | Description |
|---|---|---|
action_cursor_down |
j |
Move cursor down |
action_cursor_up |
k |
Move cursor up |
action_select_entry |
Enter |
Open entry in reader |
action_toggle_read |
m |
Toggle read/unread |
action_toggle_star |
* |
Toggle star status |
action_cycle_sort |
s |
Cycle sort modes |
action_toggle_group |
g |
Toggle grouping |
action_expand_feed |
l |
Expand feed |
action_collapse_feed |
h |
Collapse feed |
action_refresh |
r |
Refresh entries |
EntryReaderScreen¶
The detailed view for reading a single entry.
Bases: Screen
Screen for reading a single feed entry.
Source code in miniflux_tui/ui/screens/entry_reader.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | |
app
property
¶
Get the app instance with proper type hints.
action_back()
¶
Return to entry list.
Source code in miniflux_tui/ui/screens/entry_reader.py
164 165 166 | |
action_fetch_original()
async
¶
Fetch original content from source.
Source code in miniflux_tui/ui/screens/entry_reader.py
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
action_mark_unread()
async
¶
Mark entry as unread.
Source code in miniflux_tui/ui/screens/entry_reader.py
168 169 170 171 172 173 174 175 176 | |
action_next_entry()
async
¶
Navigate to next entry.
Source code in miniflux_tui/ui/screens/entry_reader.py
233 234 235 236 237 238 239 240 241 242 243 244 | |
action_open_browser()
¶
Open entry URL in web browser.
Source code in miniflux_tui/ui/screens/entry_reader.py
201 202 203 204 205 206 207 | |
action_page_down()
¶
Scroll down one page.
Source code in miniflux_tui/ui/screens/entry_reader.py
156 157 158 | |
action_page_up()
¶
Scroll up one page.
Source code in miniflux_tui/ui/screens/entry_reader.py
160 161 162 | |
action_previous_entry()
async
¶
Navigate to previous entry.
Source code in miniflux_tui/ui/screens/entry_reader.py
246 247 248 249 250 251 252 253 254 255 256 257 | |
action_quit()
¶
Quit the application.
Source code in miniflux_tui/ui/screens/entry_reader.py
331 332 333 | |
action_save_entry()
async
¶
Save entry to third-party service.
Source code in miniflux_tui/ui/screens/entry_reader.py
192 193 194 195 196 197 198 199 | |
action_scroll_down()
¶
Scroll down one line.
Source code in miniflux_tui/ui/screens/entry_reader.py
148 149 150 | |
action_scroll_up()
¶
Scroll up one line.
Source code in miniflux_tui/ui/screens/entry_reader.py
152 153 154 | |
action_show_help()
¶
Show keyboard help.
Source code in miniflux_tui/ui/screens/entry_reader.py
323 324 325 | |
action_show_status()
¶
Show system status and feed health.
Source code in miniflux_tui/ui/screens/entry_reader.py
327 328 329 | |
action_toggle_star()
async
¶
Toggle star status.
Source code in miniflux_tui/ui/screens/entry_reader.py
178 179 180 181 182 183 184 185 186 187 188 189 190 | |
compose()
¶
Create child widgets.
Source code in miniflux_tui/ui/screens/entry_reader.py
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | |
on_mount()
async
¶
Called when screen is mounted.
Source code in miniflux_tui/ui/screens/entry_reader.py
93 94 95 96 97 98 99 100 | |
refresh_screen()
async
¶
Refresh the screen with current entry.
Source code in miniflux_tui/ui/screens/entry_reader.py
259 260 261 262 263 264 265 266 267 268 | |
Features¶
- Full entry display: Shows title, content, metadata
- Navigation: Move between entries in the current list (J/K)
- Content: HTML is converted to readable Markdown
- Actions: Mark read/unread, star, save, open in browser
Available Actions¶
| Method | Binding | Description |
|---|---|---|
action_next_entry |
J |
Move to next entry |
action_prev_entry |
K |
Move to previous entry |
action_toggle_read |
m |
Toggle read/unread |
action_toggle_star |
* |
Toggle star |
action_save_entry |
e |
Save entry |
action_open_in_browser |
o |
Open URL in browser |
HelpScreen¶
Shows keyboard shortcuts and help information.
Bases: Screen
Screen displaying keyboard shortcuts and help information.
Source code in miniflux_tui/ui/screens/help.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | |
__init__(**kwargs)
¶
Initialize help screen with server info placeholders.
Source code in miniflux_tui/ui/screens/help.py
24 25 26 27 28 29 | |
action_close()
¶
Close the help screen.
Source code in miniflux_tui/ui/screens/help.py
159 160 161 | |
compose()
¶
Create child widgets.
Source code in miniflux_tui/ui/screens/help.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | |
on_mount()
async
¶
Called when screen is mounted - load server information.
Source code in miniflux_tui/ui/screens/help.py
117 118 119 | |
MinifluxTUI (Main App)¶
The main application container.
Bases: App
A Textual TUI application for Miniflux.
Source code in miniflux_tui/ui/app.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | |
__init__(config, driver_class=None, css_path=None, watch_css=False)
¶
Initialize the Miniflux TUI application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
Config
|
Application configuration |
required |
driver_class
|
type[Driver] | None
|
Textual driver class |
None
|
css_path
|
str | None
|
Path to custom CSS file |
None
|
watch_css
|
bool
|
Whether to watch CSS file for changes |
False
|
Source code in miniflux_tui/ui/app.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 | |
action_refresh_entries()
async
¶
Refresh entries from API.
Source code in miniflux_tui/ui/app.py
224 225 226 227 | |
action_show_starred()
async
¶
Show starred entries.
Source code in miniflux_tui/ui/app.py
234 235 236 237 | |
action_show_unread()
async
¶
Show unread entries.
Source code in miniflux_tui/ui/app.py
229 230 231 232 | |
load_categories()
async
¶
Load categories from Miniflux API.
Source code in miniflux_tui/ui/app.py
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | |
load_entries(view='unread')
async
¶
Load entries from Miniflux API.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view
|
str
|
View type - "unread" or "starred" |
'unread'
|
Source code in miniflux_tui/ui/app.py
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | |
on_mount()
async
¶
Called when app is mounted.
Source code in miniflux_tui/ui/app.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | |
on_unmount()
async
¶
Called when app is unmounted.
Source code in miniflux_tui/ui/app.py
239 240 241 242 243 | |
push_entry_reader(entry, entry_list=None, current_index=0)
¶
Push entry reader screen for a specific entry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entry
|
Entry
|
Entry to display |
required |
entry_list
|
list | None
|
Full list of entries for navigation |
None
|
current_index
|
int
|
Current position in the entry list |
0
|
Source code in miniflux_tui/ui/app.py
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | |
Methods¶
- push_entry_reader: Opens an entry in the detailed reader view
- load_entries: Fetches entries from the API
Navigation Flow¶
MinifluxTUI (App)
├─ EntryListScreen (main view)
│ ├─ navigate with j/k
│ ├─ press Enter → EntryReaderScreen
│ ├─ press ? → HelpScreen
│ └─ press q → exit
├─ EntryReaderScreen (detail view)
│ ├─ navigate with J/K
│ └─ press Escape → back to EntryListScreen
└─ HelpScreen (help view)
└─ press any key → back to previous screen
Widget Classes¶
EntryListItem¶
Custom ListItem for displaying an entry in the list.
FeedHeaderItem¶
Custom ListItem for displaying a feed group header.
Both use CSS-based hiding for collapsed feeds (via the "collapsed" class).
Styling¶
The application uses Textual's CSS system. Main styles are defined in:
- miniflux_tui/ui/app.py - Application-wide styles
- Screen CSS in individual screen files
Color customization is available through configuration (theme colors).