| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module highlight/highlightui
- */
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import HighlightEditing from './highlightediting';
- import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
- import markerIcon from './../theme/icons/marker.svg';
- import penIcon from './../theme/icons/pen.svg';
- import eraserIcon from './../theme/icons/eraser.svg';
- import ToolbarSeparatorView from '@ckeditor/ckeditor5-ui/src/toolbar/toolbarseparatorview';
- import SplitButtonView from '@ckeditor/ckeditor5-ui/src/dropdown/button/splitbuttonview';
- import { createDropdown, addToolbarToDropdown } from '@ckeditor/ckeditor5-ui/src/dropdown/utils';
- import './../theme/highlight.css';
- /**
- * The default Highlight UI plugin. It introduces:
- * * the `'highlightDropdown'` drop-down,
- * * `'removeHighlight'` and `'highlight:*'` buttons.
- *
- * The default configuration includes the following buttons:
- * * `'highlight:marker'`
- * * `'highlight:greenMarker'`
- * * `'highlight:pinkMarker'`
- * * `'highlight:blueMarker'`
- * * `'highlight:redPen'`
- * * `'highlight:greenPen'`
- *
- * See the {@link module:highlight/highlight~HighlightConfig#options configuration} to learn more
- * about the defaults.
- *
- * @extends module:core/plugin~Plugin
- */
- export default class HighlightUI extends Plugin {
- /**
- * Returns the localized option titles provided by the plugin.
- *
- * The following localized titles corresponding with default
- * {@link module:highlight/highlight~HighlightConfig#options} are available:
- *
- * * `'Marker'`,
- * * `'Green marker'`,
- * * `'Pink marker'`,
- * * `'Blue marker'`,
- * * `'Red pen'`,
- * * `'Green pen'`.
- *
- * @readonly
- * @type {Object.<String,String>}
- */
- get localizedOptionTitles() {
- const t = this.editor.t;
- return {
- 'Marker': t( 'Marker' ),
- 'Green marker': t( 'Green marker' ),
- 'Pink marker': t( 'Pink marker' ),
- 'Blue marker': t( 'Blue marker' ),
- 'Red pen': t( 'Red pen' ),
- 'Green pen': t( 'Green pen' )
- };
- }
- /**
- * @inheritDoc
- */
- static get requires() {
- return [ HighlightEditing ];
- }
- /**
- * @inheritDoc
- */
- static get pluginName() {
- return 'HighlightUI';
- }
- /**
- * @inheritDoc
- */
- init() {
- const options = this.editor.config.get( 'highlight.options' );
- for ( const option of options ) {
- this._addHighlighterButton( option );
- }
- this._addRemoveHighlightButton();
- this._addDropdown( options );
- }
- /**
- * Creates remove highlight button.
- *
- * @private
- */
- _addRemoveHighlightButton() {
- const t = this.editor.t;
- this._addButton( 'removeHighlight', t( 'Remove highlighting' ), eraserIcon );
- }
- /**
- * Creates toolbar button from provided highlight option.
- *
- * @param {module:highlight/highlight~HighlightOption} option
- * @private
- */
- _addHighlighterButton( option ) {
- const command = this.editor.commands.get( 'highlight' );
- // TODO: change naming
- this._addButton( 'highlight:' + option.model, option.title, getIconForType( option.type ), option.model, decorateHighlightButton );
- function decorateHighlightButton( button ) {
- button.bind( 'isEnabled' ).to( command, 'isEnabled' );
- button.bind( 'isOn' ).to( command, 'value', value => value === option.model );
- button.extendTemplate( {
- attributes: {
- style: `color: ${ option.color }`,
- class: 'ck-highlight-button'
- }
- } );
- }
- }
- /**
- * Internal method for creating highlight buttons.
- *
- * @param {String} name Name of a button.
- * @param {String} label Label for button.
- * @param {String} icon Button's icon.
- * @param {Function} [decorateButton=()=>{}] Additional method for extending button.
- * @private
- */
- _addButton( name, label, icon, value, decorateButton = () => {} ) {
- const editor = this.editor;
- editor.ui.componentFactory.add( name, locale => {
- const buttonView = new ButtonView( locale );
- const localized = this.localizedOptionTitles[ label ] ? this.localizedOptionTitles[ label ] : label;
- buttonView.set( {
- label: localized,
- icon,
- tooltip: true
- } );
- buttonView.on( 'execute', () => {
- editor.execute( 'highlight', { value } );
- editor.editing.view.focus();
- } );
- // Add additional behavior for buttonView.
- decorateButton( buttonView );
- return buttonView;
- } );
- }
- /**
- * Creates split button dropdown UI from provided highlight options.
- *
- * @param {Array.<module:highlight/highlight~HighlightOption>} options
- * @private
- */
- _addDropdown( options ) {
- const editor = this.editor;
- const t = editor.t;
- const componentFactory = editor.ui.componentFactory;
- const startingHighlighter = options[ 0 ];
- const optionsMap = options.reduce( ( retVal, option ) => {
- retVal[ option.model ] = option;
- return retVal;
- }, {} );
- componentFactory.add( 'highlightDropdown', locale => {
- const command = editor.commands.get( 'highlight' );
- const dropdownView = createDropdown( locale, SplitButtonView );
- const splitButtonView = dropdownView.buttonView;
- splitButtonView.set( {
- tooltip: t( 'Highlight' ),
- // Holds last executed highlighter.
- lastExecuted: startingHighlighter.model,
- // Holds current highlighter to execute (might be different then last used).
- commandValue: startingHighlighter.model
- } );
- // Dropdown button changes to selection (command.value):
- // - If selection is in highlight it get active highlight appearance (icon, color) and is activated.
- // - Otherwise it gets appearance (icon, color) of last executed highlight.
- splitButtonView.bind( 'icon' ).to( command, 'value', value => getIconForType( getActiveOption( value, 'type' ) ) );
- splitButtonView.bind( 'color' ).to( command, 'value', value => getActiveOption( value, 'color' ) );
- splitButtonView.bind( 'commandValue' ).to( command, 'value', value => getActiveOption( value, 'model' ) );
- splitButtonView.bind( 'isOn' ).to( command, 'value', value => !!value );
- splitButtonView.delegate( 'execute' ).to( dropdownView );
- splitButtonView.extendTemplate( {
- attributes: {
- class: 'ck-highlight-button'
- }
- } );
- // Create buttons array.
- const buttons = options.map( option => {
- // Get existing highlighter button.
- const buttonView = componentFactory.create( 'highlight:' + option.model );
- // Update lastExecutedHighlight on execute.
- this.listenTo( buttonView, 'execute', () => dropdownView.buttonView.set( { lastExecuted: option.model } ) );
- return buttonView;
- } );
- // Make toolbar button enabled when any button in dropdown is enabled before adding separator and eraser.
- dropdownView.bind( 'isEnabled' ).toMany( buttons, 'isEnabled', ( ...areEnabled ) => areEnabled.some( isEnabled => isEnabled ) );
- // Add separator and eraser buttons to dropdown.
- buttons.push( new ToolbarSeparatorView() );
- buttons.push( componentFactory.create( 'removeHighlight' ) );
- addToolbarToDropdown( dropdownView, buttons );
- bindIconStyleToColor( dropdownView );
- dropdownView.extendTemplate( {
- attributes: {
- class: [ 'ck-highlight-dropdown' ]
- }
- } );
- // Execute current action from dropdown's split button action button.
- splitButtonView.on( 'execute', () => {
- editor.execute( 'highlight', { value: splitButtonView.commandValue } );
- editor.editing.view.focus();
- } );
- // Returns active highlighter option depending on current command value.
- // If current is not set or it is the same as last execute this method will return the option key (like icon or color)
- // of last executed highlighter. Otherwise it will return option key for current one.
- function getActiveOption( current, key ) {
- const whichHighlighter = !current ||
- current === splitButtonView.lastExecuted ? splitButtonView.lastExecuted : current;
- return optionsMap[ whichHighlighter ][ key ];
- }
- return dropdownView;
- } );
- }
- }
- // Extends split button icon style to reflect last used button style.
- function bindIconStyleToColor( dropdownView ) {
- const actionView = dropdownView.buttonView.actionView;
- const bind = actionView.bindTemplate;
- // Color will propagate to iconView.
- actionView.extendTemplate( {
- attributes: {
- style: bind.to( 'color', color => `color:${ color }` )
- }
- } );
- actionView.bind( 'color' ).to( dropdownView.buttonView, 'color' );
- }
- // Returns icon for given highlighter type.
- function getIconForType( type ) {
- return type === 'marker' ? markerIcon : penIcon;
- }
|