The Woosmap Store Locator Widget Block for WordPress allows you to add a store locator to your WordPress site using the
Gutenberg editor. This plugin leverages
the Woosmap Store Locator Widget JS
to provide a rich and interactive experience for users looking for your store locations.
With easy customization and setup, you can enhance your site’s user experience in minutes.
To use this plugin, you will need a Woosmap account and an API key. The Woosmap Store Locator Widget connects to the
Woosmap API to fetch and display store locations on your site. Note that Woosmap offers various pricing plans, including
a free tier with limited usage and paid plans for higher usage and additional features. For detailed pricing
information, please refer to the Woosmap pricing page.
The widget supports a broad array of languages, including French, English, Spanish, German, and many more, catering to a
global audience and is designed for fast and advanced display capabilities, ensuring a seamless user experience.
Check official documentation for
more details.
Key Features
- Multilingual Support: Available in over 15 languages, such as English, Chinese, and French, catering to
international brands. - Customizable Display: Users can set a primary color that applies to labels and backgrounds, aligning the
locator’s
appearance with their brand identity. - Flexible Search: Adapt the search features to include autocomplete worldwide or for specific countries and
specific types (address, postal code, etc.), ensuring the functionality best fits your needs. - Advanced Display Options: Offers simplified and markers views for displaying assets, allowing for a clean view or
detailed markers based on zoom level. - Configurable Search Parameters: Set the number of assets fetched from a user search and bound searches within a
set radius to accommodate store density.
Display Customization
- Simplified View: Ideal for rendering a large number of assets or high store density, displaying assets as colored
dots for faster map loading and a cleaner view. - Markers View: Displays assets as pictograms with customizable images, sizes, and hotspots, suitable for detailed
branding after a specified zoom level.
Integration and Customization
The widget’s properties offer versatile customization options: use Form controls for swift adjustments of attributes
like theme color, or dive into an editable JSON Configuration for granular control over the store locator’s
functionality and appearance. This adaptability guarantees seamless integration into any website, equipping businesses
with a robust tool to enhance their online presence and engage customers more effectively.
External Dependencies
This plugin will load the Woosmap Store Locator Widget JavaScript asynchronously, which will then load the
Woosmap Map JavaScript asynchronously and execute
requests to Woosmap services for various functionalities:
- Searching for Stores: The widget will query the Woosmap API to fetch store locations, ensuring accurate and
up-to-date results. - Autocompleting Addresses: The widget will use Woosmap’s autocomplete service to suggest addresses as users type,
enhancing the user experience with quick and relevant suggestions. - Displaying Maps: The widget will render maps using Woosmap’s mapping service to visually display store locations
and other relevant data, providing an interactive and user-friendly interface.
The URLs involved are:
– https://webapp.woosmap.com/webapp.js
– https://sdk.woosmap.com/map.js
– https://api.woosmap.com/*
Source Code
This plugin’s source code is accessible in the src directory of our GitHub repository.
Configuration
To begin using the Woosmap Store Locator Widget Block, follow these steps to configure your environment and gain access
to the Woosmap API
for enhancing your site with location services.
Woosmap Account Requirements
- If you haven’t already, sign up for a Woosmap account as it’s necessary to access
the Woosmap Console and API keys. - Log in to the Woosmap Console. If you’re new to Woosmap, you might need to
create a project to generate API keys. - Navigate to the API keys section and generate a new Public API key for your project. This key will be used to
authenticate your requests to the Woosmap services.
Configure the Woosmap Store Locator Widget Block
When you create a new Woosmap block, the initial settings screen prompts you to enter the public API Key. If an API Key
has already been configured, this field will be pre-populated with the existing key stored in the Woosmap settings.
After validation, proceed to the Map View to access various editor settings, or edit the JSON Configuration as desired.
