Skip to content

Configuration ​

You can find the options under Components → KickMap → Options. Many settings can be overridden per menu item, module, or YOOtheme element.

Map ​

OptionDefaultDescription
Map providerLeafletLeaflet (OpenStreetMap) or Google Maps
Google Maps API key–Required for Google Maps. Without a key, Leaflet is used automatically.
Google map ID–Enables Advanced Markers and cloud map styles. Without a map ID, classic markers are used.
Map typeRoadmapRoadmap, Satellite, Hybrid, Terrain (Google)
Hide points of interestYesHides Google's shops/sights (only without a map ID)
Tile server (Leaflet)https://tile.openstreetmap.org/{z}/{x}/{y}.pngYour own tile server, e.g. a self-hosted one or a commercial provider
Tile attribution© OpenStreetMapAttribution required by the tile provider
Load map after consent onlyYesTwo-click solution, see Privacy
Consent text–Text of the consent notice (empty = default text)
Center latitude/Center longitude, ZoomGermany, 6View when there are no locations
Zoom detail page15Zoom for a single location
Maximum zoom18
Fit to locationsYesThe map section adjusts to the locations
Scroll wheel zoomNoOff, so the page doesn't get stuck while scrolling
Cluster markersYesGroups nearby markers; "Cluster up to zoom" 12
Map height500px
Map in the location list (backend)Yes

Setting up Google Maps

  1. In the Google Cloud Console, create a project and enable the Maps JavaScript API (for geocoding, also the Geocoding API).
  2. Create an API key and restrict it to your domain (HTTP referrer).
  3. Optionally, create a map ID (type JavaScript) under Map Management.

Marker ​

OptionDefaultDescription
Marker shape–Bundled shape (pin, dot, star, shopping bag, house), colored in the marker color
Marker image–Your own image (SVG/PNG) as the default marker; takes precedence over the shape. In SVGs, #000000 is replaced by the marker color
Default color#0099d9Color of the marker if the category has no color
Replace colours–Replace additional colors in SVG markers, one line per color, e.g. #444444,#ffd200 (more)
Width / Height32 / 48 pxSize of the marker; the anchor point is bottom center
Marker sourceCategory"Category of the location": use the category's marker; "Always default marker": always use the default marker

Geocoding ​

OptionDefaultDescription
Geocoding serviceAutomaticAutomatic = Google if an API key is set, otherwise Nominatim
Google Geocoding API key–Separate key for geocoding (otherwise the Maps key)
Nominatim serverhttps://nominatim.openstreetmap.orgYour own Nominatim server is possible
Contact email for Nominatim–Sent along with requests (Nominatim usage policy)
CountriesdeISO codes, e.g. de,at,ch; empty = worldwide

Geocoding is used for "Find address" in the backend and for the radius search in the frontend. Results are cached for 30 days.

List & Filter ​

OptionDefaultDescription
Show filterYes
FiltersText search, Radius search (address / location), Category, Tags, Open nowAlso possible: Featured, Custom fields
Filterable fields–Custom fields that appear as filters
Show countsYesNumbers after the filter options
Live filterNoUpdate results without reloading the page
Offer "my location"YesRadius search using browser geolocation
Show search locationYesMarker at the search location
Show radius as circleYesCircle with the search radius; color adjustable
Distance unitKilometresKilometres (km) or Miles (mi); applies to the radius, radius options, and distance information. Can be overridden per menu item.
Radius options10,25,50,100,250Selection in the filter, in the chosen unit
Default radius50In the chosen unit
Show map / Show listYes / Yes
OrderingOrderingOrdering, Title, Postcode, City, Featured first. With a radius search, results are sorted by distance.
Select number of items per page, Pagination24
Show sliderNoList as a slider instead of a grid
Placeholder image–Image for locations without an image

Location (Detail Page) ​

OptionDefaultDescription
Show mapYes
Show opening statusYes
Show special openings (days)60Preview period
Directions linkYesGoogle Maps or OpenStreetMap, depending on the provider
Category / TagsYes
Show contact areaYesFree content with an editor; content plugins are executed (e.g. for a form)
Record HitsYes
Default meta description–
Schema.org typeLocalBusinessLocalBusiness, Store, Organization, or no output

Integration ​

Search engine friendly URLs (Remove IDs from URLs), versions, custom fields, and workflows – see Menu Items & URLs and Multilingual, Workflow & Versions.

Permissions ​

In addition to the standard Joomla permissions, there are:

PermissionEffect
Access Web Services (core.api)Access via the Web Services API. As of Joomla 5.4.11 / 6.2.1, Joomla checks this permission on every API call, see Web Services API.
Manage locationsMenu item and list of locations
Manage opening hoursTemplates and special opening hours
Manage categoriesCategories menu item
Manage fieldsFields and Field Groups menu items
Run transitionsWorkflow transitions