olamaps-web-sdk
v1.4.0
Published
Ola Maps Web SDK
Maintainers
Readme
OlaMaps Web SDK
The official OlaMaps Web SDK provides a powerful and easy-to-use interface for integrating maps into your web applications. This repository contains the distribution files and serves as the public interface for issues, feature requests, and discussions.
Installation
CDN Usage
Add the following script tag to your HTML file's <head> section:
<script src="https://www.unpkg.com/olamaps-web-sdk@latest/dist/olamaps-web-sdk.umd.js"></script>Package Manager
Install via npm:
npm i olamaps-web-sdkThen use in your project by imports like:
import { OlaMaps } from "olamaps-web-sdk";Usage
Initialization
First, initialize OlaMaps with your API key:
const olaMaps = new OlaMaps({
apiKey: [YOUR_API_KEY],
});Rendering map
- Add a container element to your HTML
<div id="[MAP CONTAINER ID]"></div>- Initialize the map with your desired configuration
const map = olaMaps.init({
style: [ADD THE LINK OF TILES STYLE JSON HERE],
container: [MAP CONTAINER ID],
center: [INITIAL LAT LAN POSITION],
zoom: [SET ZOOM NUMBER]
})Documentation & Resources
For complete documentation and integration guides, visit our Web SDK Documentation. Check out our examples directory for various implementation scenarios.
Community Support & Issue Tracking
All bug reports, feature requests, and general issues should be raised through GitHub.
For general questions and discussions, visit our discussions page For commercial support, contact us at [email protected]
Distribution Files
The SDK includes the following distribution files:
dist/olamaps-web-sdk.umd.js- UMD build (minified)dist/index.js- ES Moduledist/index.d.ts- TypeScript definitions
Versioning
We use SemVer for versioning. For available versions, see the releases page.
Contributing
While this repository doesn't contain the source code, we welcome:
- Bug reports
- Feature requests
- Documentation improvements
- Usage examples
