From 137c5c27cd8f575b085ccbaa5dc174e9d72e6e34 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Thu, 13 Mar 2025 19:02:10 +0200 Subject: [PATCH] refactor(admonitions): more references to blockquote --- packages/ckeditor5-admonition/package.json | 4 ++-- .../ckeditor5-admonition/src/admonition.ts | 2 +- .../src/admonitioncommand.ts | 2 +- .../src/admonitionediting.ts | 18 +++++++++--------- .../ckeditor5-admonition/src/admonitionui.ts | 12 ++++++------ .../ckeditor5-admonition/src/augmentation.ts | 2 +- packages/ckeditor5-admonition/src/index.ts | 2 +- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/packages/ckeditor5-admonition/package.json b/packages/ckeditor5-admonition/package.json index ef9ac3093..7b40a6921 100644 --- a/packages/ckeditor5-admonition/package.json +++ b/packages/ckeditor5-admonition/package.json @@ -1,5 +1,5 @@ { - "name": "@ckeditor/ckeditor5-block-quote", + "name": "@ckeditor/ckeditor5-admonition", "version": "43.2.0", "description": "Block quote feature for CKEditor 5.", "keywords": [ @@ -42,7 +42,7 @@ "repository": { "type": "git", "url": "https://github.com/ckeditor/ckeditor5.git", - "directory": "packages/ckeditor5-block-quote" + "directory": "packages/ckeditor5-admonition" }, "files": [ "dist", diff --git a/packages/ckeditor5-admonition/src/admonition.ts b/packages/ckeditor5-admonition/src/admonition.ts index c19919ad6..7c5fcc123 100644 --- a/packages/ckeditor5-admonition/src/admonition.ts +++ b/packages/ckeditor5-admonition/src/admonition.ts @@ -4,7 +4,7 @@ */ /** - * @module block-quote/blockquote + * @module admonition/admonition */ import { Plugin } from 'ckeditor5/src/core.js'; diff --git a/packages/ckeditor5-admonition/src/admonitioncommand.ts b/packages/ckeditor5-admonition/src/admonitioncommand.ts index d2ae120bf..543161730 100644 --- a/packages/ckeditor5-admonition/src/admonitioncommand.ts +++ b/packages/ckeditor5-admonition/src/admonitioncommand.ts @@ -4,7 +4,7 @@ */ /** - * @module block-quote/blockquotecommand + * @module admonition/admonitioncommand */ import { Command } from 'ckeditor5/src/core.js'; diff --git a/packages/ckeditor5-admonition/src/admonitionediting.ts b/packages/ckeditor5-admonition/src/admonitionediting.ts index dda985dfc..7f8c16077 100644 --- a/packages/ckeditor5-admonition/src/admonitionediting.ts +++ b/packages/ckeditor5-admonition/src/admonitionediting.ts @@ -4,7 +4,7 @@ */ /** - * @module block-quote/blockquoteediting + * @module admonition/admonitionediting */ import { Plugin } from 'ckeditor5/src/core.js'; @@ -42,13 +42,13 @@ export default class AdmonitionEditing extends Plugin { const editor = this.editor; const schema = editor.model.schema; - editor.commands.add( 'blockQuote', new AdmonitionCommand( editor ) ); + editor.commands.add( 'admonition', new AdmonitionCommand( editor ) ); - schema.register( 'blockQuote', { + schema.register( 'admonition', { inheritAllFrom: '$container' } ); - editor.conversion.elementToElement( { model: 'blockQuote', view: 'blockquote' } ); + editor.conversion.elementToElement( { model: 'blockQuote', view: 'admonition' } ); // Postfixer which cleans incorrect model states connected with block quotes. editor.model.document.registerPostFixer( writer => { @@ -105,19 +105,19 @@ export default class AdmonitionEditing extends Plugin { const viewDocument = this.editor.editing.view.document; const selection = editor.model.document.selection; - const blockQuoteCommand: AdmonitionCommand = editor.commands.get( 'blockQuote' )!; + const admonitionCommand: AdmonitionCommand = editor.commands.get( 'admonition' )!; // Overwrite default Enter key behavior. // If Enter key is pressed with selection collapsed in empty block inside a quote, break the quote. this.listenTo( viewDocument, 'enter', ( evt, data ) => { - if ( !selection.isCollapsed || !blockQuoteCommand.value ) { + if ( !selection.isCollapsed || !admonitionCommand.value ) { return; } const positionParent = selection.getLastPosition()!.parent; if ( positionParent.isEmpty ) { - editor.execute( 'blockQuote' ); + editor.execute( 'admonition' ); editor.editing.view.scrollToTheSelection(); data.preventDefault(); @@ -128,14 +128,14 @@ export default class AdmonitionEditing extends Plugin { // Overwrite default Backspace key behavior. // If Backspace key is pressed with selection collapsed in first empty block inside a quote, break the quote. this.listenTo( viewDocument, 'delete', ( evt, data ) => { - if ( data.direction != 'backward' || !selection.isCollapsed || !blockQuoteCommand!.value ) { + if ( data.direction != 'backward' || !selection.isCollapsed || !admonitionCommand!.value ) { return; } const positionParent = selection.getLastPosition()!.parent; if ( positionParent.isEmpty && !positionParent.previousSibling ) { - editor.execute( 'blockQuote' ); + editor.execute( 'admonition' ); editor.editing.view.scrollToTheSelection(); data.preventDefault(); diff --git a/packages/ckeditor5-admonition/src/admonitionui.ts b/packages/ckeditor5-admonition/src/admonitionui.ts index 88133369e..7c5a89641 100644 --- a/packages/ckeditor5-admonition/src/admonitionui.ts +++ b/packages/ckeditor5-admonition/src/admonitionui.ts @@ -4,7 +4,7 @@ */ /** - * @module block-quote/blockquoteui + * @module admonition/admonitionui */ import { Plugin, icons } from 'ckeditor5/src/core.js'; @@ -15,7 +15,7 @@ import '../theme/blockquote.css'; /** * The block quote UI plugin. * - * It introduces the `'blockQuote'` button. + * It introduces the `'admonition'` button. * * @extends module:core/plugin~Plugin */ @@ -33,7 +33,7 @@ export default class AdmonitionUI extends Plugin { public init(): void { const editor = this.editor; - editor.ui.componentFactory.add( 'blockQuote', () => { + editor.ui.componentFactory.add( 'admonition', () => { const buttonView = this._createButton( ButtonView ); buttonView.set( { @@ -43,7 +43,7 @@ export default class AdmonitionUI extends Plugin { return buttonView; } ); - editor.ui.componentFactory.add( 'menuBar:blockQuote', () => { + editor.ui.componentFactory.add( 'menuBar:admonition', () => { const buttonView = this._createButton( MenuBarMenuListItemButtonView ); buttonView.set( { @@ -60,7 +60,7 @@ export default class AdmonitionUI extends Plugin { private _createButton( ButtonClass: T ): InstanceType { const editor = this.editor; const locale = editor.locale; - const command = editor.commands.get( 'blockQuote' )!; + const command = editor.commands.get( 'admonition' )!; const view = new ButtonClass( editor.locale ) as InstanceType; const t = locale.t; @@ -75,7 +75,7 @@ export default class AdmonitionUI extends Plugin { // Execute the command. this.listenTo( view, 'execute', () => { - editor.execute( 'blockQuote' ); + editor.execute( 'admonition' ); editor.editing.view.focus(); } ); diff --git a/packages/ckeditor5-admonition/src/augmentation.ts b/packages/ckeditor5-admonition/src/augmentation.ts index 4a094038c..5bf87e70e 100644 --- a/packages/ckeditor5-admonition/src/augmentation.ts +++ b/packages/ckeditor5-admonition/src/augmentation.ts @@ -18,6 +18,6 @@ declare module '@ckeditor/ckeditor5-core' { } interface CommandsMap { - blockQuote: AdmonitionCommand; + admonition: AdmonitionCommand; } } diff --git a/packages/ckeditor5-admonition/src/index.ts b/packages/ckeditor5-admonition/src/index.ts index cb11f5db1..56b7ade58 100644 --- a/packages/ckeditor5-admonition/src/index.ts +++ b/packages/ckeditor5-admonition/src/index.ts @@ -4,7 +4,7 @@ */ /** - * @module block-quote + * @module admonition */ export { default as Admonition } from './admonition.js';