Przeglądaj źródła

Added heading UI buttons to the Common API section in the docs guide.

Kamil Piechaczek 5 lat temu
rodzic
commit
8c00768f69

+ 11 - 0
packages/ckeditor5-heading/docs/features/headings.md

@@ -212,6 +212,17 @@ The {@link module:heading/heading~Heading} plugin registers:
 	```js
 	```js
 	editor.execute( 'heading', { value: 'heading2' } );
 	editor.execute( 'heading', { value: 'heading2' } );
 	```
 	```
+ 
+The {@link module:heading/headingbuttonsui~HeadingButtonsUI} plugin registers 6 UI button components that will execute the `'heading'` command with the proper value of the `value` attribute:
+
+1. `'heading1'`
+2. `'heading2'`
+3. `'heading3'`
+4. `'heading4'`
+5. `'heading5'`
+6. `'heading6'`
+    
+The {@link module:paragraph/paragraphbuttonui~ParagraphButtonUI} plugin registers the UI button component: `'paragraph'`.
 
 
 <info-box>
 <info-box>
 	We recommend using the official {@link framework/guides/development-tools#ckeditor-5-inspector CKEditor 5 inspector} for development and debugging. It will give you tons of useful information about the state of the editor such as internal data structures, selection, commands, and many more.
 	We recommend using the official {@link framework/guides/development-tools#ckeditor-5-inspector CKEditor 5 inspector} for development and debugging. It will give you tons of useful information about the state of the editor such as internal data structures, selection, commands, and many more.

+ 1 - 1
packages/ckeditor5-paragraph/src/paragraphbuttonui.js

@@ -12,7 +12,7 @@ import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
 import icon from '../theme/icons/paragraph.svg';
 import icon from '../theme/icons/paragraph.svg';
 
 
 /**
 /**
- * This plugin defines the `'paragraphs'` button. It can be used together with
+ * This plugin defines the `'paragraph'` button. It can be used together with
  * {@link module:heading/headingbuttonsui~HeadingButtonsUI} to replace the standard heading dropdown.
  * {@link module:heading/headingbuttonsui~HeadingButtonsUI} to replace the standard heading dropdown.
  *
  *
  * This plugin is not loaded automatically by the {@link module:paragraph/paragraph~Paragraph} plugin. It must
  * This plugin is not loaded automatically by the {@link module:paragraph/paragraph~Paragraph} plugin. It must