Skip to content

Commit bcf846d

Browse files
author
Atlassian Bamboo
committed
deploy: update docs for v2.2.12
1 parent 0297531 commit bcf846d

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

wiki/about-scriptlets.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -903,7 +903,7 @@ https://github.com/uBlockOrigin/uBlock-issues/wiki/Resources-Library#href-saniti
903903
### Syntax
904904

905905
```text
906-
example.org#%#//scriptlet('href-sanitizer', selector[, attribute, [ transform]])
906+
example.org#%#//scriptlet('href-sanitizer', selector[, attribute[, transform]])
907907
```
908908

909909
- `selector` — required, a CSS selector to match the elements to be sanitized,
@@ -921,7 +921,7 @@ example.org#%#//scriptlet('href-sanitizer', selector[, attribute, [ transform]])
921921
if no parameter is specified, remove all parameters.
922922

923923
> Note that in the case where the discovered value does not correspond to a valid URL with the appropriate
924-
> http or https protocols, the value will not be set.
924+
> HTTP or HTTPS protocols, the value will not be set.
925925
926926
### Examples
927927

@@ -1059,38 +1059,38 @@ example.org#%#//scriptlet('href-sanitizer', selector[, attribute, [ transform]])
10591059
10601060
> Added in v1.8.2.
10611061
1062-
Injects CSS rule into selected Shadow DOM subtrees on a page
1062+
Injects CSS rule into selected Shadow DOM subtrees on a page.
10631063
10641064
### Syntax
10651065
10661066
```text
1067-
example.org#%#//scriptlet('inject-css-in-shadow-dom', cssRule[, hostSelector])
1067+
example.org#%#//scriptlet('inject-css-in-shadow-dom', cssRule[, hostSelector[, cssInjectionMethod]])
10681068
```
10691069

1070-
- `cssRule` — required, string representing a single css rule
1070+
- `cssRule` — required, string representing a single CSS rule.
10711071
- `hostSelector` — optional, string, selector to match shadow host elements.
10721072
CSS rule will be only applied to shadow roots inside these elements.
1073-
Defaults to injecting css rule into all available roots.
1074-
- `cssInjectionMethod` — optional, string, method to inject css rule into shadow dom.
1073+
Defaults to injecting CSS rule into all available roots.
1074+
- `cssInjectionMethod` — optional, string, method to inject CSS rule into shadow DOM.
10751075
Available methods are:
10761076
- `adoptedStyleSheets` — injects the CSS rule using adopted style sheets (default option).
10771077
- `styleTag` — injects the CSS rule using a `style` tag.
10781078

10791079
### Examples
10801080

1081-
1. Apply style to all shadow dom subtrees
1081+
1. Apply style to all shadow DOM subtrees:
10821082

10831083
```adblock
10841084
example.org#%#//scriptlet('inject-css-in-shadow-dom', '#advertisement { display: none !important; }')
10851085
```
10861086
1087-
1. Apply style to a specific shadow dom subtree
1087+
1. Apply style to a specific shadow DOM subtree:
10881088
10891089
```adblock
10901090
example.org#%#//scriptlet('inject-css-in-shadow-dom', '#content { margin-top: 0 !important; }', '#banner')
10911091
```
10921092
1093-
1. Apply style to all shadow dom subtrees using style tag
1093+
1. Apply style to all shadow DOM subtrees using style tag:
10941094
10951095
```adblock
10961096
example.org#%#//scriptlet('inject-css-in-shadow-dom', '.ads { display: none !important; }', '', 'styleTag')
@@ -1115,31 +1115,31 @@ https://github.com/gorhill/uBlock/commit/749cec0f095f659d6c0b90eb89b729e9deb07c8
11151115
example.org#%#//scriptlet('json-prune-fetch-response'[, propsToRemove[, obligatoryProps[, propsToMatch[, stack]]]])
11161116
```
11171117

1118-
- `propsToRemove` — optional, string of space-separated properties to remove
1118+
- `propsToRemove` — optional, string of space-separated properties to remove.
11191119
- `obligatoryProps` — optional, string of space-separated properties
1120-
which must be all present for the pruning to occur
1120+
which must be all present for the pruning to occur.
11211121
- `propsToMatch` — optional, string of space-separated properties to match; possible props:
1122-
- string or regular expression for matching the URL passed to fetch call;
1123-
empty string, wildcard `*` or invalid regular expression will match all fetch calls
1124-
- colon-separated pairs `name:value` where
1122+
- String or regular expression for matching the URL passed to fetch call;
1123+
empty string, wildcard `*` or invalid regular expression will match all fetch calls.
1124+
- Colon-separated pairs `name:value` where:
11251125
<!-- markdownlint-disable-next-line line-length -->
1126-
- `name` is [`init` option name](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#parameters)
1126+
- `name` is [`init` option name](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#parameters).
11271127
- `value` is string or regular expression for matching the value of the option passed to fetch call;
1128-
invalid regular expression will cause any value matching
1128+
invalid regular expression will cause any value matching.
11291129
- `stack` — optional, string or regular expression that must match the current function call stack trace;
1130-
if regular expression is invalid it will be skipped
1130+
if regular expression is invalid it will be skipped.
11311131

11321132
> Note please that you can use wildcard `*` for chain property name,
11331133
> e.g. `ad.*.src` instead of `ad.0.src ad.1.src ad.2.src`.
11341134
1135-
> Usage with with only propsToMatch argument will log fetch calls to browser console.
1136-
> It may be useful for debugging but it is not allowed for prod versions of filter lists.
1135+
> Usage with only propsToMatch argument will log fetch calls to browser console.
1136+
> It may be useful for debugging, but it is not allowed for prod versions of filter lists.
11371137
11381138
> Scriptlet does nothing if response body can't be converted to JSON.
11391139
11401140
### Examples
11411141

1142-
1. Removes property `example` from the JSON response of any fetch call
1142+
1. Removes property `example` from the JSON response of any fetch call:
11431143

11441144
```adblock
11451145
example.org#%#//scriptlet('json-prune-fetch-response', 'example')
@@ -1157,31 +1157,31 @@ example.org#%#//scriptlet('json-prune-fetch-response'[, propsToRemove[, obligato
11571157
{one: 1}
11581158
```
11591159
1160-
2. A property in a list of properties can be a chain of properties
1160+
2. A property in a list of properties can be a chain of properties:
11611161
11621162
```adblock
11631163
example.org#%#//scriptlet('json-prune-fetch-response', 'a.b', 'ads.url.first')
11641164
```
11651165
1166-
3. Removes property `content.ad` from the JSON response of a fetch call if URL contains `content.json`
1166+
3. Removes property `content.ad` from the JSON response of a fetch call if URL contains `content.json`:
11671167
11681168
```adblock
11691169
example.org#%#//scriptlet('json-prune-fetch-response', 'content.ad', '', 'content.json')
11701170
```
11711171
1172-
4. Removes property `content.ad` from the JSON response of a fetch call if its error stack trace contains `test.js`
1172+
4. Removes property `content.ad` from the JSON response of a fetch call if its error stack trace contains `test.js`:
11731173
11741174
```adblock
11751175
example.org#%#//scriptlet('json-prune-fetch-response', 'content.ad', '', '', 'test.js')
11761176
```
11771177
1178-
5. A property in a list of properties can be a chain of properties with wildcard in it
1178+
5. A property in a list of properties can be a chain of properties with wildcard in it:
11791179
11801180
```adblock
11811181
example.org#%#//scriptlet('json-prune-fetch-response', 'content.*.media.src', 'content.*.media.ad')
11821182
```
11831183
1184-
6. Log all JSON responses of a fetch call
1184+
6. Log all JSON responses of a fetch call:
11851185
11861186
```adblock
11871187
example.org#%#//scriptlet('json-prune-fetch-response')

0 commit comments

Comments
 (0)