OLD | NEW |
1 Shared Adblock Plus UI code | 1 Shared Adblock Plus UI code |
2 =========================== | 2 =========================== |
3 | 3 |
4 The user interface elements defined in this repository will be used by various | 4 The user interface elements defined in this repository will be used by various |
5 Adblock Plus products like Adblock Plus for Firefox. Their functionality can be | 5 Adblock Plus products like Adblock Plus for Firefox. Their functionality can be |
6 tested within this repository, even though they might not work exactly the same | 6 tested within this repository, even though they might not work exactly the same |
7 as they will do in the final product. | 7 as they will do in the final product. |
8 | 8 |
9 Installing dependencies | 9 Installing dependencies |
10 ----------------------- | 10 ----------------------- |
(...skipping 12 matching lines...) Expand all Loading... |
23 * Top-level files: | 23 * Top-level files: |
24 * `firstRun.html` and `firstRun.js`: First-run page, see below | 24 * `firstRun.html` and `firstRun.js`: First-run page, see below |
25 * `i18n.js`: Localization functions, should be included by all pages. | 25 * `i18n.js`: Localization functions, should be included by all pages. |
26 * `messageResponder.js`: Script to be used on the background page to respond | 26 * `messageResponder.js`: Script to be used on the background page to respond |
27 to messages sent by UI code. | 27 to messages sent by UI code. |
28 * `background.html`, `background.js`: Test implementation of the background | 28 * `background.html`, `background.js`: Test implementation of the background |
29 page, should *not be imported*. | 29 page, should *not be imported*. |
30 * `desktop-options.html`, `desktop-options.js`: Options page, see below | 30 * `desktop-options.html`, `desktop-options.js`: Options page, see below |
31 * `subscriptions.xml`: Test subscription data, should *not be imported* | 31 * `subscriptions.xml`: Test subscription data, should *not be imported* |
32 * `polyfill.js`: Browser API polyfills, should *not be imported* | 32 * `polyfill.js`: Browser API polyfills, should *not be imported* |
| 33 * `js` directory: new CommonJS modules/entry-points bundled to produce |
| 34 top level pages. As example, `js/desktop-options.js` produces |
| 35 `./desktop-options.js` [IIFE](https://developer.mozilla.org/en-US/docs/Glossar
y/IIFE) |
| 36 deployed within the extension. |
33 * `lib` directory: Modules to be used on the background page to expose | 37 * `lib` directory: Modules to be used on the background page to expose |
34 UI-related functionality. | 38 UI-related functionality. |
35 * `locale` directory: Localized strings, with one directory per locale. The | 39 * `locale` directory: Localized strings, with one directory per locale. The |
36 Firefox format for locale identifiers is used (xx-YY where xx is the language | 40 Firefox format for locale identifiers is used (xx-YY where xx is the language |
37 code and YY the optional region code). The localization strings themselves are | 41 code and YY the optional region code). The localization strings themselves are |
38 stored in the JSON format, like the one used by Chrome extensions. There is | 42 stored in the JSON format, like the one used by Chrome extensions. There is |
39 one JSON file per HTML page, file names of HTML page and JSON file should | 43 one JSON file per HTML page, file names of HTML page and JSON file should |
40 match. | 44 match. |
41 * `skin` directory: CSS files and any additional resources (images and fonts) | 45 * `skin` directory: CSS files and any additional resources (images and fonts) |
42 required for these. | 46 required for these. |
(...skipping 92 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
135 errors when adding new filters on the options page | 139 errors when adding new filters on the options page |
136 * `blockedURLs`: a comma-separated list of URLs that should be considered | 140 * `blockedURLs`: a comma-separated list of URLs that should be considered |
137 blocked (necessary to test the check for blocked scripts in sharing buttons). | 141 blocked (necessary to test the check for blocked scripts in sharing buttons). |
138 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used | 142 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used |
139 to trigger various filter list download errors | 143 to trigger various filter list download errors |
140 * `platform=chromium`: shows the opt-out for the developer tools panel | 144 * `platform=chromium`: shows the opt-out for the developer tools panel |
141 * `showNotificationUI=true`: simulates user having opted-out of notifications | 145 * `showNotificationUI=true`: simulates user having opted-out of notifications |
142 | 146 |
143 | 147 |
144 [crowdin]: https://crowdin.com | 148 [crowdin]: https://crowdin.com |
OLD | NEW |