Skip to content

Commit

Permalink
Merge stable into master
Browse files Browse the repository at this point in the history
  • Loading branch information
CKTravisBot authored Jan 9, 2023
2 parents 1b95b17 + 55b999c commit cb1d04c
Show file tree
Hide file tree
Showing 10 changed files with 92 additions and 82 deletions.
8 changes: 4 additions & 4 deletions packages/ckeditor5-autoformat/docs/features/autoformat.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@ import Autoformat from '@ckeditor/ckeditor5-autoformat/src/autoformat';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Autoformat, ... ],
toolbar: [ ... ]
plugins: [ Autoformat, /* ... */ ],
toolbar: [ /* ... */ ]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box hint>
Expand Down
4 changes: 2 additions & 2 deletions packages/ckeditor5-basic-styles/docs/features/basic-styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ ClassicEditor
items: [ 'bold', 'italic', 'underline', 'strikethrough', 'code', 'subscript', 'superscript' ]
}
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box info>
Expand Down
13 changes: 7 additions & 6 deletions packages/ckeditor5-block-quote/docs/features/block-quote.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ import BlockQuote from '@ckeditor/ckeditor5-block-quote/src/blockquote';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ BlockQuote, ... ],
toolbar: [ 'blockQuote', ... ]
plugins: [ BlockQuote, /* ... */ ],
toolbar: [ 'blockQuote', /* ... */ ]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box info>
Expand Down Expand Up @@ -99,9 +99,10 @@ ClassicEditor
extraPlugins: [ DisallowNestingBlockQuotes ],

// The rest of the configuration.
// ...
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box>
Expand Down
16 changes: 8 additions & 8 deletions packages/ckeditor5-code-block/docs/features/code-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ ClassicEditor
]
}
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

{@snippet features/code-block-custom-languages}
Expand All @@ -84,8 +84,8 @@ ClassicEditor
]
}
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box>
Expand Down Expand Up @@ -150,11 +150,11 @@ import CodeBlock from '@ckeditor/ckeditor5-code-block/src/codeblock';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ CodeBlock, ... ],
toolbar: [ 'codeBlock', ... ]
plugins: [ CodeBlock, /* ... */ ],
toolbar: [ 'codeBlock', /* ... */ ]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box info>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ import FindAndReplace from '@ckeditor/ckeditor5-find-and-replace/src/findandrepl

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ FindAndReplace, ... ],
toolbar: [ 'findAndReplace', ... ],
plugins: [ FindAndReplace, /* ... */ ],
toolbar: [ 'findAndReplace', /* ... */ ],
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box info>
Expand Down
64 changes: 36 additions & 28 deletions packages/ckeditor5-font/docs/features/font.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ ClassicEditor
'heading', 'bulletedList', 'numberedList', 'fontFamily', 'undo', 'redo'
]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

{@snippet features/custom-font-family-options}
Expand All @@ -80,14 +80,16 @@ ClassicEditor
.create( document.querySelector( '#editor' ), {
fontFamily: {
options: [
// Font family configuration options are described in the "Configuring the font family feature" section.
// ...
],
supportAllValues: true
},
// More of editor's config.
// ...
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

## Configuring the font size feature
Expand Down Expand Up @@ -151,8 +153,8 @@ ClassicEditor
'heading', 'bulletedList', 'numberedList', 'fontSize', 'undo', 'redo'
]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

{@snippet features/custom-font-size-named-options}
Expand Down Expand Up @@ -187,8 +189,8 @@ ClassicEditor
'heading', 'bulletedList', 'numberedList', 'fontSize', 'undo', 'redo'
]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

{@snippet features/custom-font-size-numeric-options}
Expand All @@ -203,13 +205,15 @@ ClassicEditor
fontSize: {
options: [
// Numerical values.
// ...
],
supportAllValues: true
},
// More of editor's config.
// ...
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box info>
Expand Down Expand Up @@ -258,7 +262,7 @@ ClassicEditor
label: 'White',
hasBorder: true
},

// More colors.
// ...
]
},
Expand All @@ -284,16 +288,16 @@ ClassicEditor
color: 'hsl(120, 75%, 60%)',
label: 'Green'
},

// More colors
// ...
]
},
toolbar: [
'heading', 'bulletedList', 'numberedList', 'fontColor', 'fontBackgroundColor', 'undo', 'redo'
]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

### Changing the geometry of the color grid
Expand All @@ -307,24 +311,26 @@ ClassicEditor
.create( document.querySelector( '#editor' ), {
fontColor: {
colors: [
// 9 colors defined here...
// 9 colors defined here.
// ...
]

columns: 3, // so, you can display them in 3 columns.

// Optional configuration of the number of document colors.
// ...
},
fontBackgroundColor: {
columns: 6,

// Background color options.
// ...
},
toolbar: [
'heading', 'bulletedList', 'numberedList', 'fontColor', 'fontBackgroundColor', 'undo', 'redo'
]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

### Documents colors
Expand All @@ -343,20 +349,22 @@ ClassicEditor
// And 12 document colors (2 rows of them).
documentColors: 12,

// Optional available font colors configuration.
// ...
},
fontBackgroundColor: {
// Remove the "Document colors" section.
documentColors: 0,

// Background color options.
// ...
},
toolbar: [
'heading', 'bulletedList', 'numberedList', 'fontColor', 'fontBackgroundColor', 'undo', 'redo'
]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

## Installation
Expand All @@ -374,11 +382,11 @@ import Font from '@ckeditor/ckeditor5-font/src/font';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Font, ... ],
toolbar: [ 'fontSize', 'fontFamily', 'fontColor', 'fontBackgroundColor', ... ]
plugins: [ Font, /* ... */ ],
toolbar: [ 'fontSize', 'fontFamily', 'fontColor', 'fontBackgroundColor', /* ... */ ]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

You can also add just one or a selected few of the font features to your plugin list and the toolbar configuration:
Expand All @@ -388,11 +396,11 @@ import FontFamily from '@ckeditor/ckeditor5-font/src/fontfamily';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ FontFamily, ... ],
toolbar: [ 'fontFamily', ... ]
plugins: [ FontFamily, /* ... */ ],
toolbar: [ 'fontFamily', /* ... */ ]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box info>
Expand Down
12 changes: 6 additions & 6 deletions packages/ckeditor5-heading/docs/features/title.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ To change the title placeholder, use the {@link module:heading/title~TitleConfig
```js
ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Title, ... ],
plugins: [ Title, /* ... */ ],
title: {
placeholder: 'My custom placeholder for the title'
},
placeholder: 'My custom placeholder for the body'
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

## Installation
Expand All @@ -60,10 +60,10 @@ import Title from '@ckeditor/ckeditor5-heading/src/title';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Title, ... ]
plugins: [ Title, /* ... */ ]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box info>
Expand Down
20 changes: 10 additions & 10 deletions packages/ckeditor5-indent/docs/features/indent.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import Indent from '@ckeditor/ckeditor5-indent/src/indent';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Indent, ... ],
plugins: [ Indent, /* ... */ ],
toolbar: {
items: [ 'heading', '|', 'outdent', 'indent', '|', 'bulletedList', 'numberedList', '|', 'undo', 'redo' ]
},
Expand All @@ -61,8 +61,8 @@ ClassicEditor
unit: 'em'
}
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

### Using CSS classes
Expand All @@ -77,7 +77,7 @@ import IndentBlock from '@ckeditor/ckeditor5-indent/src/indentblock';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Indent, IndentBlock, ... ],
plugins: [ Indent, IndentBlock, /* ... */ ],
toolbar: {
items: [ 'heading', '|', 'outdent', 'indent', '|', 'bulletedList', 'numberedList', '|', 'undo', 'redo' ]
},
Expand All @@ -89,8 +89,8 @@ ClassicEditor
]
}
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

Using classes instead of fixed units (`px` or `em`) has another advantage &mdash; you retain control over what indentation levels are used in the documents. For instance, you can limit indentation to 2 or 3 different levels and there is no way the users can go beyond that. In the example above, the `.custom-block-indent-c` class level is the maximum allowed indentation value. This should help keep your content clean and predictable.
Expand Down Expand Up @@ -148,11 +148,11 @@ import IndentBlock from '@ckeditor/ckeditor5-indent/src/indentblock';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Indent, IndentBlock, ... ],
toolbar: [ 'outdent', 'indent', ... ]
plugins: [ Indent, IndentBlock, /* ... */ ],
toolbar: [ 'outdent', 'indent', /* ... */ ]
} )
.then( ... )
.catch( ... );
.then( /* ... */ )
.catch( /* ... */ );
```

<info-box info>
Expand Down
Loading

0 comments on commit cb1d04c

Please sign in to comment.