-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add 'document changed' indicator #155
Conversation
A small blue circle to indicate when a document has changed since the last time the check document button was pressed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code looks great. Tested locally, works as expected. Top work.
As @SHession has mentioned, if there's a precedent in other UIs for moving the button to the right (GH does this, for example) it might be worth following that convention – IIRC western eyes read left to right and alerts or actions are often found there as a result, but I don't have strong opinions.
It'd be great to see that title text when we hover over the button – the dot is very small, and I think people are less likely to see it as a result.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code looks get and tested locally.
+1 to @jonathonherbert's comments on title text and placement.
🎉 This PR is included in version 5.8.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
What does this change?
Currently a user has no way of knowing if Typerighter should run again, given that the document has changed in a significant way. This could mislead a user into thinking a document has been checked when it hasn't.
This PR adds a small blue dot to indicate when a document has changed since the last time the 'Check document' button was pressed.
How to test
Run the branch locally and make a change to the document. See the blue dot appear. Click 'Check document' and see it disappear until the document is changed again.
How can we measure success?
Users are able to tell if the matches shown are as up-to-date as possible.
Have we considered potential risks?
Users might not realise what the dot is for, or might find it irritating.
Images