ymaps

Yandex Maps on-demand promise-based widget loader.

Appends a script tag, referencing Yandex Maps API, to document body, when is told to do so.
Provides a promise, that resolves, when the script is loaded and the API is ready.

Installation

# npm
npm install ymaps

# yarn
yarn add ymaps

Usage

If ymaps.load was called without args, default script src value would be "//api-maps.yandex.ru/2.1/?lang=en_RU"

import ymaps from 'ymaps';

ymaps.load().then(maps => {
  const map = new maps.Map('your-map-container', {
    center: [-8.369326, 115.166023],
    zoom: 7
  });
})
.catch(error => console.log('Failed to load Yandex Maps', error));

To use another language simply pass a valid src to ymaps.load

ymaps.load('https://api-maps.yandex.ru/2.1/?lang=en_US').then(maps => { /* ... */ })

The information about other options is available in the API docs. Please check out known issues to see not supported options.

Running the tests

# with npm
npm test

# with yarn
yarn test

Known issues

load parameter, except when it's set to package.full is causing an error "TypeError: s is not a constructor". To reproduce, try to pass "//api-maps.yandex.ru/2.1/?lang=en_US&load=Map" to ymaps.load in the example above. PR is welcome!

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

SemVer is used for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.

mikhailsidorov / ymaps