@ckeditor/ckeditor5-list
Version:
Ordered and unordered lists feature to CKEditor 5.
53 lines (52 loc) • 1.82 kB
JavaScript
/**
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
import { Plugin } from 'ckeditor5/src/core.js';
import { getListTypeFromListStyleType, getSelectedListItems, getSiblingNodes } from './legacyutils.js';
/**
* A set of helpers related to legacy lists.
*/
export default class LegacyListUtils extends Plugin {
/**
* @inheritDoc
*/
static get pluginName() {
return 'LegacyListUtils';
}
/**
* @inheritDoc
*/
static get isOfficialPlugin() {
return true;
}
/**
* Checks whether the given list-style-type is supported by numbered or bulleted list.
*/
getListTypeFromListStyleType(listStyleType) {
return getListTypeFromListStyleType(listStyleType);
}
/**
* Returns an array with all `listItem` elements in the model selection.
*
* It returns all the items even if only a part of the list is selected, including items that belong to nested lists.
* If no list is selected, it returns an empty array.
* The order of the elements is not specified.
*/
getSelectedListItems(model) {
return getSelectedListItems(model);
}
/**
* Returns an array with all `listItem` elements that represent the same list.
*
* It means that values of `listIndent`, `listType`, `listStyle`, `listReversed` and `listStart` for all items are equal.
*
* Additionally, if the `position` is inside a list item, that list item will be returned as well.
*
* @param position Starting position.
* @param direction Walking direction.
*/
getSiblingNodes(position, direction) {
return getSiblingNodes(position, direction);
}
}