-
Notifications
You must be signed in to change notification settings - Fork 220
DOC-3131: Add image filter assets, and new uploadcare_filters option for uploadcare plugin.
#3679
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
kemister85
merged 9 commits into
feature/7.8.0/DOC-3131
from
feature/7.8.0/DOC-3131_DOC-3193
Apr 9, 2025
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3c220c0
DOC-3131: Add image filter assets, and new uploadcare_filters option …
kemister85 5b5557e
DOC-3131: update live-demo with new uploadcare_filters option.
kemister85 9dd55a4
DOC-3189: Enhance documentation for uploadcare_filters option in Imag…
kemister85 9b24e53
DOC-3131: Copy edits to filter list name.
kemister85 695eb9a
DOC-3131: Add auto-image-enhancement icon and update documentation, r…
kemister85 0bf4b9a
DOC-3131: Fix note missing border.
kemister85 42cd454
Merge branch 'feature/7.8.0/DOC-3131' into feature/7.8.0/DOC-3131_DOC…
kemister85 3ce814d
Update antora.yml
kemister85 e728789
Merge branch 'feature/7.8.0/DOC-3131' into feature/7.8.0/DOC-3131_DOC…
kemister85 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
128 changes: 128 additions & 0 deletions
128
modules/ROOT/partials/configuration/uploadcare_filters.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| [[uploadcare-filters]] | ||
| == `uploadcare_filters` | ||
|
|
||
| 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. | ||
|
|
||
|
|
||
| Each filter is defined as an object with the following properties: | ||
| [source,js] | ||
| ---- | ||
| { | ||
| name: 'filterName', // Required: name of the filter to apply | ||
| amount: number, // Optional: strength of the filter (default = 100) | ||
| label: 'string' // Optional: custom name to display in the UI | ||
| } | ||
| ---- | ||
|
|
||
| * `name`: A predefined filter identifier (e.g., adaris, zevcen, galen). | ||
| * `amount`: The intensity of the filter effect, ranging from -100 to 200: | ||
| ** **0**: No effect (image stays original). | ||
| ** **0** to **100**: Gradually increases filter strength. | ||
| ** **100**: Default intensity (as the filter is designed). | ||
| ** **>100**: Exaggerates the effect. | ||
| ** **<0**: Inverts the filter effect (produces a "negative" version). | ||
| * `label`: Optional display name for the filter in your UI. If omitted, it defaults to the name. | ||
|
|
||
| === Example: Setting `uploadcare_filters` | ||
|
|
||
| [source,js] | ||
| ---- | ||
| tinymce.init({ | ||
| selector: "textarea", | ||
| plugins: 'uploadcare', | ||
| toolbar: 'uploadcare', | ||
| uploadcare_public_key: '<your-public-key>', | ||
|
|
||
| // Define available Uploadcare image filters and their intensity levels | ||
| uploadcare_filters: [ | ||
| { name: 'none' }, // No filter applied | ||
| { name: 'adaris', amount: -100 }, // Adaris with inverted effect (amount -100), label defaults to 'adaris' | ||
| { name: 'adaris', amount: -100, label: 'Vintage Fade' }, // Adaris with inverted effect (amount -100), label reads 'Vintage Fade' | ||
| { name: 'adaris', amount: 0, label: 'Base' }, // Adaris with neutral effect (amount 0), label reads 'Base' | ||
| { name: 'adaris', amount: 50, label: 'Light' }, // Adaris with light effect (amount 50), label reads 'Light' | ||
| { name: 'adaris', amount: 100, label: 'Standard' }, // Adaris with standard effect (amount 100), label reads 'Standard' | ||
| { name: 'adaris', amount: 200, label: 'Intense' }, // Adaris with intense effect (amount 200), label reads 'Intense' | ||
| { name: 'zevcen', amount: 200, label: 'Glow Boost' }, // Zevcen with intense effect (amount 200), label reads 'Glow Boost' | ||
| { name: 'galen', amount: 80, label: 'Soft Focus' }, // Galen with softening effect (amount 80), label reads 'Soft Focus' | ||
| { name: 'carris', amount: 120, label: 'Sharp Contrast' }, // Carris with high contrast (amount 120), label reads 'Sharp Contrast' | ||
| { name: 'ferand', amount: 60, label: 'Light Touch' }, // Ferand with light enhancement (amount 60), label reads 'Light Touch' | ||
| { name: 'sorahel', amount: -50, label: 'Night Mood' } // Sorahel with darkened effect (amount -50), label reads 'Night Mood' | ||
| ] | ||
| }); | ||
| ---- | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| * Filter names must be selected from the supported set: | ||
| ** `adaris`, `briaril`, `calarel`, `carris`, `cynarel`, `cyren`, `elmet`, `elonni`, `enzana`, `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`, `vevera`, `virkas`, `yedis`, `yllara`, `zatvel`, `zevcen`. | ||
| * If the amount is not set, it defaults to 100. | ||
| * Some filters may behave unpredictably outside the 0–100 range. | ||
| * Applying negative amount values inverts the filter, useful for creative effects. | ||
| ==== | ||
|
|
||
| === Uploadcare Filter Previews | ||
|
|
||
| Each image below represents a filter applied to the same source image. | ||
|
|
||
| [cols="1,1,1,1", options="header"] | ||
| |=== | ||
| |adaris |briaril |calarel |carris | ||
| |image:uploadcare/filters/cynarel.jpg[adaris] | ||
| |image:uploadcare/filters/briaril.jpg[briaril] | ||
| |image:uploadcare/filters/calarel.jpg[calarel] | ||
| |image:uploadcare/filters/carris.jpg[carris] | ||
|
|
||
| |cynarel |cyren |elmet |elonni | ||
| |image:uploadcare/filters/cynarel.jpg[cynarel] | ||
| |image:uploadcare/filters/cyren.jpg[cyren] | ||
| |image:uploadcare/filters/elmet.jpg[elmet] | ||
| |image:uploadcare/filters/elonni.jpg[elonni] | ||
|
|
||
| |enzana |erydark |fenralan |ferand | ||
| |image:uploadcare/filters/enzana.jpg[enzana] | ||
| |image:uploadcare/filters/erydark.jpg[erydark] | ||
| |image:uploadcare/filters/fenralan.jpg[fenralan] | ||
| |image:uploadcare/filters/ferand.jpg[ferand] | ||
|
|
||
| |galen |gavin |gethriel |iorill | ||
| |image:uploadcare/filters/galen.jpg[galen] | ||
| |image:uploadcare/filters/gavin.jpg[gavin] | ||
| |image:uploadcare/filters/gethriel.jpg[gethriel] | ||
| |image:uploadcare/filters/iorill.jpg[iorill] | ||
|
|
||
| |iothari |iselva |jadis |lavra | ||
| |image:uploadcare/filters/iothari.jpg[iothari] | ||
| |image:uploadcare/filters/iselva.jpg[iselva] | ||
| |image:uploadcare/filters/jadis.jpg[jadis] | ||
| |image:uploadcare/filters/lavra.jpg[lavra] | ||
|
|
||
| |misiara |namala |nerion |nethari | ||
| |image:uploadcare/filters/misiara.jpg[misiara] | ||
| |image:uploadcare/filters/namala.jpg[namala] | ||
| |image:uploadcare/filters/nerion.jpg[nerion] | ||
| |image:uploadcare/filters/nethari.jpg[nethari] | ||
|
|
||
| |pamaya |sarnar |sedis |sewen | ||
| |image:uploadcare/filters/pamaya.jpg[pamaya] | ||
| |image:uploadcare/filters/sarnar.jpg[sarnar] | ||
| |image:uploadcare/filters/sedis.jpg[sedis] | ||
| |image:uploadcare/filters/sewen.jpg[sewen] | ||
|
|
||
| |sorahel |sorlen |tarian |thellassan | ||
| |image:uploadcare/filters/sorahel.jpg[sorahel] | ||
| |image:uploadcare/filters/sorlen.jpg[sorlen] | ||
| |image:uploadcare/filters/tarian.jpg[tarian] | ||
| |image:uploadcare/filters/thellassan.jpg[thellassan] | ||
|
|
||
| |varriel |varven |vevera |virkas | ||
| |image:uploadcare/filters/varriel.jpg[varriel] | ||
| |image:uploadcare/filters/varven.jpg[varven] | ||
| |image:uploadcare/filters/vevera.jpg[vevera] | ||
| |image:uploadcare/filters/virkas.jpg[virkas] | ||
|
|
||
| |yedis |yllara |zatvel |zevcen | ||
| |image:uploadcare/filters/yedis.jpg[yedis] | ||
| |image:uploadcare/filters/yllara.jpg[yllara] | ||
| |image:uploadcare/filters/zatvel.jpg[zatvel] | ||
| |image:uploadcare/filters/zevcen.jpg[zevcen] | ||
| |=== | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.