Документация

Внешняя форма настроек

Внешняя форма настроек представляет из себя iframe-виджет.

В качестве содержимого формы настроек можно использовать любую HTML-страницу. Для этого нужно указать ее URL в атрибуте src тега <widget:preferences>:

<widget:preferences src="http://example.com/MyWidgetCustomPreferenceForm.html">
    <preference name="showDate" type="boolean" />
    <preference name="..." type="..."/>
       ... 
</widget:preferences>

Во вложенных тегах <preference> должны быть перечислены все настройки, которые используются для хранения параметров работы виджета. Изменения пользовательских настроек обрабатываются с помощью виджетного JS API.

Параметры формы настроек

АтрибутЗначение
src Адрес источника загрузки HTML-страницы с формой настроек виджета.
width Ширина формы настроек. По умолчанию ширина внешней формы настроек равна 400 пикселов.
height Высота формы настроек.

Оформление формы настроек

К оформлению внешней формы настроек предъявляются следующие требования:

  • На форме должны находиться элементы интерфейса (кнопки, ссылки) для управления настройками:
    • Сохранить (OK) ― сохраняет настройки, закрывает форму. См. описание метода API savePreferences.
    • Закрыть (Отмена) ― закрывает форму без изменения настроек. См. описание метода API hidePreferences.
    • Сбросить настройки ― сбрасывает настройки виджета, восстанавливая для них значения по умолчанию. См. описание метода API dropPreferences.
  • У формы не должно быть полосы прокрутки и отступов по краям.
  • Шрифт основного текста ― Arial 13px, мелкого, если он необходим, ― Verdana 11px. Меньший размер допускается, если он не влияет на удобочитаемость текста.
  • Цвет основного текста ― чёрный.

Хороший пример оформления

Форма настроек для виджета Пробки на маршруте.

Плохой пример оформления

Пример приведен только в целях ознакомления. На форме настроек отстуствуют кнопки, позволяющие восстановить значения по умолчанию или закрыть форму без изменения параметров виджета.

параметры форма настроекпользовательскаявнешняя