Add completions for Obsidian Callouts

tth05 / obsidian-completr

Auto-completion plugin for the obsidian editor.

MIT License

291 stars 18 forks source link

Add completions for Obsidian Callouts #44

Closed eth-p closed 1 year ago

eth-p commented 1 year ago

Adds completion/suggestion support for Obsidian callouts.

Only triggers when changing the type of a callout.

> [!TYPE] Title
  ~~~~~ <-- only triggers for these characters

Will show (and correctly autocomplete) when a callout is likely to be created.
```
> [_
  ~ <-- will trigger here
```

Moves cursor in the ideal place to type the title.

> [!TY_] _
     |  ~ <-- cursor will move here
     ~ <-- complete from here

Correctly handles nested callouts.

Reviewer Note

Each commit is a distinct change, and is easier to review one-by-one instead of as a whole.

tth05 commented 1 year ago

On a side note: I was also planning on adding icons, but representing the provider that contributed the given suggestion instead. This would of course conflict with your icons. Do you have an idea how this could be handled? Two icons would look weird, even if one was in the front and one was in the back. What I'm thinking of right now is maybe the provider icon taking the whole space if the suggestion doesn't have an icon, otherwise it'd be displayed in the corner (C for Callout):

eth-p commented 1 year ago

Regarding the side note:

I prefer only seeing the provider when there isn't an icon, as a way to help keep the suggestions all nicely aligned in a grid. But, I also see the value in knowing where the suggestions came from. In terms of usability and aesthetics, I think your idea of overlying the provider on top of the icon in the corner is the best approach, though. At the same time, I'm a fan of configurability and "having it your way", so maybe it could be an option in the settings?

For example:

(if the suggestion has an icon, show both. otherwise, show provider icon)
(if the suggestion has an icon, show that. otherwise, show provider icon)
(always show the provider icon, even if the suggestion has an icon)
(no icons at all. for those who prefer a minimalist look)

tth05 commented 1 year ago

Regarding the side note:

I prefer only seeing the provider when there isn't an icon, as a way to help keep the suggestions all nicely aligned in a grid. But, I also see the value in knowing where the suggestions came from. In terms of usability and aesthetics, I think your idea of overlying the provider on top of the icon in the corner is the best approach, though. At the same time, I'm a fan of configurability and "having it your way", so maybe it could be an option in the settings?

Multiple options seem like the best way. I extracted your images into a new issue.