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

Add 'document changed' indicator #155

Merged
merged 7 commits into from
Oct 16, 2020
Merged

Add 'document changed' indicator #155

merged 7 commits into from
Oct 16, 2020

Conversation

tjsilver
Copy link
Contributor

@tjsilver tjsilver commented Oct 15, 2020

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

doc_changed

A small blue circle to indicate when a document has changed since the
last time the check document button was pressed.
@tjsilver tjsilver requested review from jonathonherbert, SHession and a team October 15, 2020 13:51
Copy link
Contributor

@jonathonherbert jonathonherbert left a 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.

Copy link
Contributor

@SHession SHession left a 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.

@tjsilver
Copy link
Contributor Author

@tjsilver tjsilver merged commit 7682996 into master Oct 16, 2020
@tjsilver tjsilver deleted the ts-doc-changed-indicator branch October 16, 2020 09:27
@github-actions
Copy link

🎉 This PR is included in version 5.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

None yet

3 participants