mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
01c94ce5b2
Refactored `DropDownListExample` for modularity and lifecycle management. Introduced `PopoverWrapper<TView>` to enable any `View` to function as a popover, along with `ViewPopoverExtensions` for a fluent API. Added `PopoverWrapperExample` project to demonstrate usage with examples like `ListView`, forms, and `ColorPicker`. Enhanced `Shortcut` class with a configurable `MarginThickness` property. Updated `PopoverBaseImpl` to redraw UI on visibility changes. Added comprehensive unit tests for `PopoverWrapper` and extensions. Updated `Terminal.sln` to include the new project. Added detailed documentation in `README.md`. Improved code maintainability, modularity, and user experience.
109 lines
2.8 KiB
Markdown
109 lines
2.8 KiB
Markdown
# PopoverWrapper Example
|
|
|
|
This example demonstrates how to use `PopoverWrapper<TView>` to make any View into a popover without implementing the `IPopover` interface.
|
|
|
|
## Overview
|
|
|
|
`PopoverWrapper<TView>` is similar to `RunnableWrapper<TView, TResult>` but for popovers instead of runnables. It wraps any View and automatically handles:
|
|
|
|
- Setting proper viewport settings (transparent, transparent mouse)
|
|
- Configuring focus behavior
|
|
- Handling the quit command to hide the popover
|
|
- Sizing to fill the screen by default
|
|
|
|
## Key Features
|
|
|
|
- **Fluent API**: Use `.AsPopover()` extension method for a clean, fluent syntax
|
|
- **Any View**: Wrap any existing View - Button, ListView, custom Views, forms, etc.
|
|
- **Automatic Management**: The wrapper handles all the popover boilerplate
|
|
- **Type-Safe**: Generic type parameter ensures type safety when accessing the wrapped view
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```csharp
|
|
// Create any view
|
|
var myView = new View
|
|
{
|
|
X = Pos.Center (),
|
|
Y = Pos.Center (),
|
|
Width = 40,
|
|
Height = 10,
|
|
BorderStyle = LineStyle.Single
|
|
};
|
|
|
|
// Wrap it as a popover
|
|
PopoverWrapper<View> popover = myView.AsPopover ();
|
|
|
|
// Register and show
|
|
app.Popover.Register (popover);
|
|
app.Popover.Show (popover);
|
|
```
|
|
|
|
### With ListView
|
|
|
|
```csharp
|
|
var listView = new ListView
|
|
{
|
|
Title = "Select an Item",
|
|
X = Pos.Center (),
|
|
Y = Pos.Center (),
|
|
Width = 30,
|
|
Height = 10,
|
|
Source = new ListWrapper<string> (["Apple", "Banana", "Cherry"])
|
|
};
|
|
|
|
PopoverWrapper<ListView> popover = listView.AsPopover ();
|
|
app.Popover.Register (popover);
|
|
app.Popover.Show (popover);
|
|
```
|
|
|
|
### With Custom Forms
|
|
|
|
```csharp
|
|
View CreateFormView ()
|
|
{
|
|
var form = new View
|
|
{
|
|
Title = "User Form",
|
|
X = Pos.Center (),
|
|
Y = Pos.Center (),
|
|
Width = 60,
|
|
Height = 16
|
|
};
|
|
|
|
// Add form fields...
|
|
|
|
return form;
|
|
}
|
|
|
|
View formView = CreateFormView ();
|
|
PopoverWrapper<View> popover = formView.AsPopover ();
|
|
app.Popover.Register (popover);
|
|
app.Popover.Show (popover);
|
|
```
|
|
|
|
## Comparison with RunnableWrapper
|
|
|
|
| Feature | RunnableWrapper | PopoverWrapper |
|
|
|---------|----------------|----------------|
|
|
| Purpose | Make any View runnable as a modal session | Make any View into a popover |
|
|
| Blocking | Yes, blocks until stopped | No, non-blocking overlay |
|
|
| Result Extraction | Yes, via typed Result property | N/A (access WrappedView directly) |
|
|
| Dismissal | Via RequestStop() or Quit command | Via Quit command or clicking outside |
|
|
| Focus | Takes exclusive focus | Shares focus with underlying content |
|
|
|
|
## Running the Example
|
|
|
|
```bash
|
|
dotnet run --project Examples/PopoverWrapperExample
|
|
```
|
|
|
|
## See Also
|
|
|
|
- [Popovers Deep Dive](../../docfx/docs/Popovers.md)
|
|
- [RunnableWrapper Example](../RunnableWrapperExample/)
|
|
- `Terminal.Gui.App.PopoverBaseImpl`
|
|
- `Terminal.Gui.App.IPopover`
|