Update modal docs

- Relates #825
2023-11-23 09:08:17 +00:00
parent b7ad099cc2
commit ead34d69e1
3 changed files with 46 additions and 1 deletions
--- a/spring-shell-docs/modules/ROOT/pages/tui/intro/terminalui.adoc
+++ b/spring-shell-docs/modules/ROOT/pages/tui/intro/terminalui.adoc
@@ -41,3 +41,16 @@ events and request _interrupt_.
 ----
 include::{snippets}/TerminalUiSnippets.java[tag=exitingfromloop]
 ----
+
+== Modal View
+
+`TerminalUI` supports having one active modal view. Modal view is placed
+on top of all other views and takes all input events.
+
+[source, java, indent=0]
+----
+include::{snippets}/TerminalUiSnippets.java[tag=uimodal]
+----
+
+NOTE: As views should not directly know anything about `TerminalUi` and
+interface `ViewService` exposes modal related functions.