# code-block/utils module ## Functions ### `canBeCodeBlock( schema, element ) → boolean` _(internal)_ Checks if an [Element](module_engine_model_element-ModelElement.md) can become a code block. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-code-block/src/utils.ts#L273) #### Parameters * `schema: ModelSchema` Model's schema. * `element: ModelElement` The element to be checked. #### Returns * `boolean` Check result. ### `getCodeBlockAriaAnnouncement( t, languageDefs, element, direction ) → string` _(internal)_ Get the translated message read by the screen reader when you enter or exit an element with your cursor. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-code-block/src/utils.ts#L286) #### Parameters * `t: LocaleTranslate` * `languageDefs: Array` * `element: ModelElement` * `direction: 'enter' | 'leave'` #### Returns * `string` ### `getIndentOutdentPositions( model ) → Array` _(internal)_ Returns an array of all model positions within the selection that represent code block lines. If the selection is collapsed, it returns the exact selection anchor position: ```html []foo -> ^foo foo[]bar -> foo^bar ``` Otherwise, it returns positions **before** each text node belonging to all code blocks contained by the selection: ```html foo[bar ^foobar -> baz]qux ^bazqux ``` It also works across other non–code blocks: ```html foo[bar ^foobar text -> text baz]qux ^bazqux ``` **Note:** The positions are in reverse order so they do not get outdated when iterating over them and the writer inserts or removes elements at the same time. **Note:** The position is located after the leading white spaces in the text node. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-code-block/src/utils.ts#L207) #### Parameters * `model: Model` #### Returns * `Array` ### `getLeadingWhiteSpaces( textNode ) → string` _(internal)_ For a given model text node, it returns white spaces that precede other characters in that node. This corresponds to the indentation part of the code block line. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-code-block/src/utils.ts#L121) #### Parameters * `textNode: ModelText` #### Returns * `string` ### `getNormalizedAndLocalizedLanguageDefinitions( editor ) → Array` _(internal)_ Returns code block languages as defined in `config.codeBlock.languages` but processed: * To consider the editor localization, i.e. to display [`CodeBlockLanguageDefinition`](module_code-block_codeblockconfig-CodeBlockLanguageDefinition.md) in the correct language. There is no way to use [`t`](module_utils_locale-Locale.md#member-t) when the user configuration is defined because the editor does not exist yet. * To make sure each definition has a CSS class associated with it even if not specified in the original configuration. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-code-block/src/utils.ts#L37) #### Parameters * `editor: Editor` #### Returns * `Array` ### `getPropertyAssociation( languageDefs, key, value ) → Record` _(internal)_ Returns an object associating certain language definition properties with others. For instance: For: ```typescript const definitions = { { language: 'php', class: 'language-php', label: 'PHP' }, { language: 'javascript', class: 'js', label: 'JavaScript' }, }; getPropertyAssociation( definitions, 'class', 'language' ); ``` returns: ```typescript { 'language-php': 'php', 'js': 'javascript' } ``` and ```typescript getPropertyAssociation( definitions, 'language', 'label' ); ``` returns: ```typescript { 'php': 'PHP', 'javascript': 'JavaScript' } ``` [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-code-block/src/utils.ts#L94) #### Parameters * `languageDefs: Array` * `key: keyof CodeBlockLanguageDefinition` * `value: keyof CodeBlockLanguageDefinition` #### Returns * `Record` ### `getTextNodeAtLineStart( position, model ) → ModelText | null` _(internal)_ For given position, finds the closest position that is at the beginning of a line of code and returns a text node that is at the beginning of the line (or `null` if there's no text node at the beginning of a given line). Line beings at the start of a code block element and after each `softBreak` element. Note: even though code block doesn't allow inline elements other than `` by default, some features may overwrite this rule, so such inline elements are taken into account. Some examples of expected results: ``` ^ -> null ^foobar -> [foobar] foobar^ -> [foobar] foo^bar -> [foobar] foo^bar -> [foo]bar foobar^ -> foo[bar] foob^ar -> foo[bar] foo^bar -> foo[bar] ^ -> null ^ -> null foo^ -> [foo] foo^ -> [foo] foobar^ -> [foo]bar bar^ -> null foo^ -> null foo^ -> null foo^ -> null foobar^ -> foo[bar] fooba^r -> null ``` [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-code-block/src/utils.ts#L347) #### Parameters * `position: ModelPosition` * `model: Model` #### Returns * `ModelText | null` ### `isModelSelectionInCodeBlock( selection ) → boolean` _(internal)_ Checks if any of the blocks within the model selection is a code block. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-code-block/src/utils.ts#L259) #### Parameters * `selection: ModelDocumentSelection` #### Returns * `boolean` ### `rawSnippetTextToViewDocumentFragment( writer, text ) → ViewDocumentFragment` _(internal)_ For plain text containing the code (a snippet), it returns a document fragment containing view text nodes separated by `
` elements (in place of new line characters "\n"), for instance: Input: ```typescript "foo()\n bar()" ``` Output: ```html "foo()"
"bar()" ``` [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-code-block/src/utils.ts#L149) #### Parameters * `writer: ViewUpcastWriter` * `text: string` The raw code text to be converted. #### Returns * `ViewDocumentFragment` --- Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)