Add Track changes plugin & options

Author: jmsche

CHANGELOG-1.x.md

@@ -1,3 +1,8 @@
+1.6.0
+-----
+
+* Add Track changes plugin & options
+
 1.5.0
 -----
 

src/Form/Type/FroalaEditorType.php

@@ -82,7 +82,7 @@ public function buildView(FormView $view, FormInterface $form, array $options):
 
         $arrPlugin = $this->pluginProvider->obtainArrPluginToInclude($arrPluginEnabled, $arrPluginDisabled);
 
-        $view->vars['froala_arrOption']['pluginsEnabled'] = $this->pluginProvider->obtainArrPluginCamelized($arrPlugin);
+        $view->vars['froala_arrOption']['pluginsEnabled'] = array_map(fn (string $plugin): string => 'trackChanges' === $plugin ? 'track_changes' : $plugin, $this->pluginProvider->obtainArrPluginCamelized($arrPlugin));
         $view->vars['froala_arrPluginJS'] = $this->pluginProvider->obtainArrPluginJS($arrPlugin);
         $view->vars['froala_arrPluginCSS'] = $this->pluginProvider->obtainArrPluginCSS($arrPlugin);
         $view->vars['froala_events'] = $arrEvent;

src/Service/PluginProvider.php

@@ -48,6 +48,7 @@ final class PluginProvider
         'save'                => [self::KEY_CSS => 0, self::KEY_FOLDER => self::VALUE_PLUGINS],
         'special_characters'  => [self::KEY_CSS => 1, self::KEY_FOLDER => self::VALUE_PLUGINS],
         'table'               => [self::KEY_CSS => 1, self::KEY_FOLDER => self::VALUE_PLUGINS],
+        'track_changes'       => [self::KEY_CSS => 0, self::KEY_FOLDER => self::VALUE_PLUGINS],
         'url'                 => [self::KEY_CSS => 0, self::KEY_FOLDER => self::VALUE_PLUGINS],
         'video'               => [self::KEY_CSS => 1, self::KEY_FOLDER => self::VALUE_PLUGINS],
         'word_paste'          => [self::KEY_CSS => 0, self::KEY_FOLDER => self::VALUE_PLUGINS],

src/Utility/UConfiguration.php

@@ -67,6 +67,7 @@ final class UConfiguration
         'requestWithCredentials'         => null,
         'requestWithCORS'                => null,
         'shortcutsHint'                  => null,
+        'showChangesEnabled'             => null,
         'spellcheck'                     => null,
         'tableCellMultipleStyles'        => null,
         'tableInsertHelper'              => null,
@@ -78,6 +79,7 @@ final class UConfiguration
         'toolbarSticky'                  => null,
         'toolbarVisibleWithoutSelection' => null,
         'tooltips'                       => null,
+        'trackChangesEnabled'            => null,
         'useClasses'                     => null,
         'videoMove'                      => null,
         'videoResize'                    => null,

tests/Utility/UConfigurationTest.php

@@ -18,7 +18,7 @@ public function testAllOptionsAreRegistered(): void
             $url = 'https://froala.com/wysiwyg-editor/docs/options/';
             $httpClient = HttpClient::create();
             $crawler = new Crawler($httpClient->request('GET', $url)->getContent());
-            $optionsFromDocs = $crawler->filter('.docs-data-list.block-box a');
+            $optionsFromDocs = $crawler->filter('.docs-data-list a.searchable');
             $registeredOptions = UConfiguration::getArrOptionAll();
             $proxyOrIgnoredOptions = ['Key', 'editor'];
             $missingOptions = [];