Подключение ckeditor. Установка pluginов в CKEditor. Базовые примеры

CKEditor 4 - WYSIWYG редактор статей. Он позволяет выполнять гибкое форматирование текстов, включающее работу со стилями, списками, ссылками, графическими изображениями и т.д.

Интерфейс

Рисунок 1. Окно редактора

В окне WYSIWYG редактора находятся следующие панели кнопок:

	Переключение режима просмотра
	Печать и выбор шаблона статьи
	Работа с буфером обмена (вырезать, копировать, вставить, отменить)
	Поиск и замена
	Создание форм
	Вставка спойлеров (сворачиваемого текста) и разрывов страниц
	Изменение стиля текста
	Форматирование абзацев
	Вставка ссылок
	Вставка медиа-контента сторонних сайтов
	Вставка объектов
	Выбор стиля форматирования
	Выбор форматирования абзаца
	Выбор шрифта
	Выбор размера шрифта
	Выбор цвета текста или фона
	Проверка орфографии
	Дополнительные возможности просмотра (отобразить блоки и развернуть)

В нижней панели окна редактора содержится информация о текущем теге и статистика текста:

Переключение режима просмотра

В панели переключения режимов просмотра редактора находятся кнопки:

Печать и выбор шаблона статьи

В панели печати и выбора шаблона статьи находятся следующие кнопки:

Печать статьи на принтере. После нажатия на данную кнопку откроется стандартное диалоговое окно с предложением выбрать принтер и отправить на печать текст статьи.

Выбор шаблона статьи:

Image and Title – шаблон статьи, содержащей заголовок, изображение и текст
Strange Template – шаблон статьи, текст которой разделен на две колонки
Text and Table – шаблон статьи, содержащей заголовок, таблицу и текст

Шаблон представляет собой предопределенный HTML-код разметки будущей статьи. Описание шаблонов содержится в файле «plugins/templates/templates/default.js». Можно добавить пользовательские шаблоны в данный файл или создать отдельный файл с шаблонами и настроить CKEditor на работу с ним.

Работа с буфером обмена

В редакторе доступны следующие операции по работе с буфером обмена:

	Кнопка «Вырезать». Вырезает выделенный фрагмент статьи и помещает его в буфер обмена.
	Кнопка «Копировать». Копирует выделенный фрагмент статьи и помещает его в буфер обмена.
	Кнопка «Вставить». Вставляет в статью содержимое буфера обмена. Если текст вставляется из внешних приложений, например, MS Office, при вставке будут включены все теги, связанные с форматированием. Большая часть данных тегов является лишней и должна быть удалена, что затрудняет редактирование статьи. Поэтому данной кнопкой рекомендуется пользоваться только для вставки неформатированных текстов.
	Кнопка «Вставить только текст». Аналогична кнопке «Вставить». При вставке фрагмента статьи из буфера обмена его форматирование полностью удаляется.
	Кнопка «Вставить из Word». Аналогично кнопке «Вставить». Используется, если требуется сохранить форматирование вставляемого фрагмента. При вставке оптимальным образом сохраняется внешний вид текста и удаляется ненужное форматирование. Рекомендуется использовать при копировании текста из MS Word или других приложений MS Office.
	Кнопка «Отменить». Используется для отмены последнего выполненного изменения.
	Кнопка «Повторить». Используется для возврата последнего отмененного изменения.

Поиск и замена

В панели поиска и замены находятся следующие кнопки:

Поиск

При нажатии на кнопку «Найти» открывается окно поиска:

В поле «Найти» вводится искомый фрагмент текста.

Доступны следующие опции:

По всему тексту. Если опция включена, то при достижении конца статьи поиск будет продолжен с ее начала. Если опция отключена, то при достижении конца статьи поиск будет завершен.

Для выполнения поиска необходимо ввести искомый фрагмент, включить требуемые опции поиска и нажать кнопку «Найти». Редактор выполнит поиск и выделит первый найденный фрагмент в тексте статьи. При каждом повторном нажатии на кнопку «Найти» редактор будет выполнять поиск далее по тексту и выделять очередной найденный фрагмент.

Замена

При нажатии на кнопку «Заменить» открывается окно замены фрагмента текста:

В поле «Найти» вводится искомый фрагмент текста. В поле «Заменить на» текст, на который требуется заменить искомый фрагмент.

Доступны следующие опции:

Учитывать регистр. Если опция включена, то при поиске будет учитываться регистр символов искомого фрагмента.
Только слово целиком. Если опция включена, то редактор будет искать введенный фрагмент как слово целиком. В результаты поиска не попадут слова, для которых введенный фрагмент является частью.
По всему тексту. Если опция включена, то при достижении конца статьи поиск будет продолжен с ее начала. Если опция выключена, то при достижении конца статьи поиск будет завершен.

Для выполнения замены необходимо заполнить поля «Найти» и «Заменить на», включить требуемые опции поиска и нажать кнопку «Заменить» или «Заменить все». При нажатии на кнопку «Заменить» редактор выполнит поиск и заменит первый найденный фрагмент в тексте статьи. При каждом повторном нажатии на кнопку «Заменить» редактор будет выполнять поиск далее по тексту и заменять очередной найденный фрагмент.
При нажатии на кнопку «Заменить все» редактор сразу выполнит поиск и замену требуемого фрагмента по всему тексту статьи.

Создание форм

Формы предназначены для ввода данных пользователем в окне браузера, передаче их обработчику и, при необходимости, вывода результатов обработки. Например: форма регистрации пользователя, форма обратной связи и т.д.

В панели создания форм находятся следующие кнопки:

	Кнопка «Форма». Используется для вставки формы в статью. В HTML-коде форме соответствует тег form .
	Кнопка «Чекбокс». Используется для вставки чекбоксов (флаговых кнопкок, галочек) в форму или в статью.
	Кнопка «Радиокнопка». Используется для вставки радиокнопок (переключателей) в форму или в статью.
	Кнопка «Текстовое поле». Используется для вставки однострочного поля для ввода текста.
	Кнопка «Многострочное текстовое поле». Используется для вставки многострочного поля для ввода текста.
	Кнопка «Выпадающий список». Используется для вставки выпадающего списка.
	Кнопка «Кнопка». Используется для вставки кнопки в форму или в статью.
	«Кнопка-изображение». Используется для вставки изображения, используемого в качестве кнопки.
	Кнопка «Скрытое поле». Используется для вставки скрытого поля в форму или в статью.

Форма

При нажатии на кнопку «Форма» открывается окно настроек новой формы.

В окне настроек формы находятся следующие поля:

Имя	Произвольное имя формы. В HTML-коде – параметр name.
Действие	URL-адрес программы или документа, который обрабатывает данные, введенные в форму. В HTML-коде – параметр action.
Идентификатор	Уникальный идентификатор формы. В HTML-коде – параметр id.
Кодировка	Выбор способа кодирования данных формы. В HTML-коде – параметр enctype. Доступные значения: text/plain – пробелы заменяются знаком «+», буквы и другие символы не кодируются; multipart/form-data – данные не кодируются. Применяется при отправке файлов через форму; application/x-www-form-urlencoded – пробелы заменяются знаком «+», символы отличные от латинской раскладки (буквы русского алфавита и пр.) кодируются их шестнадцатеричными значениями.
Цель	Выбор окна или фрейма, в который обработчик данных формы будет выводить результаты обработки. В HTML-коде – параметр target. Доступные значения: Новое окно (_blank) – выводит результаты в новом окне браузера; Главное окно (_top) – игнорирует фреймы и выводит результаты в полном окне браузера. Если фреймов нет, то работает аналогично _self (см. ниже); Текущее окно (_self) – выводит результаты в текущее окно; Родительское окно (_parent) – выводит результаты в родительском фрейме. Если фреймов нет, то работает аналогично _self.
Метод	Выбор используемого метода HTTP-запроса. В HTML-коде – параметр method. Доступные значения: GET – для передачи данных используется URL-адрес вызываемого обработчика. Передаваемые данные отображаются в адресной строке браузера. Объем передаваемых данных ограничен максимально допустимой длиной адресной строки браузера; POST – для передачи данных используется тело запроса веб-браузера к серверу. Передаваемые данные не отображаются в браузере. Объем передаваемых данных не ограничен. Метод позволяет передавать файлы.

Чекбокс

Чекбокс предназначен для отображения элементов управления, которые включают или выключают какое-либо свойство или опцию. Такой элемент может принимать одно из двух значений: да или нет. В HTML-коде данному элементу соответствует тег input type="checkbox" . При нажатии на кнопку «Чекбокс» открывается окно настроек нового элемента.

В окне настроек элемента «Чекбокс» находятся следующие поля:

Имя - произвольное имя элемента. В HTML-коде – параметр name;
Значение - выполняет роль уникального идентификатора элемента. В HTML-коде – параметр value;
Выбрано - если опция включена, то по умолчанию данный элемент будет помечен.

Радиокнопка

Элемент «Радиокнопка» предназначен для отображения группы значений с возможностью выбора только одного из них. Т.е. элементы в пределах группы являются взаимоисключающими. Каждый элемент может принимать одно из двух значений: да или нет. В HTML-коде данному элементу соответствует тег input type="radio" . При нажатии на кнопку «Радиокнопка» открывается окно настроек нового элемента.

В окне настроек элемента «Радиокнопка» находятся следующие поля:

Элементы в пределах группы должны иметь одно и то же имя.
Значение - выполняет роль уникального идентификатора элемента. В HTML-коде – параметр value.
Выбрано - если опция включена, то по умолчанию данный элемент будет помечен. В пределах группы данное свойство должно быть включено только у одного элемента. Если оно включено у нескольких элементов, то помечен будет только последний из них.

Текстовое поле

Элемент «Текстовое поле» предназначен для ввода текстовой строки пользователем. В HTML-коде данному элементу соответствует тег input type="text" . При нажатии на кнопку «Текстовое поле» открывается окно настроек нового поля.

Имя - произвольное имя элемента. В HTML-коде – параметр name.
Значение - содержит текст, который будет отображаться в текстовом поле по умолчанию. В HTML-коде – параметр value.
Ширина поля (в символах) - длина области ввода текстового поля в символах. В HTML-коде – параметр size.
Макс. количество символов - максимальная длина строки, которую можно ввести в текстовое поле, в символах. В HTML-коде – параметр maxlength.
Тип содержимого - тип содержимого текстового поля. В HTML-коде – параметр type. Перед отправкой данных на сервер выполняется их проверка на соответствие установленному типу.

Доступные типы содержимого:

Email – текстовое поле содержит адрес электронной почты;
Пароль – текстовое поле содержит пароль;
Поиск – текстовое поле предназначено для ввода искомого текста;
Номер телефона – текстовое поле содержит телефонный номер;
Текст – текстовое поле содержит обычную строку;
Ссылка – текстовое поле содержит URL-адрес.

Многострочное текстовое поле

Элемент «Многострочное текстовое поле» предназначен для ввода пользователем текста, состоящего из нескольких строк. В HTML-коде данному элементу соответствует парный тег textarea . При нажатии на кнопку «Многострочное текстовое поле» открывается окно настроек нового поля.

В окне настроек элемента «Текстовое поле» находятся следующие поля:

Имя - произвольное имя элемента. В HTML-коде – параметр name.
Колонок - ширина поля в символах. В HTML-коде – параметр cols.
Строк - высота поля в строках. В HTML-коде – параметр rows.
Значение - Содержит текст, который будет отображаться в текстовом поле по умолчанию.

Выпадающий список

Элемент «Выпадающий список» предназначен для отображения списка множественного выбора или выпадающего списка. В HTML-коде данному элементу соответствует парный тег select . Элементам списка соответствует парный тег option . При нажатии на кнопку «Выпадающий список» открывается окно настроек нового списка.

В окне настроек списка множественного выбора находятся следующие поля:

Имя - произвольное имя элемента. В HTML-коде – параметр name.
Значение - содержит значение элемента списка, который выбран по умолчанию. В HTML-коде для данного элемента в теге option устанавливается параметр selected="selected" .
Размер - высота отображаемой области списка в строках. Если размер равен единице, то будет отображаться выпадающий список. Если размер не указан, то вид списка будет зависеть от параметра «Разрешить выбор нескольких вариантов».

Группа параметров «Доступные варианты»:

Текст - поле ввода отображаемого текста элемента списка. Вводится в паре с полем «Значение». Для добавления пары «Текст – Значение» в список необходимо нажать кнопку «Добавить».
Значение - поле ввода значения элемента списка, передаваемого на сервер. Вводится в паре с полем «текст». Для добавления пары «Текст – Значение» в список необходимо нажать кнопку «Добавить».
Добавить - кнопка добавления введенной пары «Текст – Значение» в список.
Изменить - кнопка изменения выбранного элемента списка. Для изменения необходимо выбрать требуемый элемент в настройках списка, отредактировать содержимое полей «Текст» и «Значение» и нажать кнопку «Изменить». В выбранный элемент будут внесены соответствующие изменения.
Поднять - кнопка перемещения выбранного элемента списка на один уровень выше.
Опустить - кнопка перемещения выбранного элемента списка на один уровень ниже.
Пометить как выбранное - при нажатии на кнопку выбранный элемент списка становится помеченным как выбранный по умолчанию. Значение элемента отображается в поле «Значение» (см. выше). В HTML-коде для данного элемента в теге option устанавливается параметр selected="selected" .
Удалить - кнопка удаления выбранного элемента из списка.
Разрешить выбор нескольких вариантов - если свойство включено, то с помощью клавиши ctrl можно будет выбрать несколько элементов списка. Если размер списка не указан и свойство выключено, то будет отображаться выпадающий список. Если же размер списка не указан и свойство включено, то устанавливается размер списка равный четырем.

Завершение статьи следует…

Table of contents

When creating an editor in your page, it is possible to set up configurations that change many of its aspects. For example:

ClassicEditor .create(document .querySelector("#editor" ), { toolbar : [ "heading" , "|" , "bold" , "italic" , "link" , "bulletedList" , "numberedList" , "blockQuote" ], heading : { options : [ { model : "paragraph" , title : "Paragraph" , class : "ck-heading_paragraph" }, { model : "heading1" , view : "h1" , title : "Heading 1" , class : "ck-heading_heading1" }, { model : "heading2" , view : "h2" , title : "Heading 2" , class : "ck-heading_heading2" } ] } }) .catch(error =>

As you can see, configurations are set by a simple JavaScript object passed to the create() method.

Removing features

Builds come with all features included in the distribution package enabled by default. They are defined as plugins for CKEditor.

In some cases, you may need to have different editor setups in your application, all based on the same build. For that purpose, you need to control the plugins available in the editor at runtime.

In the example below Heading and Link plugins are removed:

// Remove a few plugins from the default setup. ClassicEditor .create(document .querySelector("#editor" ), { removePlugins : [ "Heading" , "Link" ], toolbar : [ "bold" , "italic" , "bulletedList" , "numberedList" , "blockQuote" ] }) .catch(error => { console .log(error); });

Be careful when removing plugins from CKEditor builds using config.removePlugins . If removed plugins were providing toolbar buttons, the default toolbar configuration included in a build will become invalid. In such case you need to provide the updated toolbar configuration as in the example above.

List of plugins

Each build has a number of plugins available. You can easily list all plugins available in your build:

ClassicEditor.builtinPlugins.map(plugin => plugin.pluginName);

Adding features Adding complex features

As CKEditor builds do not include all possible features, the only way to add more features to them is to create a custom build .

Adding simple (standalone) features

There is an exception to every rule. Although it is impossible to add plugins that have dependencies to @ckeditor/ckeditor5-core or @ckeditor/ckeditor5-engine (that includes nearly all existing official plugins) without rebuilding the build, it is still possible to add simple, dependency-free plugins.

import ClassicEditor from "@ckeditor/ckeditor5-build-classic" ; function MyUploadAdapterPlugin ( editor ) { editor.plugins.get("FileRepository" ).createUploadAdapter = function ( loader ) { // ... }; } // Load the custom upload adapter as a plugin of the editor. ClassicEditor .create(document .querySelector("#editor" ), { extraPlugins : [ MyUploadAdapterPlugin ], // ... }) .catch(error => { console .log(error); }); Toolbar setup

In builds that contain toolbars an optimal default configuration is defined for it. You may need a different toolbar arrangement, though, and this can be achieved through configuration.

Each editor may have a different toolbar configuration scheme, so it is recommended to check its documentation. In any case, the following example may give you a general idea:

ClassicEditor .create(document .querySelector("#editor" ), { toolbar : [ "bold" , "italic" , "link" ] }) .catch(error => { console .log(error); });

The above is a strict UI-related configuration. Removing a toolbar item does not remove the feature from the editor internals. If your goal with the toolbar configuration is to remove features, the right solution is to also remove their respective plugins. Check above for more information.

Listing available items

You can use the following snippet to retrieve all toolbar items available in your editor:

Array .from(editor.ui.componentFactory.names());

CKEditor это готовый для использования текстовый рекдактор HTML, созданный для упрощения создания содержания веб страниц. Это WYSIWYG редактор который предоставляет функции редактирования текста непосредственно вашим веб страницам.

CKEditor это приложение с открытым исходным кодом, то есть оно может быть измнено по вашему желанию. Его полезность приходит от активного общества, которое не прекращает развитие приложений с бесплатными add-ons и прозрачным процессом развития (transparent development process).

3- Download CKEditor

У вас есть 4 варианта скачивания CKEditor .

Результат скачивания:

Можете посмотреть примеры CKEditor в папке samples :

4- Базовые примеры:

Все примеры данной статьи содержатся в папке samples в CKEditor который вы скачали. Но я попытаюсь сделать это легче чтобы вам далось легче.

Создать папку myexamples , примеры данной статьи будут находиться в этой папке.

4.1- Заменить элементы Textarea используя JavaScript

Простой пример использование CKEditor.replace(..) чтобы заменить через CKEditor .

replacebycode.html

Replace Textarea by Code Replace Textarea Elements Using JavaScript Code

Hello CKEditor

CKEDITOR.replace("editor1");

Смотрите пример:

Результаты запуска примера:

4.2- Заменить элементы textarea классом name

С имеющие атрибут name, и class ="ckeditor" будет автоматически заменен CKEditor-ом .

Text

replacebyclass.html

Replace Textareas by Class Name Replace Textarea Elements by Class Name

Hello CKEditor

Запуск примера:

4.3- Создать CKEditor с jQuery

Пример создания CKEditor используя JQuery .

jQuery Adapter — CKEditor Sample $(document).ready(function() { $("#editor1").ckeditor(); }); function setValue() { $("#editor1").val($("input#val").val()); } Create Editors with jQuery

Hello CKEditor