Skip to content

Commit

Permalink
Merge branch 'master' into ck/15713-allow-passing-a-translations-obje…
Browse files Browse the repository at this point in the history
…ct-in-the-configuration
  • Loading branch information
illia-stv committed Feb 1, 2024
2 parents 0cfc719 + 89c1831 commit 0c7c1ee
Show file tree
Hide file tree
Showing 63 changed files with 2,226 additions and 244 deletions.
6 changes: 6 additions & 0 deletions .eslintrc.js
Expand Up @@ -32,6 +32,12 @@ module.exports = {
]
},
overrides: [
{
files: [ './packages/*/src/**/*.ts' ],
rules: {
'ckeditor5-rules/no-cross-package-svg-imports': 'error'
}
},
{
files: [ '**/tests/**/*.@(js|ts)' ],
rules: {
Expand Down
6 changes: 4 additions & 2 deletions .vale.ini
Expand Up @@ -12,6 +12,8 @@ BasedOnStyles = CKEditor, Vale, Microsoft, proselint, write-good, Readability
Microsoft.Avoid = NO
Microsoft.Contractions = NO
Microsoft.Dashes = NO
# The rule to use "address" instead of URL makes no sense for our audience.
Microsoft.GeneralURL = NO
# Replaced by a custom CKEditor style to make exceptions possible.
Microsoft.HeadingAcronyms = NO
# The Passive rule appears in write-good too, with a better description.
Expand All @@ -25,5 +27,5 @@ write-good.ThereIs = suggestion
# Ignore HTML links.
IgnoredScopes = a
# Ignore internal documentation links ({@link} and URLs typed verbatim or in Markdown notation.
# Ignore internal snippet links.
TokenIgnores = {@link [^{}]+}, https?://[^\s]+, {@snippet [^{}]+}, {@exec [^{}]+}, {@icon [^{}]+}
# Ignore internal snippet, exec, and icon links.
TokenIgnores = {@link [^{}]+}, https?://[^\s]+, {@snippet [^{}]+}, {@exec [^{}]+}, {@icon [^{}]+}, \[@ckeditor/ckeditor5-[A-Za-z0-9-]+\]
Binary file added docs/assets/img/features-ai-assistant.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
94 changes: 55 additions & 39 deletions docs/features/index.md

Large diffs are not rendered by default.

45 changes: 35 additions & 10 deletions docs/features/keyboard-support.md
Expand Up @@ -66,6 +66,16 @@ Below is a list of the most important keystrokes supported by CKEditor 5 an
<td><kbd>Ctrl</kbd> + <kbd>I</kbd></td>
<td><kbd>Cmd</kbd> + <kbd>I</kbd></td>
</tr>
<tr>
<td>Strikethrough</td>
<td><kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd></td>
<td><kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd></td>
</tr>
<tr>
<td>Underline</td>
<td><kbd>Ctrl</kbd> + <kbd>U</kbd></td>
<td><kbd>Cmd</kbd> + <kbd>U</kbd></td>
</tr>
<tr>
<td>Link</td>
<td><kbd>Ctrl</kbd> + <kbd>K</kbd></td>
Expand All @@ -79,15 +89,6 @@ Below is a list of the most important keystrokes supported by CKEditor&nbsp;5 an
<td>Insert a soft break (a <code>&lt;br&gt;</code>)</td>
<td colspan="2"><kbd>Shift</kbd> + <kbd>Enter</kbd></td>
</tr>
<tr>
<td>Nest the current list item (when in a list)</td>
<td colspan="2"><kbd>Tab</kbd></td>
</tr>
<tr>
<td>Check or clear a to-do list item</td>
<td><kbd>Ctrl</kbd> + <kbd>Enter</kbd></td>
<td><kbd>Cmd</kbd> + <kbd>Enter</kbd></td>
</tr>
<tr>
<td>Move out of link or inline code style</td>
<td colspan="2"><kbd>←</kbd> <kbd>←</kbd> / <kbd>→</kbd> <kbd>→</kbd></td>
Expand All @@ -96,6 +97,11 @@ Below is a list of the most important keystrokes supported by CKEditor&nbsp;5 an
<td>Revert autoformatting action</td>
<td colspan="2"><kbd>Backspace</kbd></td>
</tr>
<tr>
<td>Find in the document</td>
<td><kbd>Ctrl</kbd> + <kbd>F</kbd></td>
<td><kbd>Cmd</kbd> + <kbd>F</kbd></td>
</tr>
<tr>
<th colspan="3">When you select a widget (for example: image, table, horizontal line, etc.)</th>
</tr>
Expand All @@ -115,6 +121,26 @@ Below is a list of the most important keystrokes supported by CKEditor&nbsp;5 an
<td>Display the caret to allow typing directly after a widget</td>
<td colspan="2"><kbd>↓</kbd> / <kbd>→</kbd></td>
</tr>
<tr>
<th colspan="3">Inside a list</th>
</tr>
<tr>
<td>Increase list item indent</td>
<td colspan="2"><kbd>Tab</kbd></td>
</tr>
<tr>
<td>Decrease list item indent</td>
<td colspan="2"><kbd>Shift</kbd> + <kbd>Tab</kbd></td>
</tr>
<tr>
<td>Nest the current list item (when in a list)</td>
<td colspan="2"><kbd>Tab</kbd></td>
</tr>
<tr>
<td>Check or clear a to-do list item</td>
<td><kbd>Ctrl</kbd> + <kbd>Enter</kbd></td>
<td><kbd>Cmd</kbd> + <kbd>Enter</kbd></td>
</tr>
<tr>
<th colspan="3">In a table cell</th>
</tr>
Expand Down Expand Up @@ -195,7 +221,6 @@ Use the following keystrokes for more efficient navigation in the CKEditor&nbsp;
}
</style>


## Related productivity features

Besides using keyboard shortcuts, you may want to check the following productivity features:
Expand Down
20 changes: 20 additions & 0 deletions docs/framework/contributing/code-style.md
Expand Up @@ -1171,3 +1171,23 @@ As required by the [ECMAScript (ESM)](https://developer.mozilla.org/en-US/docs/W
The second case is common in the documentation, because its pieces are in different directories and repositories. These pieces are merged during the build step, but before that, the imports are technically invalid.

In such cases, you must add the file extension manually. Imports with file extensions are not validated.

### Importing SVG files from other packages: `ckeditor5-rules/no-cross-package-svg-imports`

To ensure that all SVG icons are properly converted to JavaScript strings at build time, all icons must be imported either from the package's own `theme` folder or as a JavaScript object from another package. Importing from another package's `theme` folder is not allowed.

👎 Example of incorrect SVG import:

```js
import CheckIcon from '@ckeditor/ckeditor5-core/theme/icons/check.svg';
```

👍 Examples of correct SVG imports:

```js
import CheckIcon from './../theme/icons/check.svg';
```

```js
import { icons } from '@ckeditor/ckeditor5-core';
```
2 changes: 0 additions & 2 deletions docs/installation/working-with-typescript.md
Expand Up @@ -20,8 +20,6 @@ CKEditor&nbsp;5 is built using TypeScript and has native type definitions. All t

<info-box warning>
Starting with the v37.0.0 release, CKEditor&nbsp;5 has built-in type definitions. If you used type definitions created by the community, you will need to replace them with native types. Check the {@link updating/update-to-37 Update to v37.0.0} guide.

The minimal TypeScript version required to run CKEditor&nbsp;5 is v4.8.4.
</info-box>

## Why use CKEditor&nbsp;5 with TypeScript
Expand Down
6 changes: 5 additions & 1 deletion docs/updating/update-to-25.md
Expand Up @@ -5,13 +5,17 @@ menu-title: Update to v25.x
order: 99
---

# Update to CKEditor&nbsp;5 v25.x

<info-box>
When updating your CKEditor&nbsp;5 installation, make sure **all the packages are the same version** to avoid errors.

For custom builds, you may try removing the `package-lock.json` or `yarn.lock` files (if applicable) and reinstalling all packages before rebuilding the editor. For best results, make sure you use the most recent package versions.
</info-box>

# Update to CKEditor&nbsp;5 v25.0.0
## Update to CKEditor&nbsp;5 v25.0.0

_Released on January 27, 2021._

For the entire list of changes introduced in version 25.0.0, see the [release notes for CKEditor&nbsp;5 v25.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v25.0.0).

Expand Down
6 changes: 5 additions & 1 deletion docs/updating/update-to-26.md
Expand Up @@ -5,13 +5,17 @@ menu-title: Update to v26.x
order: 98
---

# Update to CKEditor&nbsp;5 v26.x

<info-box>
When updating your CKEditor&nbsp;5 installation, make sure **all the packages are the same version** to avoid errors.

For custom builds, you may try removing the `package-lock.json` or `yarn.lock` files (if applicable) and reinstalling all packages before rebuilding the editor. For best results, make sure you use the most recent package versions.
</info-box>

# Update to CKEditor&nbsp;5 v26.0.0
## Update to CKEditor&nbsp;5 v26.0.0

_Released on March 3, 2021._

For the entire list of changes introduced in version 26.0.0, see the [release notes for CKEditor&nbsp;5 v26.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v26.0.0).

Expand Down
8 changes: 6 additions & 2 deletions docs/updating/update-to-27.md
Expand Up @@ -5,16 +5,18 @@ menu-title: Update to v27.x
order: 97
---

# Update to CKEditor&nbsp;5 v27.x

<info-box>
When updating your CKEditor&nbsp;5 installation, make sure **all the packages are the same version** to avoid errors.

For custom builds, you may try removing the `package-lock.json` or `yarn.lock` files (if applicable) and reinstalling all packages before rebuilding the editor. For best results, make sure you use the most recent package versions.
</info-box>

# Update to CKEditor&nbsp;5 v27.x

## Update to CKEditor&nbsp;5 v27.1.0

_Released on April 21, 2021._

For the entire list of changes introduced in version 27.1.0, see the [release notes for CKEditor&nbsp;5 v27.1.0](https://github.com/ckeditor/ckeditor5/releases/tag/v27.1.0).

Listed below are the most important changes that require your attention when upgrading to CKEditor&nbsp;5 v27.1.0.
Expand All @@ -33,6 +35,8 @@ If you wish to bring back this restriction, see the {@link features/block-quote#

## Update to CKEditor&nbsp;5 v27.0.0

_Released on March 24, 2021._

For the entire list of changes introduced in version 27.0.0, see the [release notes for CKEditor&nbsp;5 v27.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v27.0.0).

Listed below are the most important changes that require your attention when upgrading to CKEditor&nbsp;5 v27.0.0.
Expand Down
6 changes: 5 additions & 1 deletion docs/updating/update-to-28.md
Expand Up @@ -6,13 +6,17 @@ order: 96
modified_at: 2021-06-01
---

# Update to CKEditor&nbsp;5 v28.x

<info-box>
When updating your CKEditor&nbsp;5 installation, make sure **all the packages are the same version** to avoid errors.

For custom builds, you may try removing the `package-lock.json` or `yarn.lock` files (if applicable) and reinstalling all packages before rebuilding the editor. For best results, make sure you use the most recent package versions.
</info-box>

# Update to CKEditor&nbsp;5 v28.0.0
## Update to CKEditor&nbsp;5 v28.0.0

_Released on June 7, 2021._

For the entire list of changes introduced in version 28.0.0, see the [release notes for CKEditor&nbsp;5 v28.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v28.0.0).

Expand Down
61 changes: 32 additions & 29 deletions docs/updating/update-to-29.md
Expand Up @@ -4,17 +4,18 @@ meta-title: Update to version 29.x | CKEditor 5 Documentation
menu-title: Update to v29.x
order: 95
---
# Update to CKEditor&nbsp;5 v29.x

<info-box>
When updating your CKEditor&nbsp;5 installation, make sure **all the packages are the same version** to avoid errors.

For custom builds, you may try removing the `package-lock.json` or `yarn.lock` files (if applicable) and reinstalling all packages before rebuilding the editor. For best results, make sure you use the most recent package versions.
</info-box>

# Update to CKEditor&nbsp;5 v29.x

## Update to CKEditor&nbsp;5 v29.1.0

_Released on August 4, 2021._

For the entire list of changes introduced in version 29.1.0, see the [release notes for CKEditor&nbsp;5 v29.1.0](https://github.com/ckeditor/ckeditor5/releases/tag/v29.1.0).

Listed below are the most important changes that require your attention when upgrading to CKEditor&nbsp;5 v29.1.0.
Expand Down Expand Up @@ -60,40 +61,42 @@ Here is an example of changes you may need for proper integration with the {@lin
```js
// Old code.
ClassicEditor
.create( ..., {
// ...
link: {
decorators: {
addGreenLink: {
mode: 'automatic',
attributes: {
class: 'my-green-link',
.create( ..., {
// ...
link: {
decorators: {
addGreenLink: {
mode: 'automatic',
attributes: {
class: 'my-green-link',
style: 'color:green;'
}
}
}
}
} )
}
}
}
}
} )
// New code.
ClassicEditor
.create( ..., {
// ...
link: {
decorators: {
addGreenLink: {
mode: 'automatic',
classes: 'my-green-link',
.create( ..., {
// ...
link: {
decorators: {
addGreenLink: {
mode: 'automatic',
classes: 'my-green-link',
styles: {
color: 'green'
}
}
}
}
} )
}
}
}
} )
```

## Update to CKEditor&nbsp;5 v29.0.0

_Released on July 7, 2021._

This migration guide enumerates the most important changes that require your attention when upgrading to CKEditor&nbsp;5 v29.0.0 due to changes introduced in the {@link module:image/image~Image} plugin and some other image-related features.

For the entire list of changes introduced in version 29.0.0, see the [release notes for CKEditor&nbsp;5 v29.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v29.0.0).
Expand Down Expand Up @@ -351,9 +354,9 @@ ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ CKFinder, Image, ... ],
toolbar: [ 'uploadImage', ... ],
ckfinder: {
// Feature configuration.
}
ckfinder: {
// Feature configuration.
}
} )
.then( ... )
.catch( ... );
Expand Down
30 changes: 17 additions & 13 deletions docs/updating/update-to-30.md
Expand Up @@ -5,13 +5,17 @@ menu-title: Update to v30.x
order: 94
---

# Update to CKEditor&nbsp;5 v30.x

<info-box>
When updating your CKEditor&nbsp;5 installation, make sure **all the packages are the same version** to avoid errors.

For custom builds, you may try removing the `package-lock.json` or `yarn.lock` files (if applicable) and reinstalling all packages before rebuilding the editor. For best results, make sure you use the most recent package versions.
</info-box>

# Update to CKEditor&nbsp;5 v30.0.0
## Update to CKEditor&nbsp;5 v30.0.0

_Released on September 29, 2021._

For the entire list of changes introduced in version 30.0.0, see the [release notes for CKEditor&nbsp;5 v31.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v31.0.0).

Expand All @@ -36,25 +40,25 @@ Here is the exact change you need to introduce for proper integration with the n
```js
// Before v30.0.0.
ClassicEditor
.create( ..., {
// ...
toolbar: {
items: [ ... ],
.create( ..., {
// ...
toolbar: {
items: [ ... ],
viewportTopOffset: 100
}
} )
}
} )

// Since v30.0.0.
ClassicEditor
.create( ..., {
// ...
toolbar: {
items: [ ... ]
},
.create( ..., {
// ...
toolbar: {
items: [ ... ]
},
ui: {
viewportOffset: {
top: 100
}
}
} )
} )
```

0 comments on commit 0c7c1ee

Please sign in to comment.