ckeditor5-image-upload-base64
Version:
The development environment of CKEditor 5 – the best browser-based rich text editor.
295 lines (264 loc) • 10.3 kB
JavaScript
/**
* @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 ui/dropdown/utils
*/
import DropdownPanelView from './dropdownpanelview';
import DropdownView from './dropdownview';
import DropdownButtonView from './button/dropdownbuttonview';
import ToolbarView from '../toolbar/toolbarview';
import ListView from '../list/listview';
import ListItemView from '../list/listitemview';
import ListSeparatorView from '../list/listseparatorview';
import ButtonView from '../button/buttonview';
import SwitchButtonView from '../button/switchbuttonview';
import clickOutsideHandler from '../bindings/clickoutsidehandler';
import '../../theme/components/dropdown/toolbardropdown.css';
import '../../theme/components/dropdown/listdropdown.css';
/**
* A helper for creating dropdowns. It creates an instance of a {@link module:ui/dropdown/dropdownview~DropdownView dropdown},
* with a {@link module:ui/dropdown/button/dropdownbutton~DropdownButton button},
* {@link module:ui/dropdown/dropdownpanelview~DropdownPanelView panel} and all standard dropdown's behaviors.
*
* # Creating dropdowns
*
* By default, the default {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView} class is used as
* definition of the button:
*
* const dropdown = createDropdown( model );
*
* // Configure dropdown's button properties:
* dropdown.buttonView.set( {
* label: 'A dropdown',
* withText: true
* } );
*
* dropdown.render();
*
* // Will render a dropdown labeled "A dropdown" with an empty panel.
* document.body.appendChild( dropdown.element );
*
* You can also provide other button views (they need to implement the
* {@link module:ui/dropdown/button/dropdownbutton~DropdownButton} interface). For instance, you can use
* {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} to create a dropdown with a split button.
*
* const dropdown = createDropdown( model, SplitButtonView );
*
* // Configure dropdown's button properties:
* dropdown.buttonView.set( {
* label: 'A dropdown',
* withText: true
* } );
*
* dropdown.buttonView.on( 'execute', () => {
* // Add the behavior of the "action part" of the split button.
* // Split button consists of the "action part" and "arrow part".
* // The arrow opens the dropdown while the action part can have some other behavior.
* } );
*
* dropdown.render();
*
* // Will render a dropdown labeled "A dropdown" with an empty panel.
* document.body.appendChild( dropdown.element );
*
* # Adding content to the dropdown's panel
*
* The content of the panel can be inserted directly into the `dropdown.panelView.element`:
*
* dropdown.panelView.element.textContent = 'Content of the panel';
*
* However, most of the time you will want to add there either a {@link module:ui/list/listview~ListView list of options}
* or a list of buttons (i.e. a {@link module:ui/toolbar/toolbarview~ToolbarView toolbar}).
* To simplify the task, you can use, respectively, {@link module:ui/dropdown/utils~addListToDropdown} or
* {@link module:ui/dropdown/utils~addToolbarToDropdown} utils.
*
* @param {module:utils/locale~Locale} locale The locale instance.
* @param {Function} ButtonClass The dropdown button view class. Needs to implement the
* {@link module:ui/dropdown/button/dropdownbutton~DropdownButton} interface.
* @returns {module:ui/dropdown/dropdownview~DropdownView} The dropdown view instance.
*/
export function createDropdown( locale, ButtonClass = DropdownButtonView ) {
const buttonView = new ButtonClass( locale );
const panelView = new DropdownPanelView( locale );
const dropdownView = new DropdownView( locale, buttonView, panelView );
buttonView.bind( 'isEnabled' ).to( dropdownView );
if ( buttonView instanceof DropdownButtonView ) {
buttonView.bind( 'isOn' ).to( dropdownView, 'isOpen' );
} else {
buttonView.arrowView.bind( 'isOn' ).to( dropdownView, 'isOpen' );
}
addDefaultBehavior( dropdownView );
return dropdownView;
}
/**
* Adds an instance of {@link module:ui/toolbar/toolbarview~ToolbarView} to a dropdown.
*
* const buttons = [];
*
* // Either create a new ButtonView instance or create existing.
* buttons.push( new ButtonView() );
* buttons.push( editor.ui.componentFactory.get( 'someButton' ) );
*
* const dropdown = createDropdown( locale );
*
* addToolbarToDropdown( dropdown, buttons );
*
* dropdown.toolbarView.isVertical = true;
*
* // Will render a vertical button dropdown labeled "A button dropdown"
* // with a button group in the panel containing two buttons.
* dropdown.render()
* document.body.appendChild( dropdown.element );
*
* See {@link module:ui/dropdown/utils~createDropdown} and {@link module:ui/toolbar/toolbarview~ToolbarView}.
*
* @param {module:ui/dropdown/dropdownview~DropdownView} dropdownView A dropdown instance to which `ToolbarView` will be added.
* @param {Iterable.<module:ui/button/buttonview~ButtonView>} buttons
*/
export function addToolbarToDropdown( dropdownView, buttons ) {
const locale = dropdownView.locale;
const t = locale.t;
const toolbarView = dropdownView.toolbarView = new ToolbarView( locale );
toolbarView.set( 'ariaLabel', t( 'Dropdown toolbar' ) );
dropdownView.extendTemplate( {
attributes: {
class: [ 'ck-toolbar-dropdown' ]
}
} );
buttons.map( view => toolbarView.items.add( view ) );
dropdownView.panelView.children.add( toolbarView );
toolbarView.items.delegate( 'execute' ).to( dropdownView );
}
/**
* Adds an instance of {@link module:ui/list/listview~ListView} to a dropdown.
*
* const items = new Collection();
*
* items.add( {
* type: 'button',
* model: new Model( {
* withText: true,
* label: 'First item',
* labelStyle: 'color: red'
* } )
* } );
*
* items.add( {
* type: 'button',
* model: new Model( {
* withText: true,
* label: 'Second item',
* labelStyle: 'color: green',
* class: 'foo'
* } )
* } );
*
* const dropdown = createDropdown( locale );
*
* addListToDropdown( dropdown, items );
*
* // Will render a dropdown with a list in the panel containing two items.
* dropdown.render()
* document.body.appendChild( dropdown.element );
*
* The `items` collection passed to this methods controls the presence and attributes of respective
* {@link module:ui/list/listitemview~ListItemView list items}.
*
*
* See {@link module:ui/dropdown/utils~createDropdown} and {@link module:list/list~List}.
*
* @param {module:ui/dropdown/dropdownview~DropdownView} dropdownView A dropdown instance to which `ListVIew` will be added.
* @param {Iterable.<module:ui/dropdown/utils~ListDropdownItemDefinition>} items
* A collection of the list item definitions to populate the list.
*/
export function addListToDropdown( dropdownView, items ) {
const locale = dropdownView.locale;
const listView = dropdownView.listView = new ListView( locale );
listView.items.bindTo( items ).using( ( { type, model } ) => {
if ( type === 'separator' ) {
return new ListSeparatorView( locale );
} else if ( type === 'button' || type === 'switchbutton' ) {
const listItemView = new ListItemView( locale );
let buttonView;
if ( type === 'button' ) {
buttonView = new ButtonView( locale );
} else {
buttonView = new SwitchButtonView( locale );
}
// Bind all model properties to the button view.
buttonView.bind( ...Object.keys( model ) ).to( model );
buttonView.delegate( 'execute' ).to( listItemView );
listItemView.children.add( buttonView );
return listItemView;
}
} );
dropdownView.panelView.children.add( listView );
listView.items.delegate( 'execute' ).to( dropdownView );
}
// Add a set of default behaviors to dropdown view.
//
// @param {module:ui/dropdown/dropdownview~DropdownView} dropdownView
function addDefaultBehavior( dropdownView ) {
closeDropdownOnBlur( dropdownView );
closeDropdownOnExecute( dropdownView );
focusDropdownContentsOnArrows( dropdownView );
}
// Adds a behavior to a dropdownView that closes opened dropdown when user clicks outside the dropdown.
//
// @param {module:ui/dropdown/dropdownview~DropdownView} dropdownView
function closeDropdownOnBlur( dropdownView ) {
dropdownView.on( 'render', () => {
clickOutsideHandler( {
emitter: dropdownView,
activator: () => dropdownView.isOpen,
callback: () => {
dropdownView.isOpen = false;
},
contextElements: [ dropdownView.element ]
} );
} );
}
// Adds a behavior to a dropdownView that closes the dropdown view on "execute" event.
//
// @param {module:ui/dropdown/dropdownview~DropdownView} dropdownView
function closeDropdownOnExecute( dropdownView ) {
// Close the dropdown when one of the list items has been executed.
dropdownView.on( 'execute', evt => {
// Toggling a switch button view should not close the dropdown.
if ( evt.source instanceof SwitchButtonView ) {
return;
}
dropdownView.isOpen = false;
} );
}
// Adds a behavior to a dropdownView that focuses the dropdown's panel view contents on keystrokes.
//
// @param {module:ui/dropdown/dropdownview~DropdownView} dropdownView
function focusDropdownContentsOnArrows( dropdownView ) {
// If the dropdown panel is already open, the arrow down key should focus the first child of the #panelView.
dropdownView.keystrokes.set( 'arrowdown', ( data, cancel ) => {
if ( dropdownView.isOpen ) {
dropdownView.panelView.focus();
cancel();
}
} );
// If the dropdown panel is already open, the arrow up key should focus the last child of the #panelView.
dropdownView.keystrokes.set( 'arrowup', ( data, cancel ) => {
if ( dropdownView.isOpen ) {
dropdownView.panelView.focusLast();
cancel();
}
} );
}
/**
* A definition of the list item used by the {@link module:ui/dropdown/utils~addListToDropdown}
* utility.
*
* @typedef {Object} module:ui/dropdown/utils~ListDropdownItemDefinition
*
* @property {String} type Either `'separator'`, `'button'` or `'switchbutton'`.
* @property {module:ui/model~Model} [model] Model of the item (when **not** `'separator'`).
* Its properties fuel the newly created list item (or its children, depending on the `type`).
*/