Плагин: Список событий

Все события являются необязательными. Однако некоторые возможности (например, добавление кнопок инструмента) зависят от конкретных событий.

Каждое событие имеет обратный вызов функции, которая будет вызвана при активации события.

init

Вызывается перед началом инициализации плагина. В этом событии можно настроить свойства плагина. Это событие будет вызываться только один раз. Обратите внимание, что DOM плагина ещё не готов.

Аргументы обратного вызова:

• нет

Пример:

myPlugin.on('init', function() {
	// выполнение каких-либо действий для инициализации плагина
	this.list = []; // `this` == `myPlugin`
});

renderTab

Вызывается во время попытки vConsole создать новую вкладку для плагина. Это событие будет вызываться только один раз. После привязки этого события, vConsole получит HTML из вашего обратного вызова для отображения вкладки. Новая вкладка обязательно будет добавлена, если вы привяжете это событие, независимо от того, какой HTML вкладки вы установите. Не привязывайте это событие, если вам не требуется добавление новой вкладки.

Аргументы обратного вызова:

• (необходимый) function(html, options): обратный вызов функции, который принимает содержание HTML новой вкладки. html может быть строкой HTML или объектом HTMLElement (или объектом, поддерживающим метод appendTo(), таким как объект jQuery), а также необязательным объектом с опциями вкладки.Опции вкладки — это объект с следующими свойствами:

Пример:

myPlugin.on('renderTab', function(callback) {
	var html = '<div>Привет</div>';
	callback(html);
});

addTopBar

Вызывается во время попытки vConsole добавить новые кнопки вкладок под панелью вкладок. Это событие будет вызываться только один раз.

Аргументы обратного вызова:

• (Обязательный) function(btnList): обратный вызов функции, которая принимает массив кнопок вкладок.

Кнопка вкладки — это объект с следующими свойствами:

Пример:

var type;
myPlugin.on('addTopBar', function(callback) {
	var btnList = [];
	btnList.push({
		name: 'Apple',
		className: '',
		data: {type: 'apple'},
		onClick: function(event, data) {
			if (type !== data.type) {
				// `this` указывает на текущую кнопку
				type = data.type;
			} else {
				return false;
			}
		}
	});
	btnList.push({
		name: 'Orange',
		className: '',
		data: {type: 'orange'},
		onClick: function(event, data) {
			type = data.type;
		}
	});
	callback(btnList);
});
```## addTool
Срабатывает при попытке vConsole добавить новые кнопки инструмента для плагина. Это событие будет срабатывать только один раз.

##### Аргументы обратного вызова:

- (обязательный) function(toolList): обратный вызов, который получает массив объектов кнопок инструмента.

Объект кнопки инструмента имеет следующие свойства:

Свойство | Тип | Обязательность | Описание
-------- | -------- | -------- | --------
name     | string   | обязательный | Отображаемое имя кнопки.
data     | object   | необязательный | Личные данные кнопки в формате ключ-значение.
global   | boolean  | необязательный, значение по умолчанию `false` | Когда `false`, кнопка скрывается при переходе на другой вкладок. Когда `true`, кнопка доступна во всех вкладках.
onClick  | (event, data) => void | обязательный | Обратный вызов при нажатии пользователя на кнопку.

##### Пример:

```javascript
myPlugin.on('addTool', function(callback) {
	var toolList = [];
	toolList.push({
		name: 'Перезагрузка',
		global: false,
		data: {},
		onClick: function(event, data) {
			location.reload();
		}
	});
	callback(toolList);
});

готово

Срабатывает после завершения всех процессов инициализации. Это событие будет срабатывать только один раз. Теперь плагин установлен и его DOM готов к использованию.

Аргументы обратного вызова:

• отсутствуют

Пример:

myPlugin.on('готово', function() {
	// сделать что-то...
});

удалить

Срабатывает перед началом процесса деинсталляции плагина. Это событие будет срабатывать только один раз.Примечание: Это событие может быть вызвано до события init, если вы удалите плагин до того, как vConsole будет готов.

Аргументы обратного вызова:

• отсутствуют

Пример:

myPlugin.on('delete', function() {
	// сделать что-то...
});

показать

Срабатывает при открытии вкладки. Только плагины, привязанные к renderTab, будут получать это событие.

Аргументы обратного вызова:

• отсутствуют

Пример:

myPlugin.on('show', function() {
	// выполните какое-либо действие
});

скрыть

Вызывается, когда вкладка скрывается. Только плагин, привязанный с помощью renderTab, получает это событие.

Аргументы обратного вызова:

• отсутствуют

Пример:

myPlugin.on('hide', function() {
	// выполните какое-либо действие
});

показать консоль

Вызывается, когда vConsole становится видимой.

Аргументы обратного вызова:

• отсутствуют

Пример:

myPlugin.on('showConsole', function() {
	// выполните какое-либо действие
});

скрыть консоль

Вызывается, когда vConsole скрывается.

Аргументы обратного вызова:

• отсутствуют

Пример:

myPlugin.on('hideConsole', function() {
	// выполните какое-либо действие
});

обновление опций

Вызывается при вызове vConsole.setOption().

Аргументы обратного вызова:

• отсутствуют

Пример:

myPlugin.on('updateOption', function() {
	// выполните какое-либо действие
});
```[Назад к содержанию](./a_doc_index.md)