Блок предоставляет объект, содержащий набор методов для генерации события в момент прекращения пользовательской активности (т.е. пользователь работает с другим окном или не совершает действий).
Доступен следующий набор событий:
| Имя | Описание |
|---|---|
| idle | Браузер простаивает. |
| wakeup | Пользователь возобновил активность. |
| Имя | Возвращаемое значение | Описание |
|---|---|---|
| start() | - | Запуск отслеживания пользовательской активности. |
| stop() | - | Остановка отслеживания пользовательской активности. |
| isIdle() | Boolean |
Проверка текущего состояния. |
| Модификатор | Допустимые значения | Способы использования | Описание |
|---|---|---|---|
| start | auto |
JS |
Автоматический запуск отслеживания пользовательской активности. |
Блок реализован в технологиях:
jsПодписавшись на события блока можно приостанавливать выполнение операций, например, отображение анимации, при отсутствии пользовательской активности.
Блок наследуется от класса Emitter блока events, что позволяет вызывать его методы.
modules.require(['idle'], function(idle) {
idle
.on({
idle : function() {
// обработчик события idle
},
wakeup : function() {
// обработчик события wakeup
}
})
.start(); // запуск генерации событий
});
idleГенерируется при прекращении пользовательской активности.
wakeupГенерируется в момент возобновления пользовательской активности.
startЗапуск отслеживания пользовательской активности.
Не принимает аргументов.
Не имеет возвращаемого значения.
modules.require(['idle'], function(idle) {
idle.start()
});
stopСлужит для прекращения отслеживания пользовательской активности.
Не принимает аргументов.
Не имеет возвращаемого значения.
modules.require(['idle'], function(idle) {
idle.start() // начинаем отслеживать активность
idle.stop() // прекращаем отслеживать активность
});
isIdleСлужит для проверки наличия пользовательской активности.
Не принимает аргументов.
Возвращаемое значение: Boolean. В случае если активность отсутствует – true.
modules.require(['idle'], function(idle) {
idle.isIdle() // true или false, в зависимости от текущего состояния
});
startДопустимые значения: 'auto'.
Способ использования: подключается в файле зависимостей deps.js.
Автоматический запуск отслеживания пользовательской активности.