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

Added necessary tooltips to icons in new frontend #2693 #2952

Closed
wants to merge 11 commits into from

Conversation

bryankhor07
Copy link
Contributor

@bryankhor07 bryankhor07 commented Oct 21, 2023

  • What existing problem does this PR solve?
    It adds tooltips to icons that need a short description.

Checks

  • All tests succeed.
  • Unit tests added.
  • e2e tests added.
  • Documentation updated.

Closing issues

Closes #2693

Co-authors: @lemonshark05 @gstgrace

@bryankhor07 bryankhor07 changed the title Added necessary tooltips to icons in new frontend Added necessary tooltips to icons in new frontend #2693 Oct 21, 2023
@jkppr jkppr self-requested a review October 24, 2023 11:29
@jkppr jkppr self-assigned this Oct 24, 2023
@jkppr jkppr added the Frontend label Oct 24, 2023
Copy link
Collaborator

@jkppr jkppr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First round review:

  • Thanks for contributing and tackling the tooltip task.
  • Please consider working from a separate branch in your fork and not from master.
  • Please keep your PR clean and do not submit files that are not necessary or related to the fix you are working on.
  • Please see the comments below.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep your PR clean and only submit files that are needed for your changes. The login.html file is not needed for the tooltip adjustments and should be removed from the PR please.

The Timesketch team builds a new UI on a regular basis to include all new changes.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep your PR clean and only include files needed for the issue you are fixing. The yarn.lock file is not needed for this PR. Please remove it from the PR.

@@ -34,7 +34,7 @@ limitations under the License.
</v-list-item>
<v-list-item style="cursor: pointer" @click="showContextWindow()">
<v-list-item-icon>
<v-icon small>mdi-magnify-plus-outline</v-icon>
<v-icon small>mdi-magnify-plus-outline</v-icon> <!--Add tooltip here? ()-->
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, this entry has an explanation next to it. It does not need a tooltip therefore.

Comment on lines +24 to +25
<!-- Add tooltip here? (Icons in the Threat Intelligence feature) -->
<span> <v-icon left>mdi-shield-search</v-icon> Threat Intelligence </span>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

@@ -37,7 +38,7 @@ limitations under the License.
@click="addIndicator()"
@click.stop=""
>
<v-icon>mdi-plus</v-icon>
<v-icon title="Add Indicator">mdi-plus</v-icon>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This icon has the same functionality as the one above (line 32). It should have the same tooltip.

@@ -92,7 +93,7 @@ limitations under the License.

<template v-slot:item.actions="{ item }">
<v-btn icon small @click="generateSearchQuery(item.ioc)">
<v-icon small>mdi-magnify</v-icon>
<v-icon small title="Search">mdi-magnify</v-icon>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this title be a bit more descriptive? e.g. "Search this indicator" Same for the other mdi-magnify "search" icons in this section.

@@ -33,7 +33,7 @@ limitations under the License.
<template v-slot:activator="{ on, attrs }">
<v-avatar>
<v-btn small icon v-bind="attrs" v-on="on">
<v-icon>mdi-dots-vertical</v-icon>
<v-icon title="Action Menu">mdi-dots-vertical</v-icon>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<v-icon title="Action Menu">mdi-dots-vertical</v-icon>
<v-icon title="Sketch menu">mdi-dots-vertical</v-icon>

@@ -63,7 +64,7 @@ limitations under the License.
]"
>
<v-btn icon @click="toggleLeftPanel">
<v-icon>mdi-menu</v-icon>
<v-icon title="Manage">mdi-menu</v-icon>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<v-icon title="Manage">mdi-menu</v-icon>
<v-icon title="Toggle left panel">mdi-menu</v-icon>

@gstgrace
Copy link

gstgrace commented Nov 3, 2023

Hi @jkppr , thanks for checking in! Yes, we are still revising the code based on the feedback.

@jkppr
Copy link
Collaborator

jkppr commented Nov 17, 2023

I forked this PR and finished it, since some UX guidance changed mid-way and we want to have it ready for the next release in December. Therefore closing this PR in favor of #2983 .

Thanks for contributing @gstgrace @bryankhor07 @lemonshark05

@jkppr jkppr closed this Nov 17, 2023
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.

UI feedback: Add tooltips to all the new icons
3 participants