Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

i/5692: Added documentation for the config.toolbar.shouldNotGroupWhenFull option #201

Merged
merged 2 commits into from
Nov 20, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/editor/editorconfig.jsdoc
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,9 @@
* toolbar: {
* items: [ 'bold', 'italic', '|', 'undo', 'redo' ],
*
* viewportTopOffset: 30
* viewportTopOffset: 30,
*
* shouldNotGroupWhenFull: true
* }
* };
*
Expand All @@ -162,6 +164,11 @@
* * **`toolbar.viewportTopOffset`** – The offset (in pixels) from the top of the viewport used when positioning a sticky toolbar.
* Useful when a page with which the editor is being integrated has some other sticky or fixed elements
* (e.g. the top menu). Thanks to setting the toolbar offset the toolbar will not be positioned underneath or above the page's UI.
* * **`toolbar.shouldNotGroupWhenFull`** – When set `true`, the toolbar will stop grouping items that wrap to the next line when
* there is not enough space to display them in a single row.
*
* **Note**: For now this option affects {@link module:editor-classic/classiceditor~ClassicEditor} and
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor} only that enable automatic toolbar items grouping by default.
*
* @member {Array.<String>|Object} module:core/editor/editorconfig~EditorConfig#toolbar
*/
Expand Down