ckeditor/ckeditor5-paragraph

View on GitHub
src/paragraphbuttonui.js

Summary

Maintainability
A
0 mins
Test Coverage
/**
 * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
 */

/**
 * @module paragraph/paragraphbuttonui
 */

import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
import icon from '../theme/icons/paragraph.svg';

/**
 * This plugin defines the `'paragraphs'` button. It can be used together with
 * {@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
 * be added manually.
 *
 *        ClassicEditor
 *            .create( {
 *                plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
 *                toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
 *            } )
 *            .then( ... )
 *            .catch( ... );
 *
 * @extends module:core/plugin~Plugin
 */
export default class ParagraphButtonUI extends Plugin {
    init() {
        const editor = this.editor;
        const t = editor.t;

        editor.ui.componentFactory.add( 'paragraph', locale => {
            const view = new ButtonView( locale );
            const command = editor.commands.get( 'paragraph' );

            view.label = t( 'Paragraph' );
            view.icon = icon;
            view.tooltip = true;
            view.isToggleable = true;
            view.bind( 'isEnabled' ).to( command );
            view.bind( 'isOn' ).to( command, 'value' );

            view.on( 'execute', () => {
                editor.execute( 'paragraph' );
            } );

            return view;
        } );
    }
}