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

Feature: UI Welcome Tour #1644

Merged
merged 8 commits into from
Oct 10, 2022
Merged

Feature: UI Welcome Tour #1644

merged 8 commits into from
Oct 10, 2022

Conversation

shamoon
Copy link
Member

@shamoon shamoon commented Sep 26, 2022

Proposed change

This PR adds a 'welcome tour' to the UI that makes front-end features more apparent and also updates the 'welcome widget'. Video below has quick demonstration, the content itself is in the app.component.ts and is easily editable. Would love feedback on the content and in general. Good news is its very easy to update. Some notes:

  • Feedback on the items, contents, etc is very much appreciated. Obviously goal is balance, we cant point every single thing out. Again, these are easy to change down the road.
  • I debated having the tour actually popup but instead opted for the widget with a start button. Theres also a new button under settings to re-start the tour at any point. I think our users prefer less-intrusive things.
  • Uses an actively maintained library https://github.com/hakimio/ngx-ui-tour which actually ultimately uses the Bootstrap popovers that we already use in other places in the UI, making the whole thing feel familiar and keeps this pretty lightweight.
  • Obviously this adds a bunch of new strings for translation which can be done after (if 😌) this is merged

(in the video im advancing quickly with the keyboard just for demonstration, items do not automatically advance)

welcometour.mov

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (please explain)

Checklist:

  • I have read & agree with the contributing guidelines.
  • If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
  • If applicable, I have checked that all tests pass, see documentation.
  • I have run all pre-commit hooks, see documentation.
  • I have made corresponding changes to the documentation as needed.
  • I have checked my modifications for any breaking changes.

@shamoon shamoon added enhancement New feature non-trivial Requires approval by several team members frontend labels Sep 26, 2022
@shamoon shamoon added this to the Next Release milestone Sep 26, 2022
@shamoon shamoon requested a review from a team as a code owner September 26, 2022 17:03
@shamoon shamoon self-assigned this Sep 26, 2022
@shamoon shamoon added the help wanted Extra attention is needed label Sep 26, 2022
@stumpylog
Copy link
Member

This is a great idea. A couple of things I noticed:

  • At least in dark mode, I feel like the pointers from the popup to the item are a little too subtle
  • Not sure 3/10 was pointing to the right spot? It was kind of floating in the center, instead of pointing at the view styles?
  • 9/10 doesn't highlight the admin link (but maybe it can't)

@shamoon
Copy link
Member Author

shamoon commented Sep 26, 2022

This is a great idea. A couple of things I noticed:

  • At least in dark mode, I feel like the pointers from the popup to the item are a little too subtle
  • Not sure 3/10 was pointing to the right spot? It was kind of floating in the center, instead of pointing at the view styles?
  • 9/10 doesn't highlight the admin link (but maybe it can't)

Thanks =) Helpful feedback.

  • There's a highlighting feature that was a bit finicky but I managed to get it working, I updated the video above, some pros/cons to it but I agree makes the thing we're highlighting much clearer.
  • 3/10 points to the list of docs itself, I made that more apparent now, but do we think it should point to the view style buttons?
  • Does now!

@stumpylog
Copy link
Member

I have no idea about the code portion, but this is great. I think people will like it

@sukisoft
Copy link

How is this rendered / displayed when in mobile view? I tend to use the mobile page very often, so maybe do others.

@shamoon
Copy link
Member Author

shamoon commented Oct 10, 2022

Certainly more comfortable on desktop but works just fine on mobile 🙂 (screenshot)

Screen Shot 2022-10-09 at 10 39 10 PM

@sukisoft
Copy link

Looks great, thanks for the Screenshot!

@shamoon shamoon merged commit fa526dd into dev Oct 10, 2022
@shamoon shamoon deleted the feature/welcome-tour branch October 10, 2022 06:50
@darkobg79
Copy link

Is possible to add translation strings for END, PREV and NEXT?
image

@shamoon
Copy link
Member Author

shamoon commented Nov 12, 2022

Is possible to add translation strings for END, PREV and NEXT?

Great catch, thanks! I'll add this now so we can try to get it into the current beta

@github-actions
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature frontend help wanted Extra attention is needed non-trivial Requires approval by several team members
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants