Skip to content

Commit 9dd55a4

Browse files
kemister85kemister85
committed
DOC-3189: Enhance documentation for uploadcare_filters option in Image Optimizer plugin.
1 parent 5b5557e commit 9dd55a4

File tree

2 files changed

+88
-63
lines changed

2 files changed

+88
-63
lines changed

‎modules/ROOT/pages/7.8.0-release-notes.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,10 @@ For information on the **<Premium plugin name 1>** plugin, see: xref:<plugincode
7373

7474
{productname} {release-version} introduces the **Image Optimizer (Powered by Uploadcare)** plugin.
7575

76-
=== Added support for `uploadcare_filters` option in the {pluginname} plugin
76+
=== Added support for `+uploadcare_filters+` option in the Image Optimizer (Powered by Uploadcare) plugin
7777
// #EPIC-146
7878

79-
The {pluginname} plugin now includes support for a new configuration option, `+uploadcare_filters+`, introduced in {release-version}. This option allows integrators to define a customizable list of image filters available within the {pluginname} dialog. Each filter can be configured with an optional `amount` parameter, controlling the intensity of the effect, and an optional `label` to customize its display name in the UI.
79+
The **Image Optimizer (Powered by Uploadcare)** plugin now includes support for a new configuration option, `+uploadcare_filters+`, introduced in {release-version}. This option allows integrators to define a customizable list of image filters available within the **Image Optimizer (Powered by Uploadcare)** dialog. Each filter can be configured with an optional `amount` parameter, controlling the intensity of the effect, and an optional `label` to customize its display name in the UI.
8080

8181
.Example
8282
[source,js]

‎modules/ROOT/partials/configuration/uploadcare_filters.adoc‎

Lines changed: 86 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
11
[[uploadcare-filters]]
22
== `uploadcare_filters`
33

4-
The `+uploadcare_filters+` option defines the list of image filters available when using the {pluginname} plugin. Each filter applies a stylized image effect consistent with the visual design of the content and can be configured with an amount value to control its intensity. Filters are applied via URL modifiers and support intensity values ranging from `-100` to `200`. Values below `0` produce inverted effects, `100` represents the standard effect, and values above `100` apply the effect with increased intensity.
4+
The `+uploadcare_filters+` option defines the list of image filters available when using the {pluginname} plugin. Each filter applies a stylized image effect consistent with the visual design of the content and can be configured with an amount value to control its intensity. Filters enhance images by applying consistent styling, improving overall quality, and boosting user engagement.
55

6-
*Type:* `+String+`
6+
7+
Each filter is defined as an object with the following properties:
8+
[source,js]
9+
----
10+
{
11+
name: 'filterName', // Required: name of the filter to apply
12+
amount: number, // Optional: strength of the filter (default = 100)
13+
label: 'string' // Optional: custom name to display in the UI
14+
}
15+
----
16+
17+
* **name**: A predefined filter identifier (e.g., adaris, zevcen, galen).
18+
* **amount**: The intensity of the filter effect, ranging from -100 to 200:
19+
** **0**: No effect (image stays original).
20+
** **0** to **100**: Gradually increases filter strength.
21+
** **100**: Default intensity (as the filter is designed).
22+
** **>100**: Exaggerates the effect.
23+
** **<0**: Inverts the filter effect (produces a "negative" version).
24+
* **label**: Optional display name for the filter in your UI. If omitted, it defaults to the name.
725

826
=== Example: Setting `uploadcare_filters`
927

@@ -33,69 +51,76 @@ tinymce.init({
3351
});
3452
----
3553

54+
[NOTE]
55+
* Filter names must be selected from the supported set: adaris, briaril, calarel, carris, cynarel, cyren, elmet, elonni, enzana,
56+
erydark, fenralan, ferand, galen, gavin, gethriel, iorill, iothari, iselva, jadis, lavra, misiara, namala, nerion, nethari, pamaya, sarnar, sedis, sewen, sorahel, sorlen, tarian, thellassan, varriel, varven, evera, virkas, yedis, yllara, zatvel, zevcen.
57+
* If the amount is not set, it defaults to 100.
58+
* Some filters may behave unpredictably outside the 0–100 range.
59+
* Applying negative amount values inverts the filter, useful for creative effects.
60+
3661
=== Uploadcare Filter Previews
3762

3863
Each image below represents a filter applied to the same source image.
3964

4065
[cols="1,1,1,1", options="header"]
4166
|===
42-
|-/filter/adaris/ |-/filter/briaril/ |-/filter/calarel/ |-/filter/carris/
43-
|image:uploadcare/filters/cynarel.jpg[-/filter/adaris/]
44-
|image:uploadcare/filters/briaril.jpg[-/filter/briaril/]
45-
|image:uploadcare/filters/calarel.jpg[-/filter/calarel/]
46-
|image:uploadcare/filters/carris.jpg[-/filter/carris/]
47-
48-
|-/filter/cynarel/ |-/filter/cyren/ |-/filter/elmet/ |-/filter/elonni/
49-
|image:uploadcare/filters/cynarel.jpg[-/filter/cynarel/]
50-
|image:uploadcare/filters/cyren.jpg[-/filter/cyren/]
51-
|image:uploadcare/filters/elmet.jpg[-/filter/elmet/]
52-
|image:uploadcare/filters/elonni.jpg[-/filter/elonni/]
53-
54-
|-/filter/enzana/ |-/filter/erydark/ |-/filter/fenralan/ |-/filter/ferand/
55-
|image:uploadcare/filters/enzana.jpg[-/filter/enzana/]
56-
|image:uploadcare/filters/erydark.jpg[-/filter/erydark/]
57-
|image:uploadcare/filters/fenralan.jpg[-/filter/fenralan/]
58-
|image:uploadcare/filters/ferand.jpg[-/filter/ferand/]
59-
60-
|-/filter/galen/ |-/filter/gavin/ |-/filter/gethriel/ |-/filter/iorill/
61-
|image:uploadcare/filters/galen.jpg[-/filter/galen/]
62-
|image:uploadcare/filters/gavin.jpg[-/filter/gavin/]
63-
|image:uploadcare/filters/gethriel.jpg[-/filter/gethriel/]
64-
|image:uploadcare/filters/iorill.jpg[-/filter/iorill/]
65-
66-
|-/filter/iothari/ |-/filter/iselva/ |-/filter/jadis/ |-/filter/lavra/
67-
|image:uploadcare/filters/iothari.jpg[-/filter/iothari/]
68-
|image:uploadcare/filters/iselva.jpg[-/filter/iselva/]
69-
|image:uploadcare/filters/jadis.jpg[-/filter/jadis/]
70-
|image:uploadcare/filters/lavra.jpg[-/filter/lavra/]
71-
72-
|-/filter/misiara/ |-/filter/namala/ |-/filter/nerion/ |-/filter/nethari/
73-
|image:uploadcare/filters/misiara.jpg[-/filter/misiara/]
74-
|image:uploadcare/filters/namala.jpg[-/filter/namala/]
75-
|image:uploadcare/filters/nerion.jpg[-/filter/nerion/]
76-
|image:uploadcare/filters/nethari.jpg[-/filter/nethari/]
77-
78-
|-/filter/pamaya/ |-/filter/sarnar/ |-/filter/sedis/ |-/filter/sewen/
79-
|image:uploadcare/filters/pamaya.jpg[-/filter/pamaya/]
80-
|image:uploadcare/filters/sarnar.jpg[-/filter/sarnar/]
81-
|image:uploadcare/filters/sedis.jpg[-/filter/sedis/]
82-
|image:uploadcare/filters/sewen.jpg[-/filter/sewen/]
83-
84-
|-/filter/sorahel/ |-/filter/sorlen/ |-/filter/tarian/ |-/filter/thellassan/
85-
|image:uploadcare/filters/sorahel.jpg[-/filter/sorahel/]
86-
|image:uploadcare/filters/sorlen.jpg[-/filter/sorlen/]
87-
|image:uploadcare/filters/tarian.jpg[-/filter/tarian/]
88-
|image:uploadcare/filters/thellassan.jpg[-/filter/thellassan/]
89-
90-
|-/filter/varriel/ |-/filter/varven/ |-/filter/vevera/ |-/filter/virkas/
91-
|image:uploadcare/filters/varriel.jpg[-/filter/varriel/]
92-
|image:uploadcare/filters/varven.jpg[-/filter/varven/]
93-
|image:uploadcare/filters/vevera.jpg[-/filter/vevera/]
94-
|image:uploadcare/filters/virkas.jpg[-/filter/virkas/]
95-
96-
|-/filter/yedis/ |-/filter/yllara/ |-/filter/zatvel/ |-/filter/zevcen/
97-
|image:uploadcare/filters/yedis.jpg[-/filter/yedis/]
98-
|image:uploadcare/filters/yllara.jpg[-/filter/yllara/]
99-
|image:uploadcare/filters/zatvel.jpg[-/filter/zatvel/]
100-
|image:uploadcare/filters/zevcen.jpg[-/filter/zevcen/]
67+
|adaris |briaril |calarel |carris
68+
|image:uploadcare/filters/cynarel.jpg[adaris]
69+
|image:uploadcare/filters/briaril.jpg[briaril]
70+
|image:uploadcare/filters/calarel.jpg[calarel]
71+
|image:uploadcare/filters/carris.jpg[carris]
72+
73+
|cynarel |cyren |elmet |elonni
74+
|image:uploadcare/filters/cynarel.jpg[cynarel]
75+
|image:uploadcare/filters/cyren.jpg[cyren]
76+
|image:uploadcare/filters/elmet.jpg[elmet]
77+
|image:uploadcare/filters/elonni.jpg[elonni]
78+
79+
|enzana |erydark |fenralan |ferand
80+
|image:uploadcare/filters/enzana.jpg[enzana]
81+
|image:uploadcare/filters/erydark.jpg[erydark]
82+
|image:uploadcare/filters/fenralan.jpg[fenralan]
83+
|image:uploadcare/filters/ferand.jpg[ferand]
84+
85+
|galen |gavin |gethriel |iorill
86+
|image:uploadcare/filters/galen.jpg[galen]
87+
|image:uploadcare/filters/gavin.jpg[gavin]
88+
|image:uploadcare/filters/gethriel.jpg[gethriel]
89+
|image:uploadcare/filters/iorill.jpg[iorill]
90+
91+
|iothari |iselva |jadis |lavra
92+
|image:uploadcare/filters/iothari.jpg[iothari]
93+
|image:uploadcare/filters/iselva.jpg[iselva]
94+
|image:uploadcare/filters/jadis.jpg[jadis]
95+
|image:uploadcare/filters/lavra.jpg[lavra]
96+
97+
|misiara |namala |nerion |nethari
98+
|image:uploadcare/filters/misiara.jpg[misiara]
99+
|image:uploadcare/filters/namala.jpg[namala]
100+
|image:uploadcare/filters/nerion.jpg[nerion]
101+
|image:uploadcare/filters/nethari.jpg[nethari]
102+
103+
|pamaya |sarnar |sedis |sewen
104+
|image:uploadcare/filters/pamaya.jpg[pamaya]
105+
|image:uploadcare/filters/sarnar.jpg[sarnar]
106+
|image:uploadcare/filters/sedis.jpg[sedis]
107+
|image:uploadcare/filters/sewen.jpg[sewen]
108+
109+
|sorahel |sorlen |tarian |thellassan
110+
|image:uploadcare/filters/sorahel.jpg[sorahel]
111+
|image:uploadcare/filters/sorlen.jpg[sorlen]
112+
|image:uploadcare/filters/tarian.jpg[tarian]
113+
|image:uploadcare/filters/thellassan.jpg[thellassan]
114+
115+
|varriel |varven |vevera |virkas
116+
|image:uploadcare/filters/varriel.jpg[varriel]
117+
|image:uploadcare/filters/varven.jpg[varven]
118+
|image:uploadcare/filters/vevera.jpg[vevera]
119+
|image:uploadcare/filters/virkas.jpg[virkas]
120+
121+
|yedis |yllara |zatvel |zevcen
122+
|image:uploadcare/filters/yedis.jpg[yedis]
123+
|image:uploadcare/filters/yllara.jpg[yllara]
124+
|image:uploadcare/filters/zatvel.jpg[zatvel]
125+
|image:uploadcare/filters/zevcen.jpg[zevcen]
101126
|===

0 commit comments

Comments
 (0)