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

Icon request for local history entry #144823

Closed
bpasero opened this issue Mar 10, 2022 · 21 comments
Closed

Icon request for local history entry #144823

bpasero opened this issue Mar 10, 2022 · 21 comments
Assignees
Labels
icons-product Issues for in-product icons ux User experience issues
Milestone

Comments

@bpasero
Copy link
Member

bpasero commented Mar 10, 2022

I am exploring to add entries to the "Timeline" view from saving files (= local history). This requires to use an icon to tell apart from SCM entries:

image

I am happy to use an existing icon or a new one, filing this issue to discuss.

@bpasero bpasero added the ux User experience issues label Mar 10, 2022
@bpasero bpasero added this to the March 2022 milestone Mar 10, 2022
@bpasero bpasero added the icons-product Issues for in-product icons label Mar 10, 2022
@bpasero
Copy link
Member Author

bpasero commented Mar 10, 2022

Some ideas:

Codicon.file

image

Codicon.history

image

Codicon.versions

image

@daviddossett
Copy link
Contributor

I also wonder if they should be children of the "Uncommitted Changes" entry?

@daviddossett
Copy link
Contributor

daviddossett commented Mar 10, 2022

I like history since it represents an idea of time. But it also feels like it references a list of events, not a specific event. file could work. Here are some other options from our existing icons. This shows them as indented too just to give an example of the idea above.

save

CleanShot 2022-03-10 at 09 03 45@2x

check

CleanShot 2022-03-10 at 09 03 59@2x

I also saw this on GH which feels like a more relevant variation on file:

CleanShot 2022-03-10 at 09 15 56@2x

@miguelsolorio
Copy link
Contributor

@bpasero do we know what other types of entries will appear here for local history entries? or is it only for saving?

@bpasero
Copy link
Member Author

bpasero commented Mar 10, 2022

I also wonder if they should be children of the "Uncommitted Changes" entry?

That is not possible with how the API works: "Uncommitted changes" originates from the Git extension, "Local history" originates from the core workbench.

save icon

I like the save icon, because that is the event that triggers the addition of a new local history entry: every save of a file.

we know what other types of entries will appear here for local history entries?

The trigger is saving but I was planning to add support to provide a label for the circumstances: for example a file might be saved by the user typing in the editor but also via refactoring. Would be nice to tell apart the one from the other to see a nice history of what actually happened to the file. but I would probably not show a different icon, just a different label.

@daviddossett
Copy link
Contributor

That is not possible with how the API works: "Uncommitted changes" originates from the Git extension, "Local history" originates from the core workbench.

Ah ok, I misunderstood. Got it.

@bpasero
Copy link
Member Author

bpasero commented Mar 10, 2022

Btw even more interesting: entries from Git are mixed with entries from Local history, so grouping them under "Uncommitted changes" is not really telling the truth. It is 2 distinct sources of timeline entries, you can have 5 Git entries, followed by 5 local history entries, followed by 5 git entries and so on.

@daviddossett
Copy link
Contributor

Makes sense. I think the save icon probably is the most truthful then. The file with the nested +/- icons could also work but may be a little bit too close to git concepts like a diff.

@bpasero
Copy link
Member Author

bpasero commented Mar 10, 2022

Here is how that looks like with an example of entries mixed:

image

I am happy for feedback on the local history item specifically: given we do not have a good label by default, I ended up putting the date first and then a description in the end. This is pretty much what Eclipse and IntelliJ also tend to do:

image

image

@bpasero bpasero closed this as completed Mar 15, 2022
@bpasero
Copy link
Member Author

bpasero commented Mar 15, 2022

Will go with the save icon.

@bpasero bpasero reopened this Mar 16, 2022
@bpasero
Copy link
Member Author

bpasero commented Mar 16, 2022

From the UX call feedback was that the save icon looks like 1980. And in reality we have more sources of history events than the user hitting save (e.g. refactorings, search and replace).

Maybe a more generic icon after all should be used then?

Reopening to consider that.

//cc @isidorn

@daviddossett
Copy link
Contributor

Thought about something super generic like circle-outline:

CleanShot 2022-03-16 at 11 57 55@2x

..or not using an icon at all since it doesn't add a ton of value. The indent is weird here—perhaps it's different in the actual component vs. our Figma bits here:

CleanShot 2022-03-16 at 11 59 41@2x

@bpasero
Copy link
Member Author

bpasero commented Mar 16, 2022

Yeah works really well imho:

image

@bpasero
Copy link
Member Author

bpasero commented Mar 16, 2022

Btw I am not yet sure we can get to the solution where local history entries appear as a tree node with children, at least not in the first iteration. If I can somehow get the "Load more..." thing to behave like I want for my items, it would be very similar, the entries would simply appear at the place you clicked.

bpasero added a commit that referenced this issue Mar 16, 2022
@daviddossett
Copy link
Contributor

Would they appear below the commits? I didn't quite follow that bit when we were talking through it earlier.

@bpasero
Copy link
Member Author

bpasero commented Mar 16, 2022

@daviddossett here is a complete end to end with the label and icon changes including timeline and editor:
Recording 2022-03-16 at 21 06 42

Would they appear below the commits? I didn't quite follow that bit when we were talking through it earlier

I think so, yeah. basically you see a placeholder for a group (1-many) of local history entries anywhere in the timeline where multiple entries of the local history appear. And when you click that item, it would go away and resolve the local history entries, similar how "Load more..." loads more items to the list.

That said, agree it is not such a nice model, because you can also not go back. Having a way to expand/collapse might be the way to go, will see. UI wise that is probably the better solution, but need to see it in action first.

@isidorn
Copy link
Contributor

isidorn commented Mar 17, 2022

Looks good and modern!

Nit: can we use a longer vertical line for the Git icon so they look a bit more connected and easily distinguishable from the new saved icon?

@bpasero
Copy link
Member Author

bpasero commented Mar 17, 2022

Yeah I had a similar feeling that now local history and git history entries look quite similar.

@bpasero
Copy link
Member Author

bpasero commented Mar 17, 2022

Nevertheless, I really like that both icons look somewhat similar in a way, because that conveys the information that each entry is a change to the file. Just the kind of change is different, or rather: the source 👍

@miguelsolorio
Copy link
Contributor

Nit: can we use a longer vertical line for the Git icon so they look a bit more connected and easily distinguishable from the new saved icon?

The icon itself already fills the entire height of the container so that means the list would need to be tweaked instead

CleanShot 2022-03-17 at 07 39 40@2x

@daviddossett
Copy link
Contributor

here is a complete end to end with the label and icon changes including timeline and editor:

Looking good!

I think so, yeah. basically you see a placeholder for a group (1-many) of local history entries anywhere in the timeline where multiple entries of the local history appear. And when you click that item, it would go away and resolve the local history entries, similar how "Load more..." loads more items to the list.

I see. I probably wouldn't have expected the behavior before clicking on it. I think a tree would make more sense if it's possible.

@miguelsolorio miguelsolorio removed their assignment Mar 17, 2022
@bpasero bpasero closed this as completed Mar 21, 2022
@github-actions github-actions bot locked and limited conversation to collaborators May 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
icons-product Issues for in-product icons ux User experience issues
Projects
None yet
Development

No branches or pull requests

4 participants