branch: externals/posframe
commit 66b16a20a7b43f19c27487c475799200ad81b3bd
Author: Feng Shu <tuma...@163.com>
Commit: Feng Shu <tuma...@163.com>
Update doc about mouse banish.
* posframe.el (posframe-mouse-banish-function): Update docstring.
* README.org (Mouse banish): New heading.
---
README.org | 8 ++++++++
posframe.el | 6 +++++-
2 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index 11add6d..dadd713 100644
--- a/README.org
+++ b/README.org
@@ -95,3 +95,11 @@ between posframe and other packages.
posframe-arghandler feature has been removed from posframe-1.1,
user can use advice feature instead.
+
+** Mouse banish
+Default setting will work well in most case, but for EXWM user,
+suggest use the below config.
+
+#+begin_src emacs-lisp
+(setq posframe-mouse-banish-function #'posframe-mouse-banish-simple)
+#+end_src
diff --git a/posframe.el b/posframe.el
index 2b1750f..c29cff2 100644
--- a/posframe.el
+++ b/posframe.el
@@ -51,7 +51,11 @@
:type 'boolean)
(defcustom posframe-mouse-banish-function #'posframe-mouse-banish-default
- "The function used to banish mouse."
+ "The function used to banish mouse.
+
+Function `posframe-mouse-banish-default' will work well in most
+case, but suggest use function `posframe-mouse-banish-simple' or
+custom function for EXWM users."
:type 'function)
(defvar-local posframe--frame nil
