Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: README.md

Issue 29723623: Issue 6487 - IOElement as base component for ABP UI (Closed)
Patch Set: Created March 21, 2018, 2:20 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « .hgignore ('k') | js/io-element.js » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 49 matching lines...) Expand 10 before | Expand all | Expand 10 after
60 You can pass along to underlying [http-server](https://www.npmjs.com/package/htt p-server) 60 You can pass along to underlying [http-server](https://www.npmjs.com/package/htt p-server)
61 program any arguments via `--` as in: 61 program any arguments via `--` as in:
62 ```sh 62 ```sh
63 npm start -- -p 5000 -c-1 63 npm start -- -p 5000 -c-1
64 ``` 64 ```
65 65
66 Various aspects of the pages can be tested by setting parameters in the URL. 66 Various aspects of the pages can be tested by setting parameters in the URL.
67 The only universal parameter is `locale`, e.g. `?locale=es-AR`. This parameter 67 The only universal parameter is `locale`, e.g. `?locale=es-AR`. This parameter
68 overrides browser's locale which will be used by default. 68 overrides browser's locale which will be used by default.
69 69
70 Smoke Testing UI
71 ----------------
72
73 The `./tests` folder contains essential files to test our Custom Elements
74 in isolation. As it is done for the `io-element` one, you need to add
75 at least an `io-element.js` test file and its `io-element.html` related page.
76
77 A package script entry such `"test:io-element.js"` should bundle the
78 resulting page/component inside the `./smoke` folder.
79
80 Please read how it's done for `io-element` to know more.
81
82
70 Linting 83 Linting
71 ------- 84 -------
72 85
73 You can lint all options via `npm run lint`. 86 You can lint all options via `npm run lint`.
74 87
75 You can also run specific target linting via `npm run lint:js` or, once availabl e, via `npm run lint:css`. 88 You can also run specific target linting via `npm run lint:js` or, once availabl e, via `npm run lint:css`.
76 89
77 Remember, both `eslint` and `stylelint` can help fixing issues via `--fix` flag. 90 Remember, both `eslint` and `stylelint` can help fixing issues via `--fix` flag.
78 91
79 You can try as example via [npx](https://medium.com/@maybekatz/introducing-npx-a n-npm-package-runner-55f7d4bd282b) 92 You can try as example via [npx](https://medium.com/@maybekatz/introducing-npx-a n-npm-package-runner-55f7d4bd282b)
(...skipping 124 matching lines...) Expand 10 before | Expand all | Expand 10 after
204 errors when adding new filters on the options page 217 errors when adding new filters on the options page
205 * `blockedURLs`: a comma-separated list of URLs that should be considered 218 * `blockedURLs`: a comma-separated list of URLs that should be considered
206 blocked (necessary to test the check for blocked scripts in sharing buttons). 219 blocked (necessary to test the check for blocked scripts in sharing buttons).
207 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used 220 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used
208 to trigger various filter list download errors 221 to trigger various filter list download errors
209 * `platform=chromium`: shows the opt-out for the developer tools panel 222 * `platform=chromium`: shows the opt-out for the developer tools panel
210 * `showNotificationUI=true`: simulates user having opted-out of notifications 223 * `showNotificationUI=true`: simulates user having opted-out of notifications
211 224
212 225
213 [crowdin]: https://crowdin.com 226 [crowdin]: https://crowdin.com
OLDNEW
« no previous file with comments | « .hgignore ('k') | js/io-element.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld