| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241 |
- /**
- * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* globals console, window, document */
- import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
- import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
- import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
- import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic';
- import Heading from '@ckeditor/ckeditor5-heading/src/heading';
- import List from '@ckeditor/ckeditor5-list/src/list';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import { toWidget, toWidgetEditable } from '@ckeditor/ckeditor5-widget/src/utils';
- import Widget from '@ckeditor/ckeditor5-widget/src/widget';
- import Command from '@ckeditor/ckeditor5-core/src/command';
- import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
- class SimpleBox extends Plugin {
- static get requires() {
- return [ SimpleBoxEditing, SimpleBoxUI ];
- }
- }
- class SimpleBoxUI extends Plugin {
- init() {
- console.log( 'SimpleBoxUI#init() got called' );
- const editor = this.editor;
- const t = editor.t;
- // The "simpleBox" button must be registered among the UI components of the editor
- // to be displayed in the toolbar.
- editor.ui.componentFactory.add( 'simpleBox', locale => {
- // The state of the button will be bound to the widget command.
- const command = editor.commands.get( 'insertSimpleBox' );
- // The button will be an instance of ButtonView.
- const buttonView = new ButtonView( locale );
- buttonView.set( {
- // The t() function helps localize the editor. All strings enclosed in t() can be
- // translated and change when the language of the editor changes.
- label: t( 'Simple Box' ),
- withText: true,
- tooltip: true
- } );
- // Bind the state of the button to the command.
- buttonView.bind( 'isOn', 'isEnabled' ).to( command, 'value', 'isEnabled' );
- // Execute the command when the button is clicked (executed).
- this.listenTo( buttonView, 'execute', () => editor.execute( 'insertSimpleBox' ) );
- return buttonView;
- } );
- }
- }
- class SimpleBoxEditing extends Plugin {
- static get requires() {
- return [ Widget ];
- }
- init() {
- console.log( 'SimpleBoxEditing#init() got called' );
- this._defineSchema();
- this._defineConverters();
- this.editor.commands.add( 'insertSimpleBox', new InsertSimpleBoxCommand( this.editor ) );
- }
- _defineSchema() {
- const schema = this.editor.model.schema;
- schema.register( 'simpleBox', {
- // Behaves like a self-contained object (e.g. an image).
- isObject: true,
- // Allow in places where other blocks are allowed (e.g. directly in the root).
- allowWhere: '$block'
- } );
- schema.register( 'simpleBoxTitle', {
- // Cannot be split or left by the caret.
- isLimit: true,
- allowIn: 'simpleBox',
- // Allow content which is allowed in blocks (i.e. text with attributes).
- allowContentOf: '$block'
- } );
- schema.register( 'simpleBoxDescription', {
- // Cannot be split or left by the caret.
- isLimit: true,
- allowIn: 'simpleBox',
- // Allow content which is allowed in the root (e.g. paragraphs).
- allowContentOf: '$root'
- } );
- schema.addChildCheck( ( context, childDefinition ) => {
- if ( context.endsWith( 'simpleBoxDescription' ) && childDefinition.name == 'simpleBox' ) {
- return false;
- }
- } );
- }
- _defineConverters() {
- const conversion = this.editor.conversion;
- // <simpleBox> converters
- conversion.for( 'upcast' ).elementToElement( {
- model: 'simpleBox',
- view: {
- name: 'section',
- classes: 'simple-box'
- }
- } );
- conversion.for( 'dataDowncast' ).elementToElement( {
- model: 'simpleBox',
- view: {
- name: 'section',
- classes: 'simple-box'
- }
- } );
- conversion.for( 'editingDowncast' ).elementToElement( {
- model: 'simpleBox',
- view: ( modelElement, viewWriter ) => {
- const section = viewWriter.createContainerElement( 'section', { class: 'simple-box' } );
- return toWidget( section, viewWriter, { label: 'simple box widget' } );
- }
- } );
- // <simpleBoxTitle> converters
- conversion.for( 'upcast' ).elementToElement( {
- model: 'simpleBoxTitle',
- view: {
- name: 'h1',
- classes: 'simple-box-title'
- }
- } );
- conversion.for( 'dataDowncast' ).elementToElement( {
- model: 'simpleBoxTitle',
- view: {
- name: 'h1',
- classes: 'simple-box-title'
- }
- } );
- conversion.for( 'editingDowncast' ).elementToElement( {
- model: 'simpleBoxTitle',
- view: ( modelElement, viewWriter ) => {
- // Note: You use a more specialized createEditableElement() method here.
- const h1 = viewWriter.createEditableElement( 'h1', { class: 'simple-box-title' } );
- return toWidgetEditable( h1, viewWriter );
- }
- } );
- // <simpleBoxDescription> converters
- conversion.for( 'upcast' ).elementToElement( {
- model: 'simpleBoxDescription',
- view: {
- name: 'div',
- classes: 'simple-box-description'
- }
- } );
- conversion.for( 'dataDowncast' ).elementToElement( {
- model: 'simpleBoxDescription',
- view: {
- name: 'div',
- classes: 'simple-box-description'
- }
- } );
- conversion.for( 'editingDowncast' ).elementToElement( {
- model: 'simpleBoxDescription',
- view: ( modelElement, viewWriter ) => {
- // Note: You use a more specialized createEditableElement() method here.
- const div = viewWriter.createEditableElement( 'div', { class: 'simple-box-description' } );
- return toWidgetEditable( div, viewWriter );
- }
- } );
- }
- }
- class InsertSimpleBoxCommand extends Command {
- execute() {
- this.editor.model.change( writer => {
- // Insert <simpleBox>*</simpleBox> at the current selection position
- // in a way that will result in creating a valid model structure.
- this.editor.model.insertContent( createSimpleBox( writer ) );
- } );
- }
- refresh() {
- const model = this.editor.model;
- const selection = model.document.selection;
- const allowedIn = model.schema.findAllowedParent( selection.getFirstPosition(), 'simpleBox' );
- this.isEnabled = allowedIn !== null;
- }
- }
- function createSimpleBox( writer ) {
- const simpleBox = writer.createElement( 'simpleBox' );
- const simpleBoxTitle = writer.createElement( 'simpleBoxTitle' );
- const simpleBoxDescription = writer.createElement( 'simpleBoxDescription' );
- writer.append( simpleBoxTitle, simpleBox );
- writer.append( simpleBoxDescription, simpleBox );
- // There must be at least one paragraph for the description to be editable.
- // See https://github.com/ckeditor/ckeditor5/issues/1464.
- writer.appendElement( 'paragraph', simpleBoxDescription );
- return simpleBox;
- }
- ClassicEditor
- .create( document.querySelector( '#snippet-block-widget' ), {
- plugins: [ Essentials, Bold, Italic, Heading, List, Paragraph, SimpleBox ],
- toolbar: {
- items: [ 'heading', '|', 'bold', 'italic', 'numberedList', 'bulletedList', 'simpleBox' ],
- viewportTopOffset: window.getViewportTopOffsetConfig()
- }
- } )
- .then( editor => {
- console.log( 'Editor was initialized', editor );
- window.editor = editor;
- } )
- .catch( err => {
- console.error( err.stack );
- } );
|