Skip to content

Commit

Permalink
Merge pull request #17493 from ckeditor/master_to_release
Browse files Browse the repository at this point in the history
Internal: Merge master to release for testing phase.
  • Loading branch information
psmyrek authored Nov 20, 2024
2 parents cdf33bb + b46f8ad commit 28a4dba
Show file tree
Hide file tree
Showing 1,149 changed files with 31,625 additions and 4,158 deletions.
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ module.exports = {
],
rules: {
'ckeditor5-rules/ckeditor-imports': 'error',
'ckeditor5-rules/prevent-license-key-leak': 'error',
'ckeditor5-rules/license-header': [ 'error', {
headerLines: [
'/**',
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/9-builder-report.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: 🐛 CKEditor 5 Builder error
description: Report something that does not work as expected in CKEditor 5 Builder
labels: [ "squad:devops", "type:bug" ]
labels: [ "squad:platform", "type:bug" ]
body:
- type: textarea
attributes:
Expand Down
45 changes: 24 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
CKEditor 5 [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%205%20on%20GitHub&url=https%3A%2F%2Fgit.luolix.top%2Fckeditor%2Fckeditor5)
CKEditor&nbsp;5 [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%205%20on%20GitHub&url=https%3A%2F%2Fgit.luolix.top%2Fckeditor%2Fckeditor5)<!-- omit in toc -->
===================================

[![npm version](https://badge.fury.io/js/ckeditor5.svg)](https://www.npmjs.com/package/ckeditor5)
Expand All @@ -13,44 +13,43 @@ CKEditor&nbsp;5 is a modern JavaScript rich-text editor with MVC architecture, c

![A composition of screenshots presenting various features of CKEditor&nbsp;5 rich text editor](https://raw.githubusercontent.com/ckeditor/ckeditor5/master/docs/assets/img/CKEditor-5.png)

## Table of contents

- [CKEditor 5 ](#ckeditor5-)
- [Table of contents](#table-of-contents)
- [Quick start](#quick-start)
- [CKEditor 5 Builder](#ckeditor5-builder)
- [TypeScript support](#typescript-support)
- [CKEditor 5 advanced installation](#ckeditor5-advanced-installation)
- [CKEditor 5 Framework](#ckeditor5-framework)
- [Documentation and FAQ](#documentation-and-faq)
- [Releases](#releases)
- [Editing and collaboration features](#editing-and-collaboration-features)
- [Contributing and project organization](#contributing-and-project-organization)
- [Ideas and discussions](#ideas-and-discussions)
- [Development](#development)
- [Reporting issues and feature requests](#reporting-issues-and-feature-requests)
- [License](#license)
## Table of contents<!-- omit in toc -->

- [Quick start](#quick-start)
- [CKEditor 5 Builder](#ckeditor-5-builder)
- [TypeScript support](#typescript-support)
- [CKEditor 5 advanced installation](#ckeditor-5-advanced-installation)
- [CKEditor 5 Framework](#ckeditor-5-framework)
- [Documentation and FAQ](#documentation-and-faq)
- [Releases](#releases)
- [Editing and collaboration features](#editing-and-collaboration-features)
- [Create a free account and test full potential](#create-a-free-account-and-test-full-potential)
- [Contributing and project organization](#contributing-and-project-organization)
- [Ideas and discussions](#ideas-and-discussions)
- [Development](#development)
- [Reporting issues and feature requests](#reporting-issues-and-feature-requests)
- [License](#license)

## Quick start

Refer to the [Quick Start](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/quick-start.html) guide to learn more about CKEditor&nbsp;5 installation.

### CKEditor&nbsp;5 Builder
### CKEditor 5 Builder

The easiest way to start using CKEditor&nbsp;5 with all the features you need is to prepare a customized setup with the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder). All you need to do is choose the preferred editor type as a base, add all the required plugins, and download the ready-to-use package.

### TypeScript support

CKEditor&nbsp;5 is a TypeScript project. Starting from v37.0.0, it offers native type definitions. Check out our dedicated guide to read more about [TypeScript support](https://ckeditor.com/docs/ckeditor5/latest/getting-started/setup/typescript-support.html).

### CKEditor&nbsp;5 advanced installation
### CKEditor 5 advanced installation

For more advanced users or those who need to integrate CKEditor&nbsp;5 with their applications, we prepared integrations with popular JavaScript frameworks:
* [Angular](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/angular.html)
* [React](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/react/react.html)
* [Vue](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/vuejs-v3.html)

#### CKEditor&nbsp;5 Framework
#### CKEditor 5 Framework

CKEditor&nbsp;5 is also a framework for creating custom-made rich text editing solutions.

Expand Down Expand Up @@ -85,6 +84,10 @@ The number of options and the ease of customization and adding new ones make the

Refer to the [CKEditor&nbsp;5 Features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html) documentation for details.

## Create a free account and test full potential

If you want to check full CKEditor&nbsp;5 capabilities, including premium features, sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/signup).

## Contributing and project organization

### Ideas and discussions
Expand Down
2 changes: 2 additions & 0 deletions docs/_snippets/build-classic-source.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@
/* globals window */

import { AutoImage, ImageInsert } from '@ckeditor/ckeditor5-image';
import { Bookmark } from '@ckeditor/ckeditor5-bookmark';
import ClassicEditor from './build-classic.js';

window.ClassicEditor = ClassicEditor;

ClassicEditor.builtinPlugins.push( ImageInsert );
ClassicEditor.builtinPlugins.push( AutoImage );
ClassicEditor.builtinPlugins.push( Bookmark );
3 changes: 2 additions & 1 deletion docs/_snippets/examples/balloon-block-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ BalloonEditor
viewportOffset: {
top: window.getViewportTopOffsetConfig()
}
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/examples/balloon-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ BalloonEditor
viewportOffset: {
top: window.getViewportTopOffsetConfig()
}
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
4 changes: 2 additions & 2 deletions docs/_snippets/examples/bottom-toolbar-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,8 @@ DecoupledEditor
'mergeTableCells'
]
},

cloudServices: CS_CONFIG
cloudServices: CS_CONFIG,
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/examples/classic-editor-short.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ ClassicEditor
viewportOffset: {
top: window.getViewportTopOffsetConfig()
}
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
5 changes: 3 additions & 2 deletions docs/_snippets/examples/classic-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,16 @@ ClassicEditor
'undo', 'redo',
'|', 'heading',
'|', 'bold', 'italic',
'|', 'link', 'insertImage', 'insertTable', 'mediaEmbed',
'|', 'link', 'bookmark', 'insertImage', 'insertTable', 'mediaEmbed',
'|', 'bulletedList', 'numberedList', 'outdent', 'indent'
]
},
ui: {
viewportOffset: {
top: window.getViewportTopOffsetConfig()
}
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/examples/document-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ DecoupledEditor
viewportOffset: {
top: window.getViewportTopOffsetConfig()
}
}
},
licenseKey: 'GPL'
} )
.then( editor => {
const toolbarContainer = document.querySelector( '.document-editor__toolbar' );
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/examples/inline-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Array.from( inlineInjectElements ).forEach( inlineElement => {
'|', 'bulletedList', 'numberedList', 'outdent', 'indent'
]
},
cloudServices: CS_CONFIG
cloudServices: CS_CONFIG,
licenseKey: 'GPL'
};

if ( inlineElement.tagName.toLowerCase() == 'header' ) {
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/examples/multi-root-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ MultiRootEditor
'|', 'link', 'uploadImage', 'insertTable', 'mediaEmbed',
'|', 'bulletedList', 'numberedList', 'outdent', 'indent'
]
}
},
licenseKey: 'GPL'
}
)
.then( editor => {
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/image-upload.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ ClassicEditor
tokenUrl: TOKEN_URL,
forceDemoLabel: true,
allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/mathtype.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ ClassicEditor
table: {
contentToolbar: [ 'tableColumn', 'tableRow', 'mergeTableCells' ]
},
cloudServices: CS_CONFIG
cloudServices: CS_CONFIG,
licenseKey: 'GPL'
} )

.then( editor => {
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/mermaid.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ ClassicEditor
top: window.getViewportTopOffsetConfig()
}
},
cloudServices: CS_CONFIG
cloudServices: CS_CONFIG,
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/placeholder-custom.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ ClassicEditor
top: window.getViewportTopOffsetConfig()
}
},
placeholder: 'Type some content here!'
placeholder: 'Type some content here!',
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/placeholder.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ ClassicEditor
top: window.getViewportTopOffsetConfig()
}
},
placeholder: 'Type some content here!'
placeholder: 'Type some content here!',
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/read-only-hide-toolbar.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ ClassicEditor
tokenUrl: TOKEN_URL,
forceDemoLabel: true,
allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/read-only.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ ClassicEditor
exportWord: {
fileName: 'export-word-demo.docx',
tokenUrl: false
}
},
licenseKey: 'GPL'
} )
.then( editor => {
const button = document.querySelector( '#snippet-read-only-toggle' );
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/ui-language-content.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ ClassicEditor
tokenUrl: TOKEN_URL,
forceDemoLabel: true,
allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/ui-language-rtl.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ ClassicEditor
tokenUrl: TOKEN_URL,
forceDemoLabel: true,
allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/ui-language.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ ClassicEditor
tokenUrl: TOKEN_URL,
forceDemoLabel: true,
allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/update-placeholder.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ ClassicEditor
top: window.getViewportTopOffsetConfig()
}
},
placeholder: 'Type some content here!'
placeholder: 'Type some content here!',
licenseKey: 'GPL'
} )
.then( editor => {
const button = document.getElementById( 'update-placeholder-button' );
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/features/wproofreader.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ ClassicEditor
},
table: {
contentToolbar: [ 'tableColumn', 'tableRow', 'mergeTableCells' ]
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/framework/development-tools/inspector.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ ClassicEditor
viewportOffset: {
top: window.getViewportTopOffsetConfig()
}
}
},
licenseKey: 'GPL'
} )
.then( editor => {
window.editor = editor;
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/framework/tutorials/block-widget.js
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,8 @@ ClassicEditor
viewportOffset: {
top: window.getViewportTopOffsetConfig()
}
}
},
licenseKey: 'GPL'
} )
.then( editor => {
console.log( 'Editor was initialized', editor );
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/framework/tutorials/external-data-widget.js
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,8 @@ class ExternalDataWidgetEditing extends Plugin {
ClassicEditor
.create( document.querySelector( '#snippet-external-data-widget' ), {
plugins: [ Essentials, Paragraph, Heading, List, Bold, Italic, ExternalDataWidget ],
toolbar: [ 'undo', 'redo', '|', 'external', '|', 'heading', '|', 'bold', 'italic', '|', 'numberedList', 'bulletedList' ]
toolbar: [ 'undo', 'redo', '|', 'external', '|', 'heading', '|', 'bold', 'italic', '|', 'numberedList', 'bulletedList' ],
licenseKey: 'GPL'
} )
.then( editor => {
console.log( 'Editor was initialized', editor );
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/framework/tutorials/inline-widget.js
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,8 @@ ClassicEditor
viewportOffset: {
top: window.getViewportTopOffsetConfig()
}
}
},
licenseKey: 'GPL'
} )
.then( editor => {
console.log( 'Editor was initialized', editor );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,8 @@ <h3>Other deals</h3>
<ProductPreview id={id} {...product} />
);
}
}
},
licenseKey: 'GPL'
};

this.handleEditorDataChange = this.handleEditorDataChange.bind( this );
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/framework/ui/ui-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ document.querySelector( '.ui-button' ).append( toolbarButtons.element );

ClassicEditor
.create( document.querySelector( '#ui-button-editor' ), {
plugins: [ Essentials ]
plugins: [ Essentials ],
licenseKey: 'GPL'
} )
.then( editor => {
this.tooltipManager = new TooltipManager( editor );
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/framework/ui/ui-dialog.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ class MinimalisticDialog extends Plugin {
ClassicEditor
.create( document.querySelector( '#ui-dialog-editor' ), {
plugins: [ Essentials, Paragraph, Bold, Italic, Underline, MinimalisticDialog, Dialog ],
toolbar: [ 'bold', 'italic', 'underline', '|', 'showDialog' ]
toolbar: [ 'bold', 'italic', 'underline', '|', 'showDialog' ],
licenseKey: 'GPL'
} )
.then( editor => {
window.attachTourBalloon( {
Expand Down
3 changes: 2 additions & 1 deletion docs/_snippets/framework/ui/ui-modal.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ class MinimalisticModal extends Plugin {
ClassicEditor
.create( document.querySelector( '#ui-modal-editor' ), {
plugins: [ Essentials, Paragraph, Bold, Italic, Underline, MinimalisticModal, Dialog ],
toolbar: [ 'bold', 'italic', 'underline', '|', 'showModal' ]
toolbar: [ 'bold', 'italic', 'underline', '|', 'showModal' ],
licenseKey: 'GPL'
} )
.then( editor => {
window.attachTourBalloon( {
Expand Down
Loading

0 comments on commit 28a4dba

Please sign in to comment.