mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-21 09:15:35 +00:00

History

gasolin 11235d69b5 Bug 1381765 - Should show the first uncomplete tour by default;r=Fischer,mossop MozReview-Commit-ID: 4vDvR4lVE16 --HG-- extra : rebase_source : 6ba646d7c02b1a56acdee2c155c6db25ae4e0821		2017-07-18 18:23:47 +08:00
..
content	Bug 1381765 - Should show the first uncomplete tour by default;r=Fischer,mossop	2017-07-18 18:23:47 +08:00
locales	Bug 1380963 - Display different welcome messages for update or new users on the overlay tour icon.r=flod,gasolin,mossop	2017-07-17 15:51:43 +08:00
test	Bug 1377439 - Should adapt the oboarding UI to the hight-contrast display mode, r=mossop	2017-07-18 14:26:25 +08:00
bootstrap.js	Bug 1357027 - Should mark the Firefox Sync tour as completed if user sign-in a Firefox Account. r=florian,mossop	2017-07-10 14:10:03 +08:00
install.rdf.in	Bug 1357005 - Create onboarding icon which toggles a first-time use dialog on net newtab. r=mossop	2017-05-22 17:00:16 +08:00
jar.mn	Bug 1367696 - PART I determine the tour type;r=mossop,timdream	2017-06-22 16:10:46 +08:00
moz.build	Bug 1367696 - PART II add xpcshell structure for onboarding;r=mossop,rexboy	2017-06-22 16:25:53 +08:00
OnboardingTourType.jsm	Bug 1372067 - Part 1: Implement the prompt timing policy of the tour notification bar, r=mossop	2017-07-12 12:33:45 +08:00
README.md	Bug 1377289 - [a11y] All tour images should be accessible;r=mossop,yzen	2017-07-14 12:03:36 +08:00

README.md

Onboarding

System addon to provide the onboarding overlay for user-friendly tours.

How to show the onboarding tour

Open about:config page and filter with onboarding keyword. Then set following preferences:

browser.onboarding.disabled = false
browser.onboarding.hidden = false
browser.onboarding.tour-set = "new" // for new user tour, or "update" for update user tour

And make sure the value of browser.onboarding.tourset-verion and browser.onboarding.seen-tourset-verion are the same.

Architecture

Everytime about:home or about:newtab page is opened, onboarding overlay is injected into that page.

OnboardingTourType.jsm will check the onboarding tour type (currently support new and update). Then in onboarding.js, All tours are defined inside of onboardingTourset dictionary. getTourIDList function will load tours from proper preferences. (Check How to change the order of tours section for more detail).

When user clicks the action button in each tour, We use UITour to highlight the correspondent browser UI element.

Landing rules

We would apply some rules:

All styles and ids should be formatted as onboarding-* to avoid conflict with the origin page.
All strings in locales should be formatted as onboarding.* for consistency.
For accessibility, images that are for presentation only should have role="presentation" attribute.

How to change the order of tours

Edit browser/app/profile/firefox.js and modify browser.onboarding.newtour for the new user tour or browser.onboarding.updatetour for the update user tour. You can change the tour list and the order by concate tourIds with , sign. You can find available tourId from onboardingTourset in onboarding.js.

How to pump tour set version after update tours

The tourset version is used to track the last major tourset change version. The tourset-version pref store the major tourset version (ex: 1) but not the current browser version. When browser update to the next version (ex: 58, 59) the tourset pref is still 1 if we didn't do any major tourset update.

Once the tour set version is updated (ex: 2), onboarding overlay should show the update tour to the updated user (ex: update from v56 -> v57), even when user has watched the previous tours or preferred to hide the previous tours.

Edit browser/app/profile/firefox.js and set browser.onboarding.tourset-version as [tourset version] (in integer format).

For example, if we update the tourset in v60 and decide to show all update users the tour, we set browser.onboarding.tourset-version as 3.