Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 4.11 KB

README_ru.md

File metadata and controls

68 lines (53 loc) · 4.11 KB

yii2-widget-timer

Простой widget для отображения таймера в приложениях работающих на yii2

Widget отображающий таймер (на основе jquery plugin).

Отображает время, прошедшее со старта timer в формате ЧЧ:ММ:СС где:

  • ЧЧ - кол-во прошедших с момента запуска часов;
  • ММ - кол-во прошедших с момента запуска минут;
  • CC - кол-во прошедших с момента запуска секунд;

Может быть запущен автоматически и вручную, может быть остановлен, сброшен

Установка

Предпочтительный способ установки через composer. Ознакомьтесь с требовния расширения и его зависимостями в composer.json.

Для установки выполните

$ php composer.phar require aayaresko/yii2-widget-timer "*"

или добавьте

"aayaresko/yii2-widget-timer": "*"

в секцию require вашего composer.json.

Использование

Выполнить загрузку необходимых компонентов и подготовить widget

use aayaresko\timer\Timer
Timer::widget([
    'options' => [
        'container' => '.timer',
        'autoStart' => true,
    ]
])

Рабочий экземпляр plugin будет доступен в глобальной области видимости под именем $.fn.timer.worker. Счётчик будет запущен автоматически после инициализации (параметр 'autoStart') и отобразится в блоке с классом 'timer' (параметр 'container').

Запустить счётчик

    $.fn.timer.worker.go();

Конфигурация plugin осуществляется через параметры:

  • container - селектор html элемента, в котором необходимо отобразить таймер (по умолчанию '.timer');
  • autoStart – запустить таймер сразу же после инициализации (по умолчанию - true);
  • hours – начать счёт часов с этого значение (по умолчанию '00');
  • minutes – начать счёт минут с этого значение (по умолчанию '00');
  • seconds – начать счёт секунд с этого значение (по умолчанию '00');
  • animate - анимировать таймер при запусе (мигание);
  • animationSpeed - скорость анимации;
  • animationTimes - количество повторений;

Управление plugin осуществляется через методы:

  • init(value) - инициализирует таймер, оформит html-содержимое container в виде таймера (если value == false) или запустит таймер автоматически (если value == true), при этом, если таймер был ранее запущен автоматически остановит таймер и обнулит значения часов, минут, сукунд;
  • go() - запустит таймер;
  • stop(value) - остановит таймер сохранив текущие значение часов, минут, секунд (если value == false) или обнулит их (если value == true);
  • flush() - сбросит таймер, обнулив значения часов, минут, секунд.
  • timeAsString() - вернёт текущие значения таймера в формте строки.

License

yii2-widget-timer выпущен и распространяется согласно лицензии BSD 3-Clause. Подробнеес смотри LICENSE.md.