summaryrefslogtreecommitdiffstats
path: root/docs/Config.md
diff options
context:
space:
mode:
authorJesse Duffield <jessedduffield@gmail.com>2020-07-18 19:41:13 +1000
committerJesse Duffield <jessedduffield@gmail.com>2020-07-18 20:00:48 +1000
commit845c80721f8f0445b0abe39ee381a6feecf158a2 (patch)
treea2cfbd2c2710db01c95e3354923f831959da42d2 /docs/Config.md
parent0e65db10d85304c2ab8418e5219c267277a9c886 (diff)
Decouple escaping from quittingv0.20.10
When a user is not entering text into a prompt, the 'q' key should immediately quit the application. On the other hand, the 'esc' key should cancel/close/go-back to the previous context. If we're at the surface level (nothing to cancel/close) and the user hits the escape key, the default behaviour is to close the app, however we now have a `quitOnTopLevelReturn` config key to override this. I actually think from the beginning we should have made this config option default to false rather than true which is the default this PR gives it, but I don't want to anger too many people familiar with the existing behaviour.
Diffstat (limited to 'docs/Config.md')
-rw-r--r--docs/Config.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/Config.md b/docs/Config.md
index cf6558746..c2c320f7c 100644
--- a/docs/Config.md
+++ b/docs/Config.md
@@ -50,6 +50,8 @@ Default path for the config file:
days: 14 # how often an update is checked for
reporting: 'undetermined' # one of: 'on' | 'off' | 'undetermined'
confirmOnQuit: false
+ # determines whether hitting 'esc' will quit the application when there is nothing to cancel/close
+ quitOnTopLevelReturn: true
keybinding:
universal:
quit: 'q'