35 lines
1.1 KiB
Plaintext
35 lines
1.1 KiB
Plaintext
[[using-shell-components-ui-pathsearch]]
|
|
= Path Search
|
|
|
|
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
|
|
|
|
The path search component asks base directory for scan and optional search expression.
|
|
Results are shown in a single select list where user can pick a path.
|
|
`PathSearchConfig` can be used to customise component behaviour.
|
|
|
|
[source, java, indent=0]
|
|
----
|
|
include::{snippets}/UiComponentSnippets.java[tag=snippet9]
|
|
----
|
|
|
|
NOTE: Logic for search is passed as is into algorithms documented
|
|
in xref:appendices-techical-intro-searchalgorithm.adoc[Search Algorithms].
|
|
|
|
The following image shows typical output from a path search component:
|
|
|
|
image::component-path-search-1.svg[text input]
|
|
|
|
The context object is `PathSearchContext`. The following table describes its context variables:
|
|
|
|
[[pathsearchcontext-template-variables]]
|
|
.PathSearchContext Template Variables
|
|
|===
|
|
|Key |Description
|
|
|
|
|`pathViewItems`
|
|
|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]).
|
|
|===
|