pathsearch.adoc

Path Search

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.

link:../../../../../src/test/java/org/springframework/shell/docs/UiComponentSnippets.java[role=include]

Note	Logic for search is passed as is into algorithms documented in Search Algorithms.

The following screencast shows typical output from a path search component:

link:example$component-path-search-1.cast[role=include]

The context object is PathSearchContext. The following table describes its context variables:

Table 1. PathSearchContext Template Variables

Key	Description
pathViewItems	The items available for rendering search results.
model	The parent context variables (see TextComponentContext Template Variables).