Files
spring-shell/spring-shell-docs/modules/ROOT/pages/components/ui/index.adoc
Janne Valkealahti 814ed4958f Migrate docs to antora
- This is basically copy from main branch minus all
  terminal ui things.
- Relates #971
2024-01-12 14:02:10 +00:00

31 lines
882 B
Plaintext

[[using-shell-components-ui]]
= Flow Components
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
Starting from version 2.1.x, a new component model provides an
easier way to create higher-level user interaction for the usual use cases,
such as asking for input in various forms. These usually are just plain text
input or choosing something from a list.
Templates for built-in components are in the
`org/springframework/shell/component` classpath.
Built-in components generally follow this logic:
. Enter a run loop for user input.
. Generate component-related context.
. Render the runtime status of a component state.
. Exit.
. Render the final status of a component state.
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.