-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11036 from ckeditor/ck/10964-rename-liststyle-lis…
…tproperties Other (list): Renames `ListStyle` plugin to `ListProperties`. Closes #10964.
- Loading branch information
Showing
33 changed files
with
256 additions
and
175 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
/** | ||
* @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved. | ||
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license | ||
*/ | ||
|
||
/** | ||
* @module list/listproperties | ||
*/ | ||
|
||
import { Plugin } from 'ckeditor5/src/core'; | ||
import ListPropertiesEditing from './listpropertiesediting'; | ||
import ListPropertiesUI from './listpropertiesui'; | ||
|
||
/** | ||
* The list properties feature. | ||
* | ||
* This is a "glue" plugin that loads the {@link module:list/listpropertiesediting~ListPropertiesEditing list properties editing feature} | ||
* and the {@link module:list/listpropertiesui~ListPropertiesUI list properties UI feature}. | ||
* | ||
* @extends module:core/plugin~Plugin | ||
*/ | ||
export default class ListProperties extends Plugin { | ||
/** | ||
* @inheritDoc | ||
*/ | ||
static get requires() { | ||
return [ ListPropertiesEditing, ListPropertiesUI ]; | ||
} | ||
|
||
/** | ||
* @inheritDoc | ||
*/ | ||
static get pluginName() { | ||
return 'ListProperties'; | ||
} | ||
} | ||
|
||
/** | ||
* The configuration of the {@link module:list/listproperties~ListProperties list properties} feature. | ||
* | ||
* This configuration controls the individual list properties. For instance, it enables or disables specific editor commands | ||
* operating on lists ({@link module:list/liststylecommand~ListStyleCommand `'listStyle'`}, | ||
* {@link module:list/liststartcommand~ListStartCommand `'listStart'`}, | ||
* {@link module:list/listreversedcommand~ListReversedCommand `'listReversed'`}), the look of the UI | ||
* (`'numberedList'` and `'bulletedList'` dropdowns), and editor data pipeline (allowed HTML attributes). | ||
* | ||
* ClassicEditor | ||
* .create( editorElement, { | ||
* list: { | ||
* properties: { | ||
* styles: true, | ||
* startIndex: true, | ||
* reversed: true | ||
* } | ||
* } | ||
* } ) | ||
* .then( ... ) | ||
* .catch( ... ); | ||
* | ||
* @interface ListPropertiesConfig | ||
*/ | ||
|
||
/** | ||
* When set, the list style feature will be enabled. It allows changing the `list-style-type` HTML attribute of the lists. | ||
* | ||
* @default true | ||
* @member {Boolean} module:list/listproperties~ListPropertiesConfig#styles | ||
*/ | ||
|
||
/** | ||
* When set, the list start index feature will be enabled. It allows changing the `start` HTML attribute of the numbered lists. | ||
* | ||
* **Note**: This configuration doesn't affect bulleted and todo lists. | ||
* | ||
* @default false | ||
* @member {Boolean} module:list/listproperties~ListPropertiesConfig#startIndex | ||
*/ | ||
|
||
/** | ||
* When set, the list reversed feature will be enabled. It allows changing the `reversed` HTML attribute of the numbered lists. | ||
* | ||
* **Note**: This configuration doesn't affect bulleted and todo lists. | ||
* | ||
* @default false | ||
* @member {Boolean} module:list/listproperties~ListPropertiesConfig#reversed | ||
*/ | ||
|
||
/** | ||
* The configuration of the {@link module:list/listproperties~ListProperties} feature. | ||
* | ||
* Read more in {@link module:list/listproperties~ListPropertiesConfig}. | ||
* | ||
* @member {module:list/listproperties~ListPropertiesConfig} module:list/list~ListConfig#properties | ||
*/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.