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

В этом разделе собрана техническая документация ко всем компонентам, необходимым для создания Яндекс.Виджетов, а также для эффективной работы с ними.

Перед изучением документации рекомендуем ознакомиться с глоссарием, который содержит краткие определения основных терминов, используемых в наших текстах.

Быстрый старт

В этом разделе содержатся практические примеры, которые помогут быстро включиться в процесс разработки Яндекс.Виджетов. Примеры рассчитаны на читателей с разным уровнем подготовки:

• Hello, world! - пример помогает понять основы работы с виджетами, начиная с создания и заканчивая добавлением их в каталог.

• Конвертор величин измерения расстояний - пример описывает создание виджета с применением JavaScript и виджетного API. Рассматривается механизм размещения тела виджета на стороннем сервере.

Руководство разработчика

Здесь можно найти подробную информацию о Яндекс.Виджетах, включая особенности их создания, загрузки на Яндекс и размещения в каталоге виджетов. Основные разделы руководства:

• Концепции - что такое виджеты в целом и Яндекс.Виджеты в частности.

• Процедуры - инструкции по созданию виджетов, их загрузке на Яндекс и добавлению в каталог виджетов.

• Справочная информация - подробное описание свойств и пользовательских настроек виджета.

• Примеры виджетов - примеры работающих виджетов.

• Распространенные ошибки - обзор типичных ошибок разработчиков.

• Проблемы и решения - способы решения известных проблем, которые могут возникнуть у разработчиков виджетов.

• Приложения - шаблон для создания собственного виджета, примеры свойств и настроек виджета.

Справочник по JS API

В справочнике подробно описаны методы JavaScript API для работы с виджетами. Основные разделы справочника:

• Общая информация о JS API

• Начало работы с JS API

• Поддержка jQuery

• Методы и события объекта widget