README_EN.md

Demo

• Full demo with plugins

Overview

A smartbox library allows to start one application on a few smartTV platforms.

Currently supported platforms:

• Samsung SmartTv 2011+
• Lg SmartTv
• Philips 2012+

To add your own platform please see the platform documentation

Initialisation

Smartbox has three dependencies:

• jQuery(1.8.1+)
• Underscore(или lodash)
• Event Emitter( Backbone или Frontbone ) for the player plugin

Собранная версия библиотеки находится в папке /dist

Плагины библиотеки

• Методы отдельных платформ
• Консоль Лог
• Навигация
  • Инициализация и методы
  • Алгоритм
  • Продвинутое использование
• Поля ввода
• Клавиатура(виртуальная)
• Голосовое управление
• Легенда @todo_doc
• Плеер

Как пользоваться библиотекой

Для использования всех плагинов и функций библиотеки необходимо оборачивать код как callback SB.ready

    SB.ready(function(){
        // your code
    });

SB.ready будет выполнен после всех коллбеков jQuery.ready, $(function(){}), $.ready(function(){});

Методы бибилиотеки

• isInited() проверка инициализации библиотеки. Возвращает true или false

    SB.isInited();
  

• ready(func) выполняет код функции func после инициализации библиотеки

    SB.ready(function(){
        // your code
    });
  

• readyForPlatform(platform, cb) выполняет код функции func после инициализации библиотеки, если текущая платформа - platform

    SB.readyForPlatform('samsung', function(){
        // code for samsung
    });
  

Конфигурирование библиотеки

Все конфигурации библиотеки находятся в объекте SB.platform

        SB.config = {
          /**
           * Платформа, которая будет использоваться в случае, когда detectPlatform вернул false
           * ex: browser, samsung, lg
           * @type: {String}
           */
          defaultPlatform: 'browser'
        }

Автотесты

Запуск автотестов Jasmine