From aaa75240c7b6c84ba4d57895d8976628a3daddf6 Mon Sep 17 00:00:00 2001 From: Jen-Chieh Shen Date: Tue, 3 Dec 2024 01:13:35 +0800 Subject: [PATCH] docs(FAQ): Add rendering question --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a0c4759..4d33d45 100644 --- a/README.md +++ b/README.md @@ -130,13 +130,30 @@ then you can tell your user to... Here is a list of supported commands: -* `candidates` - list of strings to display; accept async function -* `action` - (optional) callback function after the mouse click -* `face` - (optional) face overrides the default sideline face -* `name` - (optional) backend name to display +- `candidates` - list of strings to display; accept async function +- `action` - (optional) callback function after the mouse click +- `face` - (optional) face overrides the default sideline face +- `name` - (optional) backend name to display ## ❓ FAQ +### 💫 Why is sideline not being render? + +`sideline` omit the information by default when the message is too long to +display on the screen. You can force display these long messages by doing: + +```elisp +(setq sideline-force-display-if-exceeds t) ; display it regardless the message length +``` + +or + +```elisp +(setq sideline-truncate t) ; force display but truncate it when too long +``` + +*📝 P.S. `sideline-truncate` is enabled by default after version `0.3.0`!* + ### 💫 How to force render the sideline on the next command? You can force update sideline by adding a hook or advice with the function