Skip to content

Commit

Permalink
docs(FAQ): Add rendering question
Browse files Browse the repository at this point in the history
  • Loading branch information
jcs090218 committed Dec 2, 2024
1 parent d48e504 commit aaa7524
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit aaa7524

Please sign in to comment.