Files
spring-shell/spring-shell-docs/modules/ROOT/pages/using-shell-components-ui-pathinput.adoc
2023-08-03 14:58:09 -05:00

29 lines
831 B
Plaintext

[[using-shell-components-ui-pathinput]]
= Path Input
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
The path input component asks a user for a `Path` and gives additional information about a path itself.
====
[source, java, indent=0]
----
include::{snippets}/UiComponentSnippets.java[tag=snippet4]
----
====
The following image shows typical output from a path input component:
image::component-path-input-1.svg[text input]
The context object is `PathInputContext`. The following table describes its context variables:
[[pathinputcontext-template-variables]]
.PathInputContext Template Variables
|===
|Key |Description
|`model`
|The parent context variables (see xref:using-shell-components-ui-render.adoc#textcomponentcontext-template-variables[TextComponentContext Template Variables]).
|===