Update docs

This commit is contained in:
Janne Valkealahti
2023-10-06 17:07:16 +01:00
parent 2819c1d367
commit 6f7eac435a
11 changed files with 18 additions and 18 deletions

View File

@@ -42,16 +42,16 @@
** xref:options/naming.adoc[]
* xref:using-shell-completion.adoc[]
* xref:using-shell-building.adoc[]
* xref:using-shell-components.adoc[]
** xref:using-shell-components-flow.adoc[]
** xref:using-shell-components-ui.adoc[]
*** xref:using-shell-components-ui-render.adoc[]
*** xref:using-shell-components-ui-stringinput.adoc[]
*** xref:using-shell-components-ui-pathinput.adoc[]
*** xref:using-shell-components-ui-pathsearch.adoc[]
*** xref:using-shell-components-ui-confirmation.adoc[]
*** xref:using-shell-components-ui-singleselect.adoc[]
*** xref:using-shell-components-ui-multiselect.adoc[]
* xref:components/index.adoc[]
** xref:components/flow/index.adoc[]
** xref:components/ui/index.adoc[]
*** xref:components/ui/render.adoc[]
*** xref:components/ui/stringinput.adoc[]
*** xref:components/ui/pathinput.adoc[]
*** xref:components/ui/pathsearch.adoc[]
*** xref:components/ui/confirmation.adoc[]
*** xref:components/ui/singleselect.adoc[]
*** xref:components/ui/multiselect.adoc[]
* xref:tui/index.adoc[]
** xref:tui/intro/index.adoc[]
** xref:tui/views/index.adoc[]

View File

@@ -3,7 +3,7 @@
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
When you use xref:using-shell-components-ui.adoc[Flow Components] to build something that involves
When you use xref:components/ui/index.adoc[Flow Components] to build something that involves
use of a multiple components, your implementation may become a bit cluttered.
To ease these use cases, we added a
`ComponentFlow` that can hook multiple component executions together

View File

@@ -26,5 +26,5 @@ The context object is `ConfirmationInputContext`. The following table describes
|The default value -- either `true` or `false`.
|`model`
|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
|The parent context variables (see xref:components/ui/render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
|===

View File

@@ -19,7 +19,7 @@ Built-in components generally follow this logic:
. Exit.
. Render the final status of a component state.
NOTE: xref:using-shell-components-flow.adoc[Flow] gives better interface for defining the flow of
NOTE: xref:components/flow/index.adoc[Flow] gives better interface for defining the flow of
components that are better suited for defining interactive command flows.

View File

@@ -29,5 +29,5 @@ The context object is `MultiItemSelectorContext`. The following table describes
|The visible items, where rows contain maps of name, selected, on-row, and enabled items.
|`model`
|The parent context variables (see xref:using-shell-components-ui-render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]).
|The parent context variables (see xref:components/ui/render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]).
|===

View File

@@ -22,5 +22,5 @@ The context object is `PathInputContext`. The following table describes its cont
|Key |Description
|`model`
|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
|The parent context variables (see xref:components/ui/render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
|===

View File

@@ -30,5 +30,5 @@ The context object is `PathSearchContext`. The following table describes its con
|The items available for rendering search results.
|`model`
|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
|The parent context variables (see xref:/components/ui/render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
|===

View File

@@ -29,7 +29,7 @@ The context object is `SingleItemSelectorContext`. The following table describes
|The visible items, where rows contains maps of name and selected items.
|`model`
|The parent context variables (see xref:using-shell-components-ui-render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]).
|The parent context variables (see xref:/components/ui/render.adoc#selectorcomponentcontext-template-variables[SelectorComponentContext Template Variables]).
|===
You can pre-select an item by defining it to get exposed. This is

View File

@@ -38,5 +38,5 @@ The context object is `StringInputContext`. The following table lists its contex
|`true` if a mask character is set. Otherwise, false.
|`model`
|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
|The parent context variables (see xref:/components/ui/render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
|===