API doc updates (#3928)

This commit is contained in:
Tig
2025-02-27 10:45:31 -07:00
committed by GitHub
parent 255114f0f2
commit b62e826576
8 changed files with 35 additions and 26 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 107 KiB

View File

@@ -11,7 +11,7 @@
* **[Extensible UI](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.View.html)** - All visible UI elements are subclasses of the `View` class, and these in turn can contain an arbitrary number of sub-views. Dozens of [Built-in Views](views.md) are provided. * **[Extensible UI](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.View.html)** - All visible UI elements are subclasses of the `View` class, and these in turn can contain an arbitrary number of sub-views. Dozens of [Built-in Views](views.md) are provided.
* **[Keyboard](keyboard.md) and [Mouse](mouse.md) Input** - The library handles all the details of input processing and provides a simple event-based API for applications to consume. * **[Keyboard](keyboard.md) and [Mouse](mouse.md) Input** - The library handles all the details of input processing and provides a simple event-based API for applications to consume.
* **[Powerful Layout Engine](layout.md)** - The layout engine makes it easy to lay out controls relative to each other and enables dynamic terminal UIs. * **[Powerful Layout Engine](layout.md)** - The layout engine makes it easy to lay out controls relative to each other and enables dynamic terminal UIs.
* **[Machine, User, and App-Level Configuration](config.md)** - Persistent configuration settings, including overriding default look & feel with Themes, keyboard bindings, and more via the [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) class. * **[Machine, User, and App-Level Configuration](config.md)** - Persistent configuration settings, including overriding default look & feel with Themes, keyboard bindings, and more via the [ConfigurationManager](~/api/Terminal.Gui.ConfigurationManager.yml) class.
* **[Clipboard support](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.Clipboard.html)** - Cut, Copy, and Paste is provided through the [`Clipboard`] class. * **[Clipboard support](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.Clipboard.html)** - Cut, Copy, and Paste is provided through the [`Clipboard`] class.
* **Multi-tasking** - The [Mainloop](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.MainLoop.html) supports processing events, idle handlers, and timers. Most classes are safe for threading. * **Multi-tasking** - The [Mainloop](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.MainLoop.html) supports processing events, idle handlers, and timers. Most classes are safe for threading.
* **[Reactive Extensions](https://github.com/dotnet/reactive)** - Use reactive extensions and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/gui-cs/Terminal.GuiV2Docs/tree/master/ReactiveExample) of a sample app. * **[Reactive Extensions](https://github.com/dotnet/reactive)** - Use reactive extensions and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/gui-cs/Terminal.GuiV2Docs/tree/master/ReactiveExample) of a sample app.
@@ -20,17 +20,22 @@ See [What's New in V2 For more](newinv2.md).
## Conceptual Documentation ## Conceptual Documentation
* [Guide to Migrating from Terminal.Gui v1](migratingfromv1.md)
* [List of Views](views.md)
* [Layout Engine](layout.md)
* [Navigation](navigation.md)
* [Keyboard API](keyboard.md)
* [Mouse API](mouse.md)
* [Arrangement API](arrangement.md) * [Arrangement API](arrangement.md)
* [Configuration and Theme Manager](config.md) * [Configuration and Theme Manager](config.md)
* [Multi-tasking and the Application Main Loop](mainloop.md) * [Cursor Deep Dive](cursor.md)
* [Cross-platform Driver Model](drivers.md) * [Cross-platform Driver Model](drivers.md)
* [Dim.Auto Deep Dive](dimauto.md) * [Dim.Auto Deep Dive](dimauto.md)
* [Drawing](drawing.md)
* [Events Deep Dive](events.md)
* [Keyboard API](keyboard.md)
* [Layout Engine](layout.md)
* [Migrating from Terminal.Gui v1](migratingfromv1.md)
* [Mouse API](mouse.md)
* [Multi-tasking and the Application Main Loop](mainloop.md)
* [Navigation](navigation.md)
* [View Deep Dive](View.md)
* [Views](views.md)
* [Scrolling Deep Dive](scrolling.md)
* [TableView Deep Dive](tableview.md) * [TableView Deep Dive](tableview.md)
* [TreeView Deep Dive](treeview.md) * [TreeView Deep Dive](treeview.md)

View File

@@ -6,32 +6,36 @@
href: newinv2.md href: newinv2.md
- name: v1 To v2 Migration - name: v1 To v2 Migration
href: migratingfromv1.md href: migratingfromv1.md
- name: View Deep Dive
href: View.md
- name: List of Views
href: views.md
- name: Layout Engine
href: layout.md
- name: Arrangement - name: Arrangement
href: arrangement.md href: arrangement.md
- name: Navigation
href: navigation.md
- name: Scrolling
href: scrolling.md
- name: Keyboard
href: keyboard.md
- name: Mouse
href: mouse.md
- name: Configuration - name: Configuration
href: config.md href: config.md
- name: Cursor
href: cursor.md
- name: Dim.Auto Deep Dive
href: dimauto.md
- name: Drawing - name: Drawing
href: drawing.md href: drawing.md
- name: Drivers - name: Drivers
href: drivers.md href: drivers.md
- name: Events Deep Dive
href: events.md
- name: Keyboard
href: keyboard.md
- name: Layout Engine
href: layout.md
- name: Mouse
href: mouse.md
- name: Multi-Tasking - name: Multi-Tasking
href: mainloop.md href: mainloop.md
- name: Dim.Auto Deep Dive - name: Navigation
href: dimauto.md href: navigation.md
- name: View Deep Dive
href: View.md
- name: View List
href: views.md
- name: Scrolling
href: scrolling.md
- name: TableView Deep Dive - name: TableView Deep Dive
href: tableview.md href: tableview.md
- name: TreeView Deep Dive - name: TreeView Deep Dive

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.3 MiB

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 288 KiB

After

Width:  |  Height:  |  Size: 185 KiB

View File

@@ -8,7 +8,7 @@ A toolkit for building rich console apps for .NET that run on Windows, the Mac,
## Terminal.Gui API Documentation ## Terminal.Gui API Documentation
* [Conceptual Documentation](docs/index.md) * [Conceptual Docs & Deep Dives](docs/index.md)
* [API Reference](~/api/Terminal.Gui.yml) * [API Reference](~/api/Terminal.Gui.yml)
## UI Catalog ## UI Catalog

View File

@@ -1,4 +1,4 @@
- name: Conceptual Docs - name: Conceptual Docs & Deep Dives
href: docs/ href: docs/
- name: API - name: API