Fixes #4963, #5064. FileDialog nav fixes & TableView redesign#5062
Merged
Fixes #4963, #5064. FileDialog nav fixes & TableView redesign#5062
Conversation
Fixes text input controls to ignore Alt/Ctrl-modified keys, even with AssociatedText (Kitty protocol). Updates FileDialog TableView height. Adds regression tests for input handling and hotkey routing. Documents FileDialog keyboard/nav issues. Refactors KeyboardEventTests for clarity.
Improve FileDialog navigation and TableView key handling - Reset TableView viewport X and Y to 0 on navigation for consistent top-left alignment in FileDialog. - Enable TabStop on _tableViewContainer for better keyboard accessibility. - Adjust _tableView height and anchor _tbFind Y position for improved layout robustness. - Refactor TableView key handling: ignore control/modified keys, handle navigation only when focused and rows exist, and return true when a key is handled.
9 tasks
Replaces OnActivated with OnActivating, updating the method to return a bool based on ToggleCurrentCellSelection. This supports cancellable or conditional activation in line with new event handling conventions.
This was referenced Apr 23, 2026
Refactor TableView to v2 command/event architecture - Implements IValue<Point?> and standard ValueChanged events - Replaces OnMouseEvent with MouseBindings for all mouse actions - Aligns Command.Accept/Activate/Toggle semantics to v2 standards - Adds DefaultKeyBindings (Emacs, Home/End, Space, etc.) - Uses C# 14 semi-auto properties for selection, default -1 - Moves collection-navigator logic to OnKeyDownNotHandled - Threads ICommandContext through selection/navigation methods - Marks legacy events/types as [Obsolete] with shims for compat - Updates FileDialog and DatePicker to new TableView API - Adds/updates tests and documents changes in tableview-refactor-summary.md - Cleans up code style and removes dead code throughout
Comprehensive tests for TableView navigation, selection, events, and edge cases. Ensures current behavior is preserved ahead of planned redesign.
Refactored TableView to use TableSelection/TableSelectionRegion for richer selection state, replacing Point-based selection. Renamed EnsureSelectedCellIsVisible to EnsureCursorIsVisible and updated all references. Changed Command.Toggle to Command.ToggleExtend for extended selection. Improved null handling for Table and selection state, preventing NullReferenceExceptions. Updated tests and documentation to match the new model. Made minor code style and naming improvements.
Replaced all usages of SelectedRow/SelectedColumn with the new Value property and its Cursor.X/Y members for improved selection state management and null-safety. Updated event handlers to use ValueChanged instead of SelectedCellChanged, and replaced direct selection assignments with SetSelection calls. Modernized UI control initialization, streamlined menu/status bar construction, and improved code style and null handling throughout. Marked SelectedCellChanged as obsolete and updated tests and scenarios to use the new selection APIs.
No code modifications were present in the provided diff. No commit necessary.
Renamed the TableView event and event args from SelectedCellChanged/SelectedCellChangedEventArgs to CursorChanged/CursorChangedEventArgs. Updated all references, event invocations, and tests accordingly. Improved comments to clarify the event tracks cursor position changes, not cell selection.
Major overhaul of TableView selection and event model: - Remove obsolete events (CellActivated, CellToggled, CursorChanged) and related args. - All selection state now managed via Value (TableSelection). - Internal selection fields are private; use SetSelection/Value APIs. - Update all code/tests to use Value.Cursor and ValueChanged. - Accept/Accepted replaces CellActivated; ToggleExtend handled directly. - Deep-copy multi-selection regions for immutability. - Refactor navigation, selection, and rendering to new model. - Update all scenarios and tests for new APIs. - Modernize code style and remove redundant code.
Improved and expanded XML documentation and in-code comments for TableView and related sources, fixing typos and grammar for accuracy and consistency. Major updates to tableview.md add a detailed table of contents, expanded sections, code examples, and event usage. Minor code fixes and improved parameter tags enhance maintainability and developer experience.
Refactored TableView.Selection.cs to move IValue<TableSelection?> implementation to the end of the file and organize related properties. Changed TableSelectionRegion to use init-only properties for immutability. Updated selection region logic to use immutable instances, improved region clamping, and fixed minor logic issues. Enhanced code style and maintainability without altering selection behavior.
Refactor TableView internals and API to use "cursor" instead of "selected"/"selection" for navigation state. Update all related fields, methods, comments, and tests for clarity and consistency. No functional changes; improves code readability and aligns with TableSelection.Cursor semantics.
Reorganize TableView by moving content-related properties and methods (content size, scrolling, viewport management) into TableView.Content.cs. This structural refactor improves code organization, separation of concerns, and maintainability. No functional changes introduced.
tig
changed the title
Comprehensive TableView API overhaul for v2.0.0: unified selection types, IValue<TableSelection?> support, navigation API terminology shift from "Selection" to "Cursor", and legacy API deprecation. Fixes keyboard selection toggling and region calculation bugs. Extracts content/viewport logic to a partial class and updates XML/docs. Ctrl+Click toggle regression noted for follow-up.
…minal.Gui into Issue-4963-filedialog
Collaborator
Author
|
I'm currently working on two last issues:
|
tig
requested review from
YourRobotOverlord and
Copilot
and removed request for
Copilot
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Terminal.Gui’s FileDialog and TableView to align with the v2 command/value patterns, fixing reported navigation issues and introducing a breaking TableView selection/cursor API redesign with updated docs and extensive regression/baseline tests.
Changes:
- FileDialog: keyboard/navigation fixes, cancel/result handling updates, and (gated) tree-view work.
- TableView: redesign around
IValue<TableSelection?>, cursor-based navigation APIs, selection region types, and refactoring into partial files. - Input pipeline + docs/tests: Kitty/ANSI key parsing adjustments, TableView deep-dive rewrite, and new/updated regression tests.
Reviewed changes
Copilot reviewed 65 out of 65 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| docfx/docs/tableview.md | Rewritten TableView deep-dive documenting new selection/cursor/value model and usage. |
| Tests/UnitTestsParallelizable/Views/TextViewTests.cs | Adds regression tests for Alt/Ctrl + AssociatedText not inserting text. |
| Tests/UnitTestsParallelizable/Views/TextValidateFieldTests.cs | Adds regression tests for Alt/Ctrl + AssociatedText not inserting text. |
| Tests/UnitTestsParallelizable/Views/TextFieldTests.cs | Adds regression tests for Alt/Ctrl + AssociatedText not inserting text. |
| Tests/UnitTestsParallelizable/Views/TableViewTests.cs | Updates tests to new cursor/Value API and adds ToggleExtend/Accepted coverage. |
| Tests/UnitTestsParallelizable/Views/TableViewLegacyTests.cs | Updates legacy-facing tests to new selection types and ValueChanged event. |
| Tests/UnitTestsParallelizable/Views/TableViewBaselineTests.cs | New baseline suite to lock in TableView behavior during redesign. |
| Tests/UnitTestsParallelizable/Views/LabelTests.cs | Adjusts hotkey test expectations/flow. |
| Tests/UnitTestsParallelizable/Views/HexViewTests.cs | Adds regression tests preventing ctrl/alt-modified edits. |
| Tests/UnitTestsParallelizable/Views/ButtonTests.cs | Updates test comment to match HotKey behavior. |
| Tests/UnitTestsParallelizable/ViewBase/ViewCommandTests.cs | Adds baseline test that HotKey command returns true. |
| Tests/UnitTestsParallelizable/ViewBase/Keyboard/KeyboardEventTests.cs | Adds routing regression test and refactors some setup/formatting. |
| Tests/IntegrationTests/FluentTests/FileDialogTests.cs | Gates tree-related integration tests behind compile symbol. |
| Terminal.sln.DotSettings | Adds a word to ReSharper user dictionary. |
| Terminal.Gui/Views/TreeView/TreeView.Navigation.cs | Adds (gated) prototype ExpandParents implementation. |
| Terminal.Gui/Views/TextInput/TextView/TextView.Keyboard.cs | Prevents Alt/Ctrl modified keys from being inserted as text. |
| Terminal.Gui/Views/TextInput/TextValidateField.cs | Prevents Alt/Ctrl modified keys from being inserted as text. |
| Terminal.Gui/Views/TextInput/TextField/TextField.Keyboard.cs | Prevents Alt/Ctrl modified keys from being inserted as text. |
| Terminal.Gui/Views/TableView/TreeTableSource.cs | Updates TreeTableSource to use cursor (Value.Cursor) instead of SelectedRow/SelectedColumn. |
| Terminal.Gui/Views/TableView/TableView.Navigation.cs | Refactors navigation methods to cursor terminology and return values. |
| Terminal.Gui/Views/TableView/TableView.Mouse.cs | Removes legacy OnMouseEvent implementation (migrated to bindings/commands). |
| Terminal.Gui/Views/TableView/TableView.Drawing.cs | Refactors/extends rendering helpers (headers, width calc, truncation/padding). |
| Terminal.Gui/Views/TableView/TableView.Content.cs | Extracts viewport/content/offset logic into new partial file. |
| Terminal.Gui/Views/TableView/TableView.CellMapping.cs | Minor doc cleanup. |
| Terminal.Gui/Views/TableView/TableStyle.cs | Doc fixes/clarifications. |
| Terminal.Gui/Views/TableView/TableSelectionRegion.cs | New immutable-ish selection region type with equality/hash. |
| Terminal.Gui/Views/TableView/TableSelection.cs | New TableSelection snapshot type (cursor + regions) with equality/hash. |
| Terminal.Gui/Views/TableView/SelectedCellChangedEventArgs.cs | Removes legacy SelectedCellChanged args type. |
| Terminal.Gui/Views/TableView/ListTableSource.cs | Fixes cached min-width tracking and improves docs. |
| Terminal.Gui/Views/TableView/CheckBoxTableSourceWrapper.cs | Updates checkbox wrapper to use ToggleExtend + key interception. |
| Terminal.Gui/Views/TableView/CellToggledEventArgs.cs | Removes legacy CellToggled args type. |
| Terminal.Gui/Views/TableView/CellActivatedEventArgs.cs | Removes legacy CellActivated args type. |
| Terminal.Gui/Views/HexView.cs | Prevents Ctrl-modified keys from editing hex data. |
| Terminal.Gui/Views/FileDialogs/SaveDialog.cs | Updates cancel detection + nullability and constructor style. |
| Terminal.Gui/Views/FileDialogs/OpenDialog.cs | Updates cancel detection for FilePaths. |
| Terminal.Gui/Views/FileDialogs/FileDialogStyle.cs | Makes style members nullable when tree is disabled; gates tree properties. |
| Terminal.Gui/Views/FileDialogs/FileDialogCollectionNavigator.cs | Updates to cursor-based column selection and null-safe conversion. |
| Terminal.Gui/Views/FileDialogs/FileDialog.cs | Refactors dialog layout, adds CancelButton, updates TableView wiring/events. |
| Terminal.Gui/Views/FileDialogs/FileDialog.TableView.cs | Updates handlers to Accepted/ValueChanged and cursor-based row access. |
| Terminal.Gui/Views/FileDialogs/FileDialog.Navigation.cs | Updates restore selection and scroll resets; gates tree visibility logic. |
| Terminal.Gui/Views/FileDialogs/FileDialog.Commands.cs | Updates selection guards to Value-based model. |
| Terminal.Gui/Views/DialogTResult.cs | Simplifies viewport change content-size calculation. |
| Terminal.Gui/Views/Dialog.cs | Adjusts Result setter bounds check and result-setting behavior. |
| Terminal.Gui/Views/DatePicker.cs | Migrates calendar interactions to Activated/Accepted + cursor-based access. |
| Terminal.Gui/Views/CollectionNavigation/TableCollectionNavigator.cs | Updates to cursor-based column selection and adds stricter null handling. |
| Terminal.Gui/ViewBase/View.Command.cs | Adds inline questions/comments about HotKey handling return value. |
| Terminal.Gui/Input/Command.cs | Updates ToggleExtend docstring. |
| Terminal.Gui/FileServices/FileSystemTreeBuilder.cs | Adds reparse-point guards to avoid traversal cycles; makes IncludeFiles settable. |
| Terminal.Gui/Drivers/AnsiHandling/Ss3Pattern.cs | Minor Regex instantiation/style refactor. |
| Terminal.Gui/Drivers/AnsiHandling/KittyKeyboardPattern.cs | Refactors parsing locals and ensures Key instances aren’t shared. |
| Terminal.Gui/Drivers/AnsiHandling/EscAsAltPattern.cs | Minor constructor style refactor. |
| Terminal.Gui/Drivers/AnsiHandling/CsiKeyPattern.cs | Ensures new Key instances returned + asserts around Handled sharing. |
| Terminal.Gui/Drivers/AnsiHandling/CsiCursorPattern.cs | Ensures new Key instances returned + asserts around Handled sharing. |
| Terminal.Gui/Drivers/AnsiHandling/AnsiKeyboardParserPattern.cs | Changes GetKey to clone returned Key (but currently lacks null guard). |
| Examples/UICatalog/UICatalogRunnable.cs | Updates scenario list selection APIs to cursor/value model. |
| Examples/UICatalog/Scenarios/TableViewTest.cs | Updates scenario to cursor/value APIs and formatting cleanup. |
| Examples/UICatalog/Scenarios/TableEditor.cs | Updates to Accepted/ValueChanged and cursor/value APIs. |
| Examples/UICatalog/Scenarios/MultiColouredTable.cs | Updates to Accepted and cursor/value APIs; refactors edit flow. |
| Examples/UICatalog/Scenarios/MinimalSpinnerDemo.cs | Improves demo UI + hotkeys and toggles for spinner properties. |
| Examples/UICatalog/Scenarios/ListColumns.cs | Updates to ValueChanged cursor reporting and formatting cleanup. |
| Examples/UICatalog/Scenarios/FileDialogExamples.cs | Updates TableStyle nullability usage; adds default Path; gates tree code (symbol mismatch noted). |
| Examples/UICatalog/Scenarios/CsvEditor.cs | Updates to Accepted/ValueChanged and cursor/value APIs; refactors prompts/guards. |
| Examples/UICatalog/Scenarios/CharacterMap/CharacterMap.cs | Updates selection handling to cursor/value APIs and improves null guards. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Collaborator
TreeView operates on delegates for sub-branch discovery. This is very important for performancd as it allows us to only enumerate exposed nodes' children. So to reveal a file it would be best to use the DirectoryInfo root of a FileInfo and say:
I.e. use the domain knowledge of file system rather than try to implement a generic node discovery system - which goes against design philosophy. |
…i into Issue-4963-filedialog
…gracefully Agent-Logs-Url: https://github.com/gui-cs/Terminal.Gui/sessions/143b4cb6-65b9-44b2-8ecb-0bdcf483674c Co-authored-by: tig <585482+tig@users.noreply.github.com>
…ailing blank line Agent-Logs-Url: https://github.com/gui-cs/Terminal.Gui/sessions/143b4cb6-65b9-44b2-8ecb-0bdcf483674c Co-authored-by: tig <585482+tig@users.noreply.github.com>
…s are hidden Agent-Logs-Url: https://github.com/gui-cs/Terminal.Gui/sessions/e345d3a4-4aba-415d-9c0a-9036eae84c1f Co-authored-by: tig <585482+tig@users.noreply.github.com>
… for robustness Agent-Logs-Url: https://github.com/gui-cs/Terminal.Gui/sessions/e345d3a4-4aba-415d-9c0a-9036eae84c1f Co-authored-by: tig <585482+tig@users.noreply.github.com>
FileDialog TreeView feature is now disabled via `#if !FILEDIALOG_ENABLE_TREE`, hiding all related UI and logic. TreeView initialization and toggle button are only present when the feature is off. `FileDialogStyle` now supports a nullable file system and defaults `DefaultUseColors` to true. FileDialog-related config settings are removed. `TableView.TruncateOrPad` now truncates by grapheme cluster, preventing surrogate pair corruption. Adds a test to ensure truncation does not throw or produce invalid surrogates with emoji.
…i into Issue-4963-filedialog
Removes FILEDIALOG_ENABLE_TREE conditional blocks, making the directory tree, toggle button, and related styles always active in FileDialog. Updates FileDialogStyle and tests to support the unified implementation. FileDialogExamples now sets PreserveFilenameOnDirectoryChanges via checkbox. Tree functionality is now a standard, always-on part of the dialog UI.
- Add ".lnk" color mapping to FileSystemColorProvider - Refine FileDialog pane border and alignment - Reorder _treeView initialization for clarity - Simplify TableView style for a cleaner appearance - Use theme-based colors in TableView for consistency - Ensure column color getter and style order are correct - Set AllowsMultipleSelection to false in FileDialog - Refactor ColumnStyle.Visible to use auto-property and MaxWidth logic
Collaborator
|
File dialog in designer is now putting CPU to 100% just clicking around in TableView. This happens in all 3 of these versions: 2.0.0-rc.5 |
This was referenced Apr 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
FileDialogkeyboard nav is broken #4963 (FileDialog keyboard nav issues)TableViewneeds re-factoring before v2.0.0 can be released - BREAKING CHANGES #5064 (TableView API redesign)Dialognav is broken - Once nav cycles through once, Tab/Shift-Tab skip Cancel etc... #5066FileDialog Fixes
TableView Redesign (Breaking Changes)
Type consolidation & IValue support:
Terminology — \Selection\ → \Cursor\ for navigation APIs:
Return type cleanup:
Partial class extraction:
Bug fixes:
XML docs & documentation:
Known Issue
Remaining (future PR)