@ckeditor/ckeditor5-core 43.0.0 → 43.1.0-alpha.0

package/dist/editor/editorconfig.d.ts

@@ -846,6 +846,47 @@ export interface EditorConfig {
      *   (when {@link module:merge-fields/mergefieldsconfig~MergeFieldsConfig#previewHtmlValues `previewHtmlValues`} flag is set).
      */
     sanitizeHtml?: (html: string) => SanitizedOutput;
+    /**
+     * Label text for the `aria-label` attribute set on editor editing area. Used by assistive technologies
+     * to tell apart multiple editor instances (editing areas) on the page. If not set, a default
+     * "Rich Text Editor. Editing area [name of the area]" is used instead.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( document.querySelector( '#editor' ), {
+     * 		label: 'My editor'
+     * 	} )
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     *
+     * If your editor implementation uses multiple roots, you should pass an object with keys corresponding to the editor
+     * roots names and values equal to the label that should be used for each root:
+     *
+     * ```ts
+     * MultiRootEditor.create(
+     * 	// Roots for the editor:
+     * 	{
+     * 		header: document.querySelector( '#header' ),
+     * 		content: document.querySelector( '#content' ),
+     * 		leftSide: document.querySelector( '#left-side' ),
+     * 		rightSide: document.querySelector( '#right-side' )
+     * 	},
+     * 	// Config:
+     * 	{
+     * 		label: {
+     * 			header: 'Header label',
+     * 			content: 'Content label',
+     * 			leftSide: 'Left side label',
+     * 			rightSide: 'Right side label'
+     * 		}
+     * 	}
+     * )
+     * .then( ... )
+     * .catch( ... );
+     * ```
+     */
+    label?: string | Record<string, string>;
 }
 /**
  * The `config.initialData` option cannot be used together with the initial data passed as the first parameter of

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-core",
-  "version": "43.0.0",
+  "version": "43.1.0-alpha.0",
   "description": "The core architecture of CKEditor 5 – the best browser-based rich text editor.",
   "keywords": [
     "wysiwyg",
@@ -24,9 +24,9 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-engine": "43.0.0",
-    "@ckeditor/ckeditor5-utils": "43.0.0",
-    "@ckeditor/ckeditor5-watchdog": "43.0.0",
+    "@ckeditor/ckeditor5-engine": "43.1.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "43.1.0-alpha.0",
+    "@ckeditor/ckeditor5-watchdog": "43.1.0-alpha.0",
     "lodash-es": "4.17.21"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/editor/editorconfig.d.ts

@@ -842,6 +842,47 @@ export interface EditorConfig {
      *   (when {@link module:merge-fields/mergefieldsconfig~MergeFieldsConfig#previewHtmlValues `previewHtmlValues`} flag is set).
      */
     sanitizeHtml?: (html: string) => SanitizedOutput;
+    /**
+     * Label text for the `aria-label` attribute set on editor editing area. Used by assistive technologies
+     * to tell apart multiple editor instances (editing areas) on the page. If not set, a default
+     * "Rich Text Editor. Editing area [name of the area]" is used instead.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( document.querySelector( '#editor' ), {
+     * 		label: 'My editor'
+     * 	} )
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     *
+     * If your editor implementation uses multiple roots, you should pass an object with keys corresponding to the editor
+     * roots names and values equal to the label that should be used for each root:
+     *
+     * ```ts
+     * MultiRootEditor.create(
+     * 	// Roots for the editor:
+     * 	{
+     * 		header: document.querySelector( '#header' ),
+     * 		content: document.querySelector( '#content' ),
+     * 		leftSide: document.querySelector( '#left-side' ),
+     * 		rightSide: document.querySelector( '#right-side' )
+     * 	},
+     * 	// Config:
+     * 	{
+     * 		label: {
+     * 			header: 'Header label',
+     * 			content: 'Content label',
+     * 			leftSide: 'Left side label',
+     * 			rightSide: 'Right side label'
+     * 		}
+     * 	}
+     * )
+     * .then( ... )
+     * .catch( ... );
+     * ```
+     */
+    label?: string | Record<string, string>;
 }
 /**
  * The `config.initialData` option cannot be used together with the initial data passed as the first parameter of