Documentation

This section contains technical information on components you need to create and use Yandex.Widgets.

Before reading the docs, please check the glossary, where you can find concise definitions of basic terms used in our texts.

Quick Start

The Quick Start guide includes several examples that can help you get started working with widgets. The examples are aimed at developers with any level of expertise:

• Hello, world! - an example that guides you through widget basics, from creating a widget to adding it to the widget catalog.

• Distance units converter - an example that demonstrates how to create a widget using JavaScript and the widget API, and how to store the widget body on a third-party server.

Developer's guide

This guide contains practical information on creating Yandex.Widgets, uploading them to Yandex and publishing them in the widget catalog. The document consists of the following sections:

• Concepts - explanations of basic terms and answers to "What is this?" questions.

• Tasks - step-by-step instructions on how to create widgets, upload them to Yandex, and add them to the widget catalog.

• Reference - a list of widget properties and settings.

• Widget examples - examples of working widgets.

• Common errors - overview of the typical mistakes that widget developers make.

• Problems and solutions - solutions addressing common problems that widget developers might encounter.

• Appendices - a template for creating a custom widget, along with examples of widget properties and settings.

JS API Reference

This reference guide describes the JavaScript API methods used for working with widgets. The document consists of the following sections:

• General info on the JS API

• Getting started with the JS API

• jQuery support

• The widget object: methods and events