Class HelpViewModel

ViewModel for managing the help menu and its display state.

The help menu only lists the shortcuts. Changing one is done in the settings dialog, through SettingsViewModel.

Hierarchy (View Summary)

AbstractViewModel<HelpMenuState>
- HelpViewModel

Index

Constructors

Properties

store disposables

Accessors

Methods

Constructors

constructor

new HelpViewModel(store: EnhancedStore, helpService: HelpService): HelpViewModel
Creates a new HelpViewModel instance.
Parameters
- store: EnhancedStore
  The Redux store for state management
- helpService: HelpService
  Service for managing help menu functionality
Returns HelpViewModel
Overrides AbstractViewModel.constructor
- Defined in state/viewModel/helpViewModel.ts:47

Properties

`Protected` `Readonly`store

store: EnhancedStore

`Protected` `Readonly`disposables

disposables: Disposable[]

Accessors

state

get state(): HelpMenuState
Gets the current state of the help menu.

Returns HelpMenuState
The current HelpMenuState
Overrides AbstractViewModel.state
- Defined in state/viewModel/helpViewModel.ts:73

Methods

toggle

toggle(): void
Toggles the visibility of the help menu.

Returns void
- Defined in state/viewModel/helpViewModel.ts:55

dispose

dispose(): void
Disposes the view model and resets help menu state.

Returns void
Overrides AbstractViewModel.dispose
- Defined in state/viewModel/helpViewModel.ts:64

src