The [homerunner-explorer] shortcode is used to display available properties in grid format, with optional filters and map components.
Basic Usage #
[homerunner-explorer]
Overview #
Explorer is a combined user interface for visitors to find properties of their choice. It comes with 3 key components:
- Filter panel
- Property Grid
- Interactive Map
Any of these key component elements can be enabled or disabled as needed.
Parameters #
Core Components #
| Parameter | Default | Description |
|---|---|---|
| filter | true | Show/Hide filters |
| grid | true | Show/Hide grid |
| map | true | Show/Hide map |
| featured | false | Show/Hide featured properties |
| template | default | Assign grid template |
| photos_limit | 8 | Number of property images to show |
| per_page | 4 | Number of properties to display per load |
Map Settings #
| Parameter | Default | Description |
|---|---|---|
| map_position | right | Map position, right or left |
| map_hidden | 0 | Use yes or 1 to hide map on page load |
| map_zoom | 5 | Default map zoom level |
| map_zoom_min | 0 | Minimum map zoom level |
| map_zoom_max | 18 | Maximum map zoom level |
| map_type | roadmap | Google map type |
| marker_icon | /assets/img/marker.png | Map marker icon |
| marker_cluster | yes | Display map marker in cluster |
Filter Settings #
| Parameter | Default | Description |
|---|---|---|
| hide_filters | yes | Show/hide filters btn |
| hide_start_over | yes | Show/hide start over btn |
| primary_filter_fields | location,date,guests,additional-filters | Display defined primary filter fields |
| additional_filter_fields | type,amenity | Display defined additional filter fields |
| extra_filter_fields | pets,order | Display defined other filter fields |
| primary_features_number | 7 | Number of amenity filters to display before load more button |
| autofilter_delay | 1200 | In milliseconds. Changing a filter will update listings after a given delay |
Display Settings #
| Parameter | Default | Description |
|---|---|---|
| autoplay | true | Autoplay slide |
| autoplay_interval | 2000 | Autoplay duration in milliseconds |
| infinite_slider | true | Loop slider infinite times |
| slider_nav_outside | true | Show slider nav outside when template is slider |
| photos_slide_animation | slide | Property image slideshow effect |
| hide_groups | no | Show/hide groups |
| hide_rating | no | Show/hide rating |
| no_items | No properties found. | Text for no properties |
Price Display #
| Parameter | Default | Description |
|---|---|---|
| no_dates_price | Price to show before performing date search. Possible values: base_price, average_price, lowest_price, none | |
| with_dates_price | Price to show after date search is performed. Possible values: base_price, average_price, lowest_price, none |
Property Filters #
| Parameter | Default | Description |
|---|---|---|
| type | Comma separated property type slugs. Properties having any of the given type will be shown | |
| location | Comma separated property location slugs. Properties having any of the given location will be shown | |
| group | Comma separated group slugs. Properties having any of the given group will be shown | |
| amenity | Comma separated amenity slugs. Properties having all of the given amenities will be shown | |
| amenity__or | Comma separated amenity slugs. Property having any of the given amenity will be shown | |
| guests | 0 | Minimum allowed guests |
| bedrooms | 0 | Minimum bedrooms |
| bedrooms_eq | 0 | Exact bedrooms |
| bathrooms | 0 | Minimum bathrooms |
| title__like | Filter/search by property title |
Grid Layout #
| Parameter | Default | Description |
|---|---|---|
| xscol | Set grid size for extra small devices (below 480px) | |
| scol | Set grid size for small devices (between 480px to 767px) | |
| mcol | Set grid size for medium devices (between 768px to 959px) | |
| lcol | Set grid size for large devices (between 960px to 1199px) | |
| xlcol | Set grid size for small devices (above 1200px) | |
| newtab | false | Open grid property in new tab |
Sorting #
| Parameter | Default | Description |
|---|---|---|
| sort | date__desc | Sort results. Available values: date__desc, date__asc, featured, title__asc, title__desc, bedrooms__asc, bedrooms__desc, guests__asc, guests__desc, price__asc, price__desc |