projects/ng-keyboard-shortcuts/src/lib/ng-keyboard-shortcuts-help.component.ts
A Component to show all registered shortcut in the app it is shown as a modal
selector | ng-keyboard-shortcuts-help |
styleUrls | ./ng-keyboard-shortcuts-help.component.css |
templateUrl | ./ng-keyboard-shortcuts-help.component.html |
Properties |
|
Methods |
Inputs |
Accessors |
closeKey | |
Type : string
|
|
closeKeyDescription | |
Type : string
|
|
A description that will be shown in the help menu. MUST almost provide a label for the key to be shown in the help menu |
closeKeyLabel | |
Type : string
|
|
The label to group by the help menu close shortcut. must provide a description for the key to show in the help menu |
disableScrolling | |
Default value : true
|
|
Disable scrolling while modal is open |
emptyMessage | |
Default value : "No shortcuts available"
|
|
What message to show when no shortcuts are available on the page. |
key | |
Type : string
|
|
The shortcut to show/hide the help screen |
keyDescription | |
Type : string
|
|
A description that will be shown in the help menu. MUST almost provide a label for the key to be shown in the help menu |
keyLabel | |
Type : string
|
|
The label to group by the help menu toggle shortcut. must provide a description for the key to show in the help menu |
title | |
Default value : "Keyboard shortcuts"
|
|
The title of the help screen |
hide |
hide()
|
Hide the help screen manually.
Returns :
KeyboardShortcutsHelpComponent
|
reveal |
reveal()
|
Reveal the help screen manually.
Returns :
KeyboardShortcutsHelpComponent
|
toggle |
toggle()
|
Show/Hide the help screen manually.
Returns :
KeyboardShortcutsHelpComponent
|
visible |
visible()
|
Check if help screen is visible.
Returns :
boolean
boolean |
Public className |
Type : string
|
Default value : "help-modal"
|
key | ||||||
setkey(value: string)
|
||||||
The shortcut to show/hide the help screen
Parameters :
Returns :
void
|
closeKey | ||||||
setcloseKey(value: string)
|
||||||
Parameters :
Returns :
void
|
./ng-keyboard-shortcuts-help.component.css