{"ErrorMatchV1":"\u0418\u0434\u0435\u043d\u0442\u0438\u0444\u0438\u043a\u0430\u0442\u043e\u0440 \u0434\u043e\u043b\u0436\u0435\u043d \u0441\u043e\u0441\u0442\u043e\u044f\u0442\u044c \u0442\u043e\u044c\u043a\u043e \u0438\u0437 \u0446\u0438\u0444\u0440!"}
BroLib cWords Demo API Documentation

Установить cWords на свой проект? Проще простого!

А вы уже выполнили ряд несложных действий?

- Официальная регистрация вашего интернет ресурса
- Получение персонального ID и копии лицензионного продукта cWords

Теперь установим продукт на сайт..

Важно знать, что BroLib активно использует в основе фреймворк jQuery.
Поэтому для работы плагина необходимо подключить в начале jQuery версии >= 1.7.2!

Подскажите нам, в какой дирректории сайта вы расположили файлы BroLib?

↑ Или вы можете оставить это поле пустым, тогда код, который вы получите будет подразумевать, что файлы BroLib находятся в корневой директории вашего сайта.

Введите сюда ID вашего сайта:

Скопируйте между тэгами head нижеследующий код:

Отлично, почти все готово!

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

Инициализация JavaScript плагина

Нижеследующий код нужно поместить сразу после вышеописанного кода.
<script type="text/javascript">
	$(document).ready(function(){ 
		$('textarea').cWords();
	)}
</script>
Данный код инициализирует плагин cWords на всех имеющихся элементах textarea. Причем плагин будет инициализирован со стандартным набором параметров, которые вы при желании можете легко изменить, просто добавив управляющий объект в аргумент метода cWords. Ниже приведен пример такой инициализации:
<script type="text/javascript">
	$(document).ready(function(){ 
		$('textarea').cWords({
			color_errors: 'yellow', // Цвет подчеркивания неправильных слов - желтый
			type: 'pype', // Тип представления ошибок
			limit_pipe: 2, // Сколько вариантов возможно-правильных слов предлагать пользователю
			time_write: 1000, // Скорость обновления текста
			delimiter: 150 // Кол-во слов, которые входят в одну часть запроса.
					// Таким образом, большой текст делится на части.
		});
	)}
</script>

Разберем все имеющиеся входные параметры

Название параметра Описание Возможные значения
color_error
Каким цветом слова с ошибками будут подчеркнуты.
Цвет в его любом представлении
type
Тип выбора слов. Алгоритм работы программы. Каким образом будет вести себя обработчик ошибок. Будет он предлагать варианты или нет. Осмысленный выбор снизит нагрузку на клиентскую часть пользователя.
  • pipe - Предоставлять пользователю варианты правильных слов.
  • item - Возможно-правильные варианты пользователю не предоставляются! Пользователь видит только подчеркнутые слова.
limit_pipe
Сколько возможно-правильных вариантов предоставить пользователю на выбор. Отнеситесь с осторожностью, т.к. большое значение подразумевает более высокие затраты трафика и нагрузку на клиентскую часть у пользователя.
Любое цифровое значение
time_write
С каким интервал проверять изменения в textarea. Правильная настройка этого параметра позволит сократить нагрузку на клиентскую часть пользователя.
Время в милисекундах
delimiter
Очень удобный параметр при работе с большим объемом текста. Позволяет загружать текст по секциям слов.
Кол-во слов в одной секции

Говоря о кроссбраузерности и стабильности cWords плагина

Команда BroGroup каждый день совершенствует cWords, добавляя в него новые функции и фиксируя старые. Мы стараемся сделать наш продукт максимально стабильным и кроссбраузерным, и на сегодняшний день cWords готов для использования на большинстве современных браузерах:

Браузер Минимальная поддерживающая cWords версия браузера
Internet Explorer icon Internet Explorer Восьмая версия и выше (The false)
Mozilla Firefox icon Mozilla Firefox Третья версия и выше (The false)
Google Chrome icon Google Chrome Третья версия и выше (The false)
Opera icon Opera Версия 12 и выше (The false)
Safari icon Safari Версия 12 и выше (The false)

Стоит отметить, что cWords на этот момент является экспериментальной (beta) версией. Мы не рекомендуем использовать продукт на ресурсах с большим объемом текста в проверяемых textarea (более десяти тысяч символов), а также использовать cWords как основу для своих разработок, связанных с объемными статьями и другими большими текстами!

Заходите на наш ресурс, чтобы посмотреть новости обновлений cWords (вы сможете увидеть самые свежие новости cWords прямо на главной странице сайта) либо вы можете согласиться на email оповещение (оповещение о выходе новой версии продукта cWords). Скачивайте новые версии лицензионного продукта.

Если техническая документация не смогла помочь вам разобраться, либо вы имеете предложения по модернизации и/или развитию проекта, либо вы просто хотите выразить свои эмоции, пишите нам на email – support@brolib.com