@ckeditor/ckeditor5-case-change/dist/casechange.d.ts

Case change feature for CKEditor 5.

/**
* @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
*/
/**
* @module case-change/casechange
* @publicApi
*/
import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
import { CaseChangeEditing } from "./casechangeediting.js";
import { CaseChangeUI } from "./casechangeui.js";
/**
* The case change feature.
*
* For a detailed overview, check the {@glink features/case-change Case change} feature guide.
*/
export declare class CaseChange extends Plugin {
	/**
	* @inheritDoc
	*/
	static get requires(): PluginDependenciesOf<[CaseChangeEditing, CaseChangeUI]>;
	/**
	* @inheritDoc
	*/
	static get pluginName(): "CaseChange";
	/**
	* @inheritDoc
	*/
	static override get isOfficialPlugin(): true;
	/**
	* @inheritDoc
	*/
	static override get isPremiumPlugin(): true;
}
/**
* The configuration of the {@link module:case-change/casechange~CaseChange case change feature}.
*
* ```ts
* ClassicEditor
* 	.create( {
* 		caseChange:  ... // Case change feature configuration.
* 	} )
* 	.then( /* ... *\/ )
* 	.catch( /* ... *\/ );
* ```
*
* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
*/
export interface CaseChangeConfig {
	/**
	* Title case configuration.
	*/
	titleCase?: CaseChangeTitleCaseConfig;
}
/**
* Title case configuration.
* It allows setting words that should not be capitalized when formatted as title case.
*
* ```ts
* ClassicEditor
* 	.create( {
* 		caseChange: {
* 			titleCase {
*				excludeWords: [ 'a', 'an', 'the' ]
* 			}
*		}
* 	} )
* 	.then( /* ... *\/ )
* 	.catch( /* ... *\/ );
* ```
*
* ```ts
* ClassicEditor
* 	.create( {
* 		caseChange: {
*			titleCase {
*				excludeWords: ( word ) => [ 'a', 'an', 'the' ].includes( word )
* 			}
*		}
* 	} )
* 	.then( /* ... *\/ )
* 	.catch( /* ... *\/ );
* ```
*
* ```ts
* ClassicEditor
* 	.create( {
* 		caseChange: {
*			titleCase {
*				excludeWords: ( word, { wordIndex } ) => wordIndex > 0 && [ 'a', 'an', 'the' ].includes( word )
* 			}
*		}
* 	} )
* 	.then( /* ... *\/ )
* 	.catch( /* ... *\/ );
* ```
*
* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
*/
export interface CaseChangeTitleCaseConfig {
	/**
	* Words which should not be capitalized.
	*/
	excludeWords?: Array<string> | CaseChangeExcludeWordsCallback;
}
/**
* The exclude word callback.
*/
export type CaseChangeExcludeWordsCallback = (word: string, context: CaseChangeExcludeWordsCallbackContext) => boolean;
/**
* The exclude word callback context.
*/
export interface CaseChangeExcludeWordsCallbackContext {
	/**
	* The offset in the text where the given word starts.
	*/
	charOffset: number;
	/**
	* The word index in the given text.
	*/
	wordIndex: number;
	/**
	* The block text.
	*/
	blockText: string;
}