installConfig('filter_test'); $editor = Editor::create([ 'editor' => 'ckeditor5', 'format' => 'filter_test', 'image_upload' => ['status' => FALSE], ]); $editor->save(); /** @var array{toolbar: array{items: array}} $settings */ $settings = Editor::load('filter_test')?->getSettings(); $this->assertSame(['heading', 'bold', 'italic'], $settings['toolbar']['items']); } /** * Tests add item to toolbar. * * @param string|array $action * The value to pass to the config action. * @param string[] $expected_toolbar_items * The items which should be in the editor toolbar, in the expected order. */ #[TestWith(["sourceEditing", ["heading", "bold", "italic", "sourceEditing"]])] #[TestWith([["item_name" => "sourceEditing"], ["heading", "bold", "italic", "sourceEditing"]])] #[TestWith([["item_name" => "sourceEditing", "position" => 1], ["heading", "sourceEditing", "bold", "italic"]])] #[TestWith([ ["item_name" => "sourceEditing", "position" => 1, "replace" => TRUE], ["heading", "sourceEditing", "italic"], ])] #[TestWith([["item_name" => "bold"], ["heading", "bold", "italic"]])] #[TestWith([["item_name" => "bold", "allow_duplicate" => TRUE], ["heading", "bold", "italic", "bold"]])] public function testAddItemToToolbar(string|array $action, array $expected_toolbar_items): void { $recipe = $this->createRecipe([ 'name' => 'CKEditor 5 toolbar item test', 'config' => [ 'actions' => [ 'editor.editor.filter_test' => [ 'addItemToToolbar' => $action, ], ], ], ]); RecipeRunner::processRecipe($recipe); /** @var array{toolbar: array{items: string[]}, plugins: array>} $settings */ $settings = Editor::load('filter_test')?->getSettings(); $this->assertSame($expected_toolbar_items, $settings['toolbar']['items']); // The plugin's default settings should have been added. if (in_array('sourceEditing', $expected_toolbar_items, TRUE)) { $this->assertSame([], $settings['plugins']['ckeditor5_sourceEditing']['allowed_tags']); } } /** * Tests that adding non-existent toolbar item to CKEditor triggers an error. */ public function testAddNonExistentItem(): void { $recipe = $this->createRecipe([ 'name' => 'Add an invalid toolbar item', 'config' => [ 'actions' => [ 'editor.editor.filter_test' => [ 'addItemToToolbar' => 'bogus_item', ], ], ], ]); $this->expectException(InvalidConfigException::class); $this->expectExceptionMessage("There were validation errors in editor.editor.filter_test:\n- settings.toolbar.items.3: The provided toolbar item bogus_item is not valid."); RecipeRunner::processRecipe($recipe); } /** * Tests that the `addItemToToolbar` config action requires CKEditor 5. */ public function testActionRequiresCKEditor5(): void { $this->enableModules(['editor_test']); Editor::load('filter_test')?->setEditor('unicorn')->setSettings([])->save(); $recipe = <<expectException(ConfigActionException::class); $this->expectExceptionMessage('The editor:addItemToToolbar config action only works with editors that use CKEditor 5.'); RecipeRunner::processRecipe($this->createRecipe($recipe)); } }