mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
e7a4df492d
* Initial plan
* Rename Command.Select to Command.Activate and Selecting to Activating
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Add Activating event propagation to SuperView
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Update all comments and docs referencing Select to Activate
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Fix event log messages in examples to use Activating/Activate
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Revert automatic Activating event propagation that broke tests
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Update docfx documentation to use Activate/Activating terminology
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* renames
* Revert "Add Activating event propagation to SuperView"
This reverts commit 6d82bee9ad.
* added command diagrams
* mermaid
* updated level 3
* again
* Select->Activate in MouseTests.cs
* Update Terminal.Gui/Views/Selectors/FlagSelector.cs
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Refactor: Rename Selecting to Activating in View APIs
Renamed the `Selecting` event and `OnSelecting` method to
`Activating` and `OnActivating` to better reflect their purpose.
Updated all related comments, test method names, variables,
and assertions in `View` and `ViewCommandTests` to align with
the new terminology.
Improved code clarity by using `_` for unused parameters in
lambda expressions. Renamed properties like `HandleSelecting`
to `HandleActivating` and adjusted naming conventions for
consistency (e.g., `OnactivatingCount` to `OnActivatingCount`).
These changes enhance readability, maintainability, and
terminology consistency across the codebase.
* Update Terminal.Gui/Views/Selectors/OptionSelector.cs
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Typos
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: tig <585482+tig@users.noreply.github.com>
Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
3.1 KiB
3.1 KiB
Terminal.Gui Documentation
Important
Terminal.Gui v2 "Alpha" has been released.
Welcome to the Terminal.Gui documentation! This comprehensive guide covers everything you need to know about building modern terminal user interfaces with Terminal.Gui.
Note
This is the v2 API documentation. For v1 go here: https://gui-cs.github.io/Terminal.GuiV1Docs/
Getting Started
- Getting Started - Quick start guide to create your first Terminal.Gui application
- Migrating from v1 to v2 - Complete guide for upgrading existing applications
- What's New in v2 - Overview of new features and improvements
- Showcase - Showcase of TUI apps built with Terminal.Gui
Deep Dives
- ANSI Response Parser - Terminal sequence parsing and state management
- Application - Application lifecycle, initialization, and main loop
- Arrangement - View arrangement and positioning strategies
- Cancellable Work Pattern - Core design pattern for extensible workflows
- Character Map Scenario - Complex drawing, scrolling, and Unicode rendering example
- Command System - Command execution, key bindings, and the Activating/Accepting concepts
- Configuration Management - Persistent settings, themes, and configuration scopes
- Cross-Platform Driver Model - Platform abstraction and console driver architecture
- Cursor System - Modern cursor management and positioning (proposed design)
- Dim.Auto - Automatic view sizing based on content
- Drawing - Drawing primitives, rendering, and graphics operations
- Events - Event patterns and handling throughout the framework
- Keyboard Input - Key handling, bindings, commands, and shortcuts
- Layout System - View positioning, sizing, and arrangement
- Lexicon & Taxonomy - Terminology and concepts used throughout Terminal.Gui
- Logging & Metrics - Comprehensive logging and performance monitoring
- Multitasking - Application lifecycle and event dispatching
- Mouse Input - Mouse event handling and interaction patterns
- Navigation - Focus management, keyboard navigation, and accessibility
- Popovers - Drawing outside viewport boundaries for menus and popups
- Scheme - Color schemes, styling, and visual theming
- Scrolling - Built-in scrolling, virtual content areas, and scroll bars
- TableView - Table view component, data binding, and column management
- TreeView - Tree view component, hierarchical data, and node management
- View - Base view class, view hierarchy, and core view functionality
API Reference
For detailed API documentation, see the API Reference.