Skip to main content

Interactive Ui

Interactive UI components with Rich styling and keyboard navigation.

Classes​

InteractiveUI​

Rich-styled interactive UI components with keyboard navigation.

Methods​

confirm​
confirm(self, message: str, default: bool = True) -> bool

Styled confirmation prompts.

Parameters:

  • message (str, required) - Question to ask
  • default (bool, optional) - Default answer - Default: True

Returns: bool

create_themed​
create_themed(theme: str = 'specify_theme') -> 'InteractiveUI'

Create with custom theme for consistent branding.

Parameters:

  • theme (str, optional) - Theme name ('specify_theme' or 'default') - Default: specify_theme

Returns: InteractiveUI

get_capabilities​
get_capabilities() -> Dict[str, bool]

Get information about UI capabilities.

Returns: Dict

is_available​
is_available() -> bool

Check if interactive UI is available.

Returns: bool

multiselect​
multiselect(self, message: str, choices: Union[Dict[str, str], List[str]], default: Optional[List[str]] = None, min_selections: int = 0, max_selections: Optional[int] = None, header: Optional[str] = None) -> List[str]

Multi-selection interface with arrow keys.

Parameters:

  • message (str, required) - Question/prompt to display
  • choices (Union, required) - Dict \{key: description\} or List of strings
  • default (Optional, optional) - Default selected choices
  • min_selections (int, optional) - Minimum number of selections required - Default: 0
  • max_selections (Optional, optional) - Maximum number of selections allowed
  • header (Optional, optional) - Optional header text to display above choices

Returns: List

path​
path(self, message: str, default: Optional[str] = None, only_directories: bool = False, validate: Optional[Callable] = None) -> str

Path input with validation.

Parameters:

  • message (str, required) - Input prompt
  • default (Optional, optional) - Default path
  • only_directories (bool, optional) - Restrict to directories only - Default: False
  • validate (Optional, optional) - Additional validation function

Returns: str

select​
select(self, message: str, choices: Union[Dict[str, str], List[str]], default: Optional[str] = None, header: Optional[str] = None) -> str

Rich-styled selection with arrow key navigation.

Parameters:

  • message (str, required) - Question/prompt to display
  • choices (Union, required) - Dict \{key: description\} or List of strings
  • default (Optional, optional) - Default selection key
  • header (Optional, optional) - Optional header text to display above choices

Returns: str

text​
text(self, message: str, default: Optional[str] = None, validate: Optional[Callable] = None) -> str

Text input with Rich styling and validation.

Parameters:

  • message (str, required) - Input prompt
  • default (Optional, optional) - Default text value
  • validate (Optional, optional) - Validation function

Returns: str