Bladeren bron

More docs.

Szymon Kupś 7 jaren geleden
bovenliggende
commit
1c027b9893
2 gewijzigde bestanden met toevoegingen van 8 en 1 verwijderingen
  1. 2 0
      packages/ckeditor5-heading/src/heading.js
  2. 6 1
      packages/ckeditor5-heading/src/headingbuttonsui.js

+ 2 - 0
packages/ckeditor5-heading/src/heading.js

@@ -111,4 +111,6 @@ export default class Heading extends Plugin {
  * @property {module:engine/view/elementdefinition~ElementDefinition} view Definition of a view element to convert from/to.
  * @property {String} title The user-readable title of the option.
  * @property {String} class The class which will be added to the dropdown item representing this option.
+ * @property {Sting} [icon] Icon used by {@link module:heading/headingbuttonsui~HeadingsButtonUI}. It is optional when using
+ * standard configuration and can be omitted.
  */

+ 6 - 1
packages/ckeditor5-heading/src/headingbuttonsui.js

@@ -20,7 +20,12 @@ const defaultIcons = {
 };
 
 /**
- * TODO: description
+ * HeadingButtonsUI class creates set of UI buttons that can be used instead of drop down component.
+ * It is not enabled by default when using {@link module:heading/heading~Heading heading plugin}, and need to be
+ * added manually to the editor configuration.
+ *
+ * It uses `icon` config option provided in {@link module:heading/heading~HeadingOption}. For the default configuration
+ * standard icons are used.
  *
  * @extends module:core/plugin~Plugin
  */