Typescript Error—block editor custom icon

[ChristopherChudzicki]

📝 Provide detailed reproduction steps (if any)

Using v40.0.0 of ckeditor:

import type { EditorConfig } from "@ckeditor/ckeditor5-core"
import { BlockToolbar } from "@ckeditor/ckeditor5-ui"

// Not functional editor config, just showing TS error 
const config: EditorConfig = {
  plugins: [BlockToolbar],
  blockToolbar: {
    items: [],
    icon: "plus", // Typescript error
  },
}

✔️ Expected result

Assigning icon to blockToolbar should not raise an error. The docs show it off, and it works. https://ckeditor.com/docs/ckeditor5/latest/features/toolbar/blocktoolbar.html#configuration

Before the v40.0.0 release of CKEditor 5, the block toolbar used the pilcrow icon (¶) as a handle. This was changed to braille pattern dots icon Drag indicator as a default. If you want to use a different icon, you can configure it easily, for example:

❌ Actual result

Assigning icon to blockToolbar raises a Typescript error:

Type '{ items: string[]; icon: string; }' is not assignable to type 'ToolbarConfig | undefined'.
  Object literal may only specify known properties, and 'icon' does not exist in type 'ToolbarConfig'.

❓ Possible solution

Maybe add icon?: string to the declaration at

ckeditor5/packages/ckeditor5-core/src/editor/editorconfig.ts

Lines 580 to 584 in 46c6595

	export type ToolbarConfig = Array<ToolbarConfigItem> | {
	items?: Array<ToolbarConfigItem>;
	removeItems?: Array<string>;
	shouldNotGroupWhenFull?: boolean;
	};

, though that might allow icon in other places that it isn't actually used (not a huge problem, imo).

📃 Other details

• 🙏 🙏🙏 Thank you for recent TS conversion 🎉
• And for the ability to customize toolbar icon!

---

If you'd like to see this fixed sooner, add a 👍 reaction to this post.

[godai78]

Please ping me once this is done to update the user guide.

[arkflpc]

Icons are allowed in top-level toolbar since #14646. We didn't update the config. If we hadn't had the evil Object.assign here, we could have spotted the error earlier.

[arkflpc]

ping @godai78