Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing indicators #572

Open
mrexodia opened this issue Jan 21, 2025 · 2 comments
Open

Confusing indicators #572

mrexodia opened this issue Jan 21, 2025 · 2 comments

Comments

@mrexodia
Copy link

I always get confused about the emoji indicators that the plugin has in the status bar. For example:

Image

When writing some text the plugin changes status (as expected), but then it shows this 💤, which to me means that it is waiting/processing something. This alone is fine, but then the statistics are a bit unclear. For example here I thought it meant that the sync is still waiting to upload/download some changes, but in reality it already finished with those. Perhaps the icon could be ✅ without the statistics to indicate that everything was synced successfully?

When you restart obsidian the statistics reset to 0, so I assume they are just what has been transferred during this session? An alternative could be to move the statistics to a tooltip on mouse over, but I don't know if this is possible to do with the API.

@vrtmrz
Copy link
Owner

vrtmrz commented Jan 23, 2025

Thank you for asking me!

The indicator 💤 means Connected, but noting being transferred. Just waiting.. (Only for LiveSync).
The following diagram may be helpful.

stateDiagram-v2
    ⏹: ⏹ Closed
    🌀: 🌀 Connecting
    ⚡: ⚡ Communicating
    💤: 💤 Waiting for new changes
    ⚠: ⚠ Unrecoverable Error
    [*] --> ⏹ 
    ⏹ --> 🌀
    🌀 --> ⚡
    ⚡ --> 💤
    💤 --> ⚡
    ⚡ --> ⏹
    ⚡ --> ⚠
    🌀 --> ⚠
Loading

As you mentioned, the statistics will be reset at the start.
And if you have something to upload/download, it will be displayed as placed in parens.
↑1 ↓0 means that our transfer has been stabilised. ↑1 (10) ↓0 means 10 items will be sent, and ↑1 ↓0 (10) means 10 items will be downloaded. ( (LIVE) means uncountable due to some reason).
As a matter of fact, the is a little hard to show and ambiguous, as it is not clear whether the transfer has finished reflecting the data in the storage or not.

Indeed it can be a bit confusing, but if you have any ideas, please let me know. (I know that you have known this, but I have been already lost).

@kohki-shikata
Copy link
Collaborator

It may not be an essential solution, but I made a simple icon. These icons are created on Figma. If @vrtmrz want to use these, I can provide immediately.

Image

https://www.figma.com/design/bd4uqnj9ghUPFdsHBWrAN9/Untitled?node-id=0-1&t=vEV5u5G2gKOSHHFI-1

If any points to enhancement, any suggestions are welcome. Please notify me.

It is true that issues related to check marks may be difficult to understand. If we can verbalize what exactly the check mark is supposed to convey to the user, we may be able to come up with an idea for an icon that is easier to understand.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants