8
0
Просмотр исходного кода

Add docs about commands for editing plugins.

Maciej Gołaszewski 5 лет назад
Родитель
Сommit
a22ff8f383

+ 8 - 0
packages/ckeditor5-table/src/tablecellproperties/tablecellpropertiesediting.js

@@ -35,6 +35,14 @@ import TableCellBorderWidthCommand from './commands/tablecellborderwidthcommand'
  * - horizontal and vertical alignment: `horizontalAlignment`, `verticalAlignment`
  * - cell width & height: `width` & `height`
  *
+ * It also registers commands used to manipulate the above attributes:
+ *
+ * - border: `'tableCellBorderStyle'`, `'tableCellBorderColor'` and `'tableCellBorderWidth'` commands
+ * - background color: `'tableCellBackgroundColor'`
+ * - cell padding: `'tableCellPadding'`
+ * - horizontal and vertical alignment: `'tableCellHorizontalAlignment'`, `'tableCellVerticalAlignment'`
+ * - width & height: `'tableCellWidth'` & `'tableCellHeight'`
+ *
  * @extends module:core/plugin~Plugin
  */
 export default class TableCellPropertiesEditing extends Plugin {

+ 14 - 0
packages/ckeditor5-table/src/tableproperties/tablepropertiesediting.js

@@ -24,6 +24,20 @@ import TableAlignmentCommand from './commands/tablealignmentcommand';
 /**
  * The table properties editing feature.
  *
+ * Introduces table's model attributes and their conversion:
+ *
+ * - border: `borderStyle`, `borderColor` and `borderWidth`
+ * - background color: `backgroundColor`
+ * - horizontal alignment: `alignment`
+ * - width & height: `width` & `height`
+ *
+ * It also registers commands used to manipulate the above attributes:
+ *
+ * - border: `'tableBorderStyle'`, `'tableBorderColor'` and `'tableBorderWidth'` commands
+ * - background color: `'tableBackgroundColor'`
+ * - horizontal alignment: `'tableAlignment'`
+ * - width & height: `'tableWidth'` & `'tableHeight'`
+ *
  * @extends module:core/plugin~Plugin
  */
 export default class TablePropertiesEditing extends Plugin {