SuperLightTUI
๐ฆ An immediate-mode Rust TUI framework with flexbox layout and Tailwind-style chaining API.
File Explorer
Download Latest Version (.zip)- REFERENCES.md
- SKILL.md
- SKILL.md
- REFERENCES.md
- SKILL.md
- SKILL.md
- bug_report.md
- feature_request.md
- ci.yml
- release.yml
- CODEOWNERS
- PULL_REQUEST_TEMPLATE.md
- demo.png
- demo_dashboard.png
- demo_fire.gif
- demo_game.gif
- demo_pretext.gif
- demo_spreadsheet.png
- demo_website.png
- benchmarks.rs
- lib.rs
- Cargo.toml
- AI_GUIDE.md
- ANIMATION.md
- API_DESIGN.md
- ARCHITECTURE.md
- BACKENDS.md
- COMPETITIVE_ANALYSIS.md
- COMPLETE_REFERENCE.md
- COOKBOOK.md
- DEBUGGING.md
- DEMO_GUIDE.md
- DESIGN_PRINCIPLES.md
- EXAMPLES.md
- FEATURES.md
- llms.txt
- MIGRATION.md
- NAMING.md
- PATTERNS.md
- PERFORMANCE.md
- POSITIONING.md
- PREVIOUS_FRAME_GUIDE.md
- QUICK_START.md
- README.es.md
- README.ja.md
- README.ko.md
- README.md
- README.zh-CN.md
- RUSTDOC_GUIDE.md
- STATE_APIS.md
- TESTING.md
- THEMING.md
- WIDGETS.md
- anim.rs
- async_demo.rs
- canvas_tour.rs
- color_picker.rs
- cookbook_dashboard.rs
- cookbook_file_picker.rs
- cookbook_login.rs
- cookbook_modal_toast.rs
- cookbook_table.rs
- cookbook_tour.rs
- counter.rs
- debug_selection.rs
- demo.rs
- demo_cjk.rs
- demo_cli.rs
- demo_dashboard.rs
- demo_design_system.rs
- demo_fire.rs
- demo_game.rs
- demo_ime.rs
- demo_infoviz.rs
- demo_key_test.rs
- demo_kitty_image.rs
- demo_overlay_anchor.rs
- demo_pretext.rs
- demo_raw_draw.rs
- demo_spreadsheet.rs
- demo_table.rs
- demo_trading.rs
- demo_website.rs
- error_boundary_demo.rs
- hello.rs
- inline.rs
- perf_interactive.rs
- perf_regression.rs
- showcase_tour.rs
- system_tour.rs
- test_mouse.rs
- text_tour.rs
- theme_hot_reload.rs
- v020_breadcrumb_response.rs
- v020_ctrl_c_passthrough.rs
- v020_dx_shortcuts.rs
- v020_gauge.rs
- v020_gutter_highlights.rs
- v020_keymap_help.rs
- v020_modal_trap.rs
- v020_named_focus.rs
- v020_perf_audit.rs
- v020_progress_response.rs
- v020_regression_panel.rs
- v020_showcase.rs
- v020_spacing_scale.rs
- v020_split_pane.rs
- v020_static_log.rs
- v020_test_utils.rs
- v020_theme_subtree.rs
- v020_tour.rs
- v020_use_effect.rs
- v020_use_state_keyed.rs
- v020_widthspec.rs
- v0210_widgets.rs
- v0211_tour.rs
- api_audit.sh
- ghostty_demos.sh
- axis.rs
- bar.rs
- braille.rs
- grid.rs
- render.rs
- gauge.rs
- gutter.rs
- layout.rs
- line_wrap_tests.rs
- rich_output.rs
- split.rs
- status.rs
- tests.rs
- text.rs
- feedback.rs
- tests.rs
- text_input.rs
- textarea_progress.rs
- collections.rs
- events.rs
- rich_markdown.rs
- selection.rs
- tree_widgets.rs
- async_tasks.rs
- async_tasks_tests.rs
- bars.rs
- container.rs
- core.rs
- helpers.rs
- runtime.rs
- scheduler_tests.rs
- state.rs
- tests.rs
- widget.rs
- widgets_display.rs
- widgets_input.rs
- widgets_interactive.rs
- widgets_viz.rs
- collect.rs
- command.rs
- flexbox.rs
- render.rs
- tests.rs
- tree.rs
- color.rs
- theme.rs
- theme_io.rs
- selection.rs
- collections.rs
- commanding.rs
- feedback.rs
- input.rs
- responses.rs
- selection.rs
- tests.rs
- validators.rs
- anim.rs
- buffer.rs
- cell.rs
- chart.rs
- context.rs
- event.rs
- halfblock.rs
- iterm.rs
- keymap.rs
- layout.rs
- lib.rs
- palette.rs
- rect.rs
- sixel.rs
- style.rs
- syntax.rs
- terminal.rs
- test_utils.rs
- widgets.rs
- snapshots__snapshot_bordered_col.snap
- snapshots__snapshot_button.snap
- snapshots__snapshot_calendar.snap
- snapshots__snapshot_calendar_range.snap
- snapshots__snapshot_list.snap
- snapshots__snapshot_progress.snap
- snapshots__snapshot_row_layout.snap
- snapshots__snapshot_separator.snap
- snapshots__snapshot_table.snap
- snapshots__snapshot_table_zebra.snap
- snapshots__snapshot_tabs.snap
- v020_lib_demos__v020_ctrl_c_passthrough.snap
- v020_lib_demos__v020_keymap_help.snap
- v020_lib_demos__v020_static_log.snap
- visual__demo.snap
- visual__demo_cjk.snap
- visual__demo_dashboard.snap
- visual__demo_infoviz.snap
- visual__demo_overlay_anchor.snap
- visual__v020_dx_shortcuts.snap
- mod.rs
- backend_contract.rs
- bidi_render.rs
- cached_region_proptest.rs
- color_picker_proptest.rs
- context_provider.rs
- form_validators_proptest.rs
- gallery_manifest.rs
- kernel_parity.rs
- kernel_proptest.rs
- key_chord_proptest.rs
- layout_proptest.rs
- nested_raw_draw.rs
- pty_ansi.rs
- render_check.rs
- run_static.rs
- snapshot_format_stability.rs
- snapshots.rs
- textarea_undo.rs
- tooltip.rs
- use_state_named.rs
- v020_dx_shortcuts.rs
- v020_dx_shortcuts_demo.rs
- v020_hooks_demos.rs
- v020_hooks_focus.rs
- v020_interaction_regression.rs
- v020_lib_demos.rs
- v020_lib_toplevel.rs
- v020_perf_alloc.rs
- v020_perf_demo.rs
- v020_regression_panel_demo.rs
- v020_test_utils_demo.rs
- v020_theme_modal.rs
- v020_theme_modal_demos.rs
- v020_widgets.rs
- v020_widgets_demos.rs
- v020_widthspec_demo.rs
- v021_inspector.rs
- v0_19_api_integration.rs
- visual_snapshots.rs
- widgets.rs
- widthspec_v020.rs
- with_if.rs
- .gitignore
- _typos.toml
- AGENTS.md
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- CONTRIBUTING.md
- demo.tape
- demo_dashboard.tape
- demo_fire.tape
- demo_game.tape
- demo_pretext.tape
- demo_spreadsheet.tape
- demo_website.tape
- deny.toml
- LICENSE
- README.md
- SECURITY.md
# Installation Guide
1. Get the code
git clone https://github.com/subinium/SuperLightTUI
Downloads the entire project code from GitHub to your computer.
cd SuperLightTUI
Moves into the project folder you just downloaded.
2. Rust
Medium RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo add superlighttui
Type this command into your terminal and run it.
<td align="center"><img src="assets/demo.png" alt="Widget Demo" /><br/><b>Widget Demo</b><br/><sub><code>cargo run --example demo</code></sub></td>
Builds and then immediately runs the program.
<td align="center"><img src="assets/demo_dashboard.png" alt="Dashboard" /><br/><b>Dashboard</b><br/><sub><code>cargo run --example showcase_tour</code></sub></td>
Builds and then immediately runs the program.
<td align="center"><img src="assets/demo_website.png" alt="Website" /><br/><b>Website Layout</b><br/><sub><code>cargo run --example showcase_tour</code></sub></td>
Builds and then immediately runs the program.
<td align="center"><img src="assets/demo_spreadsheet.png" alt="Spreadsheet" /><br/><b>Spreadsheet</b><br/><sub><code>cargo run --example showcase_tour</code></sub></td>
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)