browser/extensions/onboarding/README.md
author gasolin <gasolin@gmail.com>
Wed, 07 Jun 2017 13:51:46 +0800
changeset 411099 e92dd6dae230f9ebff1c30d7168d08c5eaac5920
child 414949 4cd7f4883692a394484deeb2ca4e1d59eafbc0cc
permissions -rw-r--r--
Bug 1369282 - Update the close button style in the onboarding overlay to fit the spec;r=Fischer,mossop,rexboy MozReview-Commit-ID: 6uLfRFf6GB5

# Onboarding

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

## Architecture

Everytime `about:home` or `about:newtab` page is opened, onboarding overlay is injected into that page (if `browser.onboarding.enabled` preference is `true`).

## Landing rules

We would apply some rules:

* Avoid `chrome://` in `onbaording.js` since onboarding is intented to be injected into a normal content process page.
* All styles and ids should be formated as `onboarding-*` to avoid conflict with the origin page.
* All strings in `locales` should be formated as `onboarding.*` for consistency.