Component', () => {
await manager.all();
await waitFor( () => {
expect( editorCreateSpy ).toHaveBeenCalledTimes( 3 );
- expect( ( editorCreateSpy.mock.calls as any )[ 1 ][ 1 ].initialData ).to.equal( 'Foo' );
- expect( ( editorCreateSpy.mock.calls as any )[ 2 ][ 1 ].initialData ).to.equal( 'Bar' );
+ expect( pickInitialDataFromCallArgs( editorCreateCalls[ 1 ] ) ).to.equal( 'Foo' );
+ expect( pickInitialDataFromCallArgs( editorCreateCalls[ 2 ] ) ).to.equal( 'Bar' );
} );
} );
} );
diff --git a/tests/integrations/usemultirooteditor-multirooteditor.test.tsx b/tests/integrations/usemultirooteditor-multirooteditor.test.tsx
index 65a2a7e6..60b4223a 100644
--- a/tests/integrations/usemultirooteditor-multirooteditor.test.tsx
+++ b/tests/integrations/usemultirooteditor-multirooteditor.test.tsx
@@ -6,7 +6,7 @@
import { describe, beforeEach, it, expect } from 'vitest';
import React from 'react';
import { render, type RenderResult } from '@testing-library/react';
-import useMultiRootEditor from '../../src/useMultiRootEditor.js';
+import { useMultiRootEditor } from '../../src/multiroot/useMultiRootEditor.js';
import { TestMultiRootEditor } from '../_utils/multirooteditor.js';
const AppUsingHooks = props => {
diff --git a/tests/useMultiRootEditor.test.tsx b/tests/multiroot/useMultiRootEditor.test.tsx
similarity index 91%
rename from tests/useMultiRootEditor.test.tsx
rename to tests/multiroot/useMultiRootEditor.test.tsx
index cc24bb04..4e45c75c 100644
--- a/tests/useMultiRootEditor.test.tsx
+++ b/tests/multiroot/useMultiRootEditor.test.tsx
@@ -7,13 +7,20 @@ import { describe, beforeEach, afterEach, it, expect, vi } from 'vitest';
import React, { useEffect } from 'react';
import { CKEditorError } from 'ckeditor5';
import { render, waitFor, renderHook, act } from '@testing-library/react';
-import useMultiRootEditor, { EditorEditable, EditorToolbarWrapper } from '../src/useMultiRootEditor.js';
-import { ContextWatchdogContext } from '../src/context/ckeditorcontext.js';
-import { timeout } from './_utils/timeout.js';
-import { createDefer } from './_utils/defer.js';
-import { createTestMultiRootWatchdog, TestMultiRootEditor } from './_utils/multirooteditor.js';
-import { turnOffErrors } from './_utils/turnOffErrors.js';
-import { ReactIntegrationUsageDataPlugin } from '../src/plugins/ReactIntegrationUsageDataPlugin.js';
+
+import { useMultiRootEditor } from '../../src/multiroot/useMultiRootEditor.js';
+import { EditorToolbarWrapper } from '../../src/multiroot/EditorToolbar.js';
+import { EditorEditable } from '../../src/multiroot/EditorEditable.js';
+
+import { ContextWatchdogContext } from '../../src/context/ckeditorcontext.js';
+import { timeout } from '../_utils/timeout.js';
+import { createDefer } from '../_utils/defer.js';
+import { createTestMultiRootWatchdog, TestMultiRootEditor } from '../_utils/multirooteditor.js';
+import { turnOffErrors } from '../_utils/turnOffErrors.js';
+import { ReactIntegrationUsageDataPlugin } from '../../src/plugins/ReactIntegrationUsageDataPlugin.js';
+import { getInstalledCKBaseFeatures, mapObjectValues } from '@ckeditor/ckeditor5-integrations-common';
+
+const SUPPORTED_FEATURES = getInstalledCKBaseFeatures();
describe( 'useMultiRootEditor', () => {
const rootsContent = {
@@ -59,25 +66,61 @@ describe( 'useMultiRootEditor', () => {
} );
describe( 'editor props', () => {
- it( 'should raise proper warning when `data` and `initialData` is passed to config at the same time', async () => {
- const spy = vi.spyOn( console, 'warn' );
+ if ( SUPPORTED_FEATURES.rootsConfigEntry ) {
+ it( 'should raise proper warning when `data` and `initialData` is passed to config at the same time', async () => {
+ const spy = vi.spyOn( console, 'warn' );
- renderHook( () => useMultiRootEditor( {
- ...editorProps,
- disableWatchdog: true,
- config: {
- ...editorProps.config,
- initialData: rootsContent
- }
- } ) );
+ renderHook( () => useMultiRootEditor( {
+ ...editorProps,
+ disableWatchdog: true,
+ config: {
+ ...editorProps.config,
+ roots: {
+ intro: {
+ initialData: 'Sample
This is an instance of the.
'
+ },
+ content: {
+ initialData: 'It is the custom content
'
+ },
+ footer: {
+ initialData: 'Footer content
'
+ }
+ }
+ }
+ } ) );
- await waitFor( () => {
- expect( spy ).toHaveBeenCalledWith(
- 'Editor data should be provided either using `config.initialData` or `data` property. ' +
- 'The config value takes precedence over `data` property and will be used when both are specified.'
- );
+ await waitFor( () => {
+ for ( const rootName of Object.keys( rootsContent ) ) {
+ expect( spy ).toHaveBeenCalledWith(
+ `Editor data should be provided either using \`config.roots['${ rootName }'].initialData\` ` +
+ 'or the bound component property. The config value takes precedence ' +
+ 'over the bound component property and will be used when both are specified.'
+ );
+ }
+ } );
} );
- } );
+ } else {
+ it( 'should raise proper warning when `data` and `initialData` is passed to config at the same time', async () => {
+ const spy = vi.spyOn( console, 'warn' );
+
+ renderHook( () => useMultiRootEditor( {
+ ...editorProps,
+ disableWatchdog: true,
+ config: {
+ ...editorProps.config,
+ initialData: rootsContent
+ }
+ } ) );
+
+ await waitFor( () => {
+ expect( spy ).toHaveBeenCalledWith(
+ 'Editor data should be provided either using `config.initialData` ' +
+ 'or the bound component property. The config value takes precedence ' +
+ 'over the bound component property and will be used when both are specified.'
+ );
+ } );
+ } );
+ }
it( 'should not crash if config property is not provided', async () => {
const { result } = renderHook( () => useMultiRootEditor( {
@@ -895,10 +938,14 @@ describe( 'useMultiRootEditor', () => {
class SlowEditor extends TestMultiRootEditor {
public declare data: any;
- constructor( initialData, config ) {
- super( initialData, config );
+ constructor( configOrData, config ) {
+ super( configOrData, config );
- let value = initialData || {};
+ let value = configOrData ?? {};
+
+ if ( SUPPORTED_FEATURES.rootsConfigEntry ) {
+ value = mapObjectValues( configOrData.roots ?? {}, ( val: any ) => val.initialData );
+ }
this.data = {
get() {
@@ -911,17 +958,17 @@ describe( 'useMultiRootEditor', () => {
};
}
- public static async create( ...args: ConstructorParameters ) {
+ public static async create( ...args: Array ) {
await deferInitialization.promise;
- return new SlowEditor( ...args );
+ return new SlowEditor( args[ 0 ], args[ 1 ] );
}
}
const { result } = renderHook( () => useMultiRootEditor( {
...editorProps,
disableWatchdog: !enableWatchdog,
- editor: SlowEditor
+ editor: SlowEditor as any
} ) );
await timeout( 500 );
@@ -954,13 +1001,13 @@ describe( 'useMultiRootEditor', () => {
class SlowEditor extends TestMultiRootEditor {
public declare key: any;
- constructor( initialData, config ) {
- super( initialData, config );
- this.key = config.key;
+ constructor( configOrData, config ) {
+ super( configOrData, config );
+ this.key = config?.key ?? configOrData.key;
}
- public static async create( ...args: ConstructorParameters ) {
- const editor = new SlowEditor( ...args );
+ public static async create( ...args: Array ) {
+ const editor = new SlowEditor( args[ 0 ], args[ 1 ] );
await editor.initPlugins();
await timeout( 300 );
diff --git a/tests/utils/assignPropsToEditorConfig.test.tsx b/tests/utils/assignPropsToEditorConfig.test.tsx
deleted file mode 100644
index 9bb21540..00000000
--- a/tests/utils/assignPropsToEditorConfig.test.tsx
+++ /dev/null
@@ -1,258 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-
-import {
- assignDataPropToSingleRootEditorConfig,
- assignMultiRootAttributesPropToEditorConfig,
- isRootsMapConfigurationSupported
-} from '../../src/utils/assignPropsToEditorConfig.js';
-
-describe( 'assignPropsToEditorConfig', () => {
- let originalVersion: string | undefined;
-
- beforeEach( () => {
- originalVersion = window.CKEDITOR_VERSION;
- } );
-
- afterEach( () => {
- window.CKEDITOR_VERSION = originalVersion as any;
- vi.restoreAllMocks();
- } );
-
- describe( 'isRootsMapConfigurationSupported()', () => {
- it( 'should return false if window.CKEDITOR_VERSION is not defined', () => {
- delete ( window as any ).CKEDITOR_VERSION;
- expect( isRootsMapConfigurationSupported() ).toBe( false );
- } );
-
- it.each( [ 'nightly', '0.0.0-nightly-20260319.0', '48.0.0', '49.0.0' ] )(
- 'should return true if window.CKEDITOR_VERSION is "%s"',
- version => {
- window.CKEDITOR_VERSION = version as any;
- expect( isRootsMapConfigurationSupported() ).toBe( true );
- }
- );
-
- it.each( [ '47.0.0', '46.0.0' ] )(
- 'should return false if window.CKEDITOR_VERSION is "%s"',
- version => {
- window.CKEDITOR_VERSION = version as any;
- expect( isRootsMapConfigurationSupported() ).toBe( false );
- }
- );
- } );
-
- describe( 'assignDataPropToSingleRootEditorConfig()', () => {
- describe( 'when roots map configuration is supported (>= 48.x)', () => {
- beforeEach( () => {
- window.CKEDITOR_VERSION = '48.0.0';
- } );
-
- it( 'should assign data to roots.main.initialData', () => {
- expect( assignDataPropToSingleRootEditorConfig( {}, 'foo' ) ).toEqual( {
- roots: { main: { initialData: 'foo' } }
- } );
- } );
-
- it( 'should fallback to empty string if no data is provided', () => {
- expect( assignDataPropToSingleRootEditorConfig( {}, undefined ) ).toEqual( {
- roots: { main: { initialData: '' } }
- } );
- } );
-
- it( 'should prefer config.roots.main.initialData over data and show a warning', () => {
- const warnSpy = vi.spyOn( console, 'warn' ).mockImplementation( () => {} );
-
- expect( assignDataPropToSingleRootEditorConfig( { roots: { main: { initialData: 'config-data' } } }, 'foo' ) ).toEqual( {
- roots: { main: { initialData: 'config-data' } }
- } );
-
- expect( warnSpy ).toHaveBeenCalledOnce();
- } );
-
- it( 'should prefer config.root.initialData over data and show a warning', () => {
- const warnSpy = vi.spyOn( console, 'warn' ).mockImplementation( () => {} );
-
- expect( assignDataPropToSingleRootEditorConfig( { root: { initialData: 'config-data' } }, 'foo' ) ).toEqual( {
- roots: { main: { initialData: 'config-data' } }
- } );
-
- expect( warnSpy ).toHaveBeenCalledOnce();
- } );
-
- it( 'should prefer config.roots.main.initialData over config.root.initialData', () => {
- expect( assignDataPropToSingleRootEditorConfig(
- { root: { initialData: 'root-data' }, roots: { main: { initialData: 'main-root-data' } } },
- 'foo'
- ) ).toEqual( {
- roots: { main: { initialData: 'main-root-data' } }
- } );
- } );
- } );
-
- describe( 'when roots map configuration is not supported (<= 47.x)', () => {
- beforeEach( () => {
- window.CKEDITOR_VERSION = '47.0.0';
- } );
-
- it( 'should assign data to initialData', () => {
- expect( assignDataPropToSingleRootEditorConfig( {}, 'foo' ) ).toEqual( {
- initialData: 'foo'
- } );
- } );
-
- it( 'should fallback to empty string if no data is provided', () => {
- expect( assignDataPropToSingleRootEditorConfig( {}, undefined ) ).toEqual( {
- initialData: ''
- } );
- } );
-
- it( 'should prefer config.initialData over data and show a warning', () => {
- const warnSpy = vi.spyOn( console, 'warn' ).mockImplementation( () => {} );
-
- expect( assignDataPropToSingleRootEditorConfig( { initialData: 'config-data' }, 'foo' ) ).toEqual( {
- initialData: 'config-data'
- } );
-
- expect( warnSpy ).toHaveBeenCalledOnce();
- } );
- } );
- } );
-
- describe( 'assignMultiRootAttributesPropToEditorConfig()', () => {
- describe( 'when roots map configuration is supported (>= 48.x)', () => {
- beforeEach( () => {
- window.CKEDITOR_VERSION = '48.0.0';
- } );
-
- it( 'should assign attributes to roots[rootName].modelAttributes', () => {
- expect( assignMultiRootAttributesPropToEditorConfig( {}, {
- intro: { order: 1 },
- outro: { order: 2 }
- } ) ).toEqual( {
- roots: {
- intro: { modelAttributes: { order: 1 } },
- outro: { modelAttributes: { order: 2 } }
- }
- } );
- } );
-
- it( 'should set modelAttributes to empty object when no attributes are provided', () => {
- expect( assignMultiRootAttributesPropToEditorConfig( {
- roots: { intro: { initialData: 'hello' } }
- }, undefined ) ).toEqual( {
- roots: {
- intro: { initialData: 'hello', modelAttributes: {} }
- }
- } );
- } );
-
- it( 'should merge attributes with existing config.roots properties', () => {
- expect( assignMultiRootAttributesPropToEditorConfig( {
- roots: { intro: { initialData: 'hello' } }
- }, {
- intro: { order: 1 }
- } ) ).toEqual( {
- roots: {
- intro: { initialData: 'hello', modelAttributes: { order: 1 } }
- }
- } );
- } );
-
- it( 'should prefer passed attributes over config.roots[rootName].modelAttributes', () => {
- expect( assignMultiRootAttributesPropToEditorConfig( {
- roots: { intro: { modelAttributes: { order: 99 } } }
- }, {
- intro: { order: 1 }
- } ) ).toEqual( {
- roots: {
- intro: { modelAttributes: { order: 1 } }
- }
- } );
- } );
-
- it( 'should fall back to config.roots[rootName].modelAttributes when no attributes entry for that root', () => {
- expect( assignMultiRootAttributesPropToEditorConfig( {
- roots: { intro: { modelAttributes: { order: 5 } } }
- }, {} ) ).toEqual( {
- roots: {
- intro: { modelAttributes: { order: 5 } }
- }
- } );
- } );
-
- it( 'should include roots from attributes that are absent in config.roots', () => {
- const result = assignMultiRootAttributesPropToEditorConfig( {
- roots: { intro: { initialData: 'a' } }
- }, {
- intro: { order: 1 },
- outro: { order: 2 }
- } ) as any;
-
- expect( result.roots ).toHaveProperty( 'intro' );
- expect( result.roots ).toHaveProperty( 'outro' );
- expect( result.roots.outro ).toEqual( { modelAttributes: { order: 2 } } );
- } );
-
- it( 'should include roots from config.roots that are absent in attributes', () => {
- const result = assignMultiRootAttributesPropToEditorConfig( {
- roots: {
- intro: { initialData: 'a' },
- outro: { initialData: 'b' }
- }
- }, {
- intro: { order: 1 }
- } ) as any;
-
- expect( result.roots ).toHaveProperty( 'intro' );
- expect( result.roots ).toHaveProperty( 'outro' );
- expect( result.roots.outro ).toEqual( { initialData: 'b', modelAttributes: {} } );
- } );
-
- it( 'should preserve other config properties alongside roots', () => {
- const result = assignMultiRootAttributesPropToEditorConfig( {
- language: 'pl',
- roots: { intro: {} }
- }, { intro: { order: 1 } } ) as any;
-
- expect( result.language ).toBe( 'pl' );
- } );
- } );
-
- describe( 'when roots map configuration is not supported (<= 47.x)', () => {
- beforeEach( () => {
- window.CKEDITOR_VERSION = '47.0.0';
- } );
-
- it( 'should assign attributes to rootsAttributes', () => {
- const attributes = {
- intro: { order: 1 },
- outro: { order: 2 }
- };
-
- expect( assignMultiRootAttributesPropToEditorConfig( {}, attributes ) ).toEqual( {
- rootsAttributes: attributes
- } );
- } );
-
- it( 'should assign undefined to rootsAttributes when no attributes are provided', () => {
- expect( assignMultiRootAttributesPropToEditorConfig( {} ) ).toEqual( {
- rootsAttributes: undefined
- } );
- } );
-
- it( 'should preserve other config properties alongside rootsAttributes', () => {
- const result = assignMultiRootAttributesPropToEditorConfig( {
- language: 'pl'
- }, { intro: { order: 1 } } ) as any;
-
- expect( result.language ).toBe( 'pl' );
- expect( result.rootsAttributes ).toEqual( { intro: { order: 1 } } );
- } );
- } );
- } );
-} );