map-ui-sdk

map-ui-sdk is a React UI toolkit for enhancing mapping interfaces with interactive UI controls. It features both standalone UI components and specialized controls designed to integrate seamlessly with our MapsGL service.

MapsGL components

MapsGLMapControllerProvider
Core provider that integrates with the MapsGL Map Controller, providing access to map controller instances throughout your application.

MapsGLLayersProvider
State management solution for MapsGL weather layers, handling layer lifecycle, styling, and state synchronization.

MapsGLLayersControl
Interface for managing map layer visibility and styling, supporting both individual and grouped layer controls.

MapsGLTimelineControl
Specialized timeline interface for time-based map animations, offering navigation, dynamic tick marks, and settings panel for customizing animation speed and time ranges.

MapsGLSearchControl
Pre-configured search interface designed for MapsGL integration, with built-in result grouping and location history.

Visit our documentation for more information for a complete list of components and usage examples.

Getting Started

yarn add @xweather/map-ui-sdk

Import the required styles:

import '@xweather/map-ui-sdk/dist/style.css'

Example Project

The SDK includes an example project that demonstrates how to build a complete mapping interface using the various components and providers. It serves as both a reference implementation and a playground for experimenting with different configurations.

Prerequisites

• An Xweather account— We offer a free developer account for you to give our weather API a test drive.
• A Mapbox account

Steps to Run

1. Get Xweather MapsGL ID and Secret Log into your Xweather account, and from your account's Apps page, create a new application for the MapsGL Demo app. Make note of the application's Xweather MapsGL ID and Secret.

2. Get Xweather Mapbox public access token The example project relies on Mapbox, so you'll need to log into or create a Mapbox account and follow the instructions to create a Mapbox public access token.

3. Navigate to the Example Directory

cd ./example

4. Install Dependencies

yarn install

5. Update environment variables Rename .env.template to .env and add your access keys:

VITE_MAPBOX_KEY=''
VITE_MAPSGL_ID=''
VITE_MAPSGL_SECRET=''

6. Run the project

yarn dev

Documentation

For detailed documentation, examples, and API references, visit:

• Map UI SDK Documentation
• MapsGL Documentation
• Weather API Documentation

TypeScript Support

The SDK includes comprehensive TypeScript definitions, providing full type safety and excellent IDE support.

Support

Submit a new ticket with any questions, bug reports or feature suggestions you have.