[TOC]
OS Property includes the following front-end modules. Each module can be installed and configured from Back-end > Extensions > Modules.
Displays a hierarchical list of OS Property categories in a menu-style layout. It supports multi-level nesting, property counts per category, and clickable links to category listing pages.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| Module Class Suffix | text | (empty) | A CSS class suffix applied to the module wrapper element. |
| Menu Class Suffix | text | (empty) | A CSS class suffix applied to each menu item. |
| Ordering | list | List Order | Controls the sort order of categories. Options: List Order (the order defined in the category tree) or Alphabetical Order. |
| Start Level | text | 0 | The category depth level to begin rendering from. Set to 0 to start from the top level. |
| End Level | text | 0 | The category depth level to stop rendering at. Set to 0 to render all levels without restriction. |
| Show Arrow | radio | No | When enabled, displays an arrow indicator before each category name. |
Displays properties as markers on an interactive map. Supports both Google Maps and OpenStreetMap (via Leaflet). Properties can be filtered by category, property type, and location before being shown on the map.
Parameters — Basic
| Parameter | Type | Default | Description |
|---|---|---|---|
| Width | text | 100% | Width of the map container. Accepts pixel (px) or percentage (%) values. |
| Height | text | 300 | Height of the map container in pixels. |
| Max Properties | text | 0 | Maximum number of properties displayed on the map. Set to 0 to show all. |
| Zoom | text | 10 | Initial zoom level of the map. Higher values zoom in further. |
| Google Map Type | list | Road Map | Map rendering style for Google Maps. Options: Road Map, Satellite, Hybrid, Terrain. |
| Google Map Style | list | Default | Predefined visual style for Google Maps. Options: Default, Style1 through Style5. |
| Disable Mouse Wheel | radio | No | When enabled, prevents the map from zooming when the user scrolls with the mouse wheel. |
Parameters — Source Settings
| Parameter | Type | Description |
|---|---|---|
| Categories | multi-select | Filter properties by one or more OS Property categories. |
| Property Types | multi-select | Filter properties by one or more property types. |
| Countries | multi-select | Filter properties by one or more countries. |
| State IDs | text | Comma-separated list of state IDs to filter properties by location. |
| City IDs | text | Comma-separated list of city IDs to filter properties by location. |
Parameters — Advanced
| Parameter | Type | Default | Description |
|---|---|---|---|
| Use Cache | list | Enable | Enables or disables module-level caching to improve page load speed. |
| Cache Time | text | 900 | Duration (in seconds) that the cached output is stored before being refreshed. The default value of 900 equals 15 minutes. |
Displays a configurable list of properties with flexible filtering, ordering, and display options. Despite its name, it supports both random and ordered property listings, making it suitable for featured listings, newest properties, and agent-specific showcases.
Parameters — Basic
| Parameter | Type | Default | Description |
|---|---|---|---|
| Module Class Suffix | text | (empty) | A CSS class suffix applied to the module wrapper element. |
| Select Layout | list | Default | Display layout. Options: Default (vertical list) or Showcase (card-style). |
| Direction | radio | Vertical | Orientation of the property list. Options: Vertical or Horizontal. |
| Properties per Row | list | 1 | Number of property items displayed per row (1, 2, 3, 4, or 6). |
| Max Properties | text | (empty) | Total number of properties to retrieve and display. |
| Enable Page Navigation | radio | No | When enabled, splits the listing into pages with navigation controls. |
| Number of Properties per Page | text | (empty) | Number of items per page when pagination is enabled. |
| Show Small Description | radio | No | Displays a short description excerpt below each property title. |
| Show Price | radio | No | Displays the property price. |
| Show Address | radio | No | Displays the property address. |
| Show Market Status | radio | No | Displays the market status label (e.g., For Sale, For Rent). |
| Show Bathrooms | radio | No | Displays the number of bathrooms. |
| Show Bedrooms | radio | No | Displays the number of bedrooms. |
| Show Parking | radio | No | Displays the number of parking spaces. |
| Show Square Field | radio | No | Displays the property size (area). |
| Show Category Name | radio | No | Displays the category name for each property. |
| Show Property Type Name | radio | No | Displays the property type name for each property. |
| Limit Title Words | text | 0 | Maximum number of words to show in the property title. Set to 0 to show the full title. |
| Limit Description Words | text | 0 | Maximum number of words to show in the short description. Set to 0 to show the full text. |
| Show Photo | radio | Yes | Displays the property thumbnail image. |
| Featured Properties Only | radio | No | When enabled, only properties marked as featured are shown. |
| Market Status Filter | — | All | Filters properties by market status (e.g., show only sold properties). |
| Show Open Houses Only | radio | No | When enabled, only properties with an active open house schedule are shown. |
| Show Recent Viewed Properties | radio | No | When enabled, only properties recently visited by the current user are shown. |
| Open From | date | (empty) | Start date filter for open house properties. |
| Open To | date | (empty) | End date filter for open house properties. |
| Agent ID(s) | text | (empty) | Comma-separated list of agent IDs to filter properties by listing agent. |
| Company ID(s) | text | (empty) | Comma-separated list of company IDs to filter properties by agency. |
| Country IDs | text | (empty) | Comma-separated list of country IDs to filter properties by country. |
| State IDs | text | (empty) | Comma-separated list of state IDs to filter properties by state. |
| City IDs | text | (empty) | Comma-separated list of city IDs to filter properties by city. |
| Category | select | (empty) | Filter to show properties from a specific category only. |
| Property Type | select | (empty) | Filter to show properties of a specific property type only. |
| Property IDs | text | (empty) | Comma-separated list of specific property IDs to include. |
| Exclude Property IDs | text | (empty) | Comma-separated list of property IDs to exclude from the listing. |
| Order By | radio | Created Date | Field used to sort properties. Options: Created Date, Reference, Title, Featured, Sold On Date, Price, Custom Ordering, Random. |
| Order Type | radio | Descending | Sort direction. Options: Descending or Ascending. |
Provides a front-end property search form with collapsible filter groups, geolocation support, and optional horizontal layout. It is typically placed in the sidebar or homepage and submits search queries to the OS Property results page.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| Module Class Suffix | text | (empty) | A CSS class suffix applied to the module wrapper element. |
| Layout | radio | Vertical | Form layout. Options: Vertical (stacked fields) or Horizontal (side-by-side fields). |
| Show Basic Filter Group | radio | No | Displays the Basic filter section (keyword, category, type, price). |
| Show Details Filter Group | radio | No | Displays the Details section (bedrooms, bathrooms, area, etc.). |
| Show Address Filter Group | radio | No | Displays the Address section (country, state, city, postcode). |
| Show Amenities Filter Group | radio | No | Displays the Amenities section listing all available amenities from OS Property. |
| Show Ordering Group | radio | No | Displays sorting controls (Sort By and Order direction). |
| Show Other Filter Group | radio | No | Displays an additional filter group for miscellaneous fields. |
| Show User Filter | radio | No | Displays a filter to search by agent or agency. |
| Show Keyword Field | radio | No | Displays the keyword/text search input. |
| Show Category Filter | radio | No | Displays a dropdown to filter by property category. |
| Show Property Type Filter | radio | No | Displays a dropdown to filter by property type. |
| Use Property Type | select | (empty) | When a specific property type is selected, the property type dropdown is hidden and searches are automatically scoped to that type. |
| Show Price Filter | radio | No | Displays min/max price inputs. When a specific property type is selected, price options are loaded from that type's configuration. |
| Show Custom Fields Filter | radio | No | Displays custom field filters defined in OS Property for the selected property type. |
| Input Box Width (px) | text | 150 | Width of input fields inside the search form, in pixels. |
| Show Search Form in Results | radio | No | When enabled, the advanced search form remains visible on the search results page. |
| Results in Current Page | radio | No | When disabled, search results are displayed on a separate results page. Enable this to show results inline on the same page as the module. |
| Show Labels | radio | Yes | Displays field labels above or beside each input. |
| Labels and Fields on Two Lines | radio | No | When enabled, labels appear on one line and the input field appears below it. |
| Open All Filter Groups | radio | No | Expands all filter sections by default. When disabled, only the Basic group is open. |
| Use Chosen Style | radio | Yes | Applies the Chosen/Select2 enhanced styling to all dropdown select fields. |
Displays a grid of countries, states, or cities from OS Property. Each item shows the property count and links to the corresponding property listing. This module is commonly used to provide geographic navigation on the homepage or sidebar.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| Module Class Suffix | text | (empty) | A CSS class suffix applied to the module wrapper element. |
| List Type | list | States | Determines what geographic level to display. Options: States, Cities, or Countries. |
| Number of Columns | text | 4 | Number of columns used to display the location grid. |
| Select Country | select | (empty) | When listing states, restricts the list to states belonging to the selected country. |
| State IDs | text | (empty) | Comma-separated state IDs. When listing cities, restricts the list to cities in the specified states. |
| Only Show Locations with Properties | radio | No | When enabled, only states, cities, or countries that have at least one published property are shown. |
| Menu Item ID | text | (empty) | The Joomla menu item ID used to build the links for each location. Leave empty to use the default. |
Displays a responsive property carousel using the Owl Carousel library. The slider supports thumbnail images, lightbox integration, autoplay, and fine-grained control over animation speed, column count, and responsive behavior across different screen sizes.
Parameters — General Settings
| Parameter | Type | Default | Description |
|---|---|---|---|
| Category IDs | multi-select | (empty) | Filter properties by one or more OS Property categories. |
| Property Type IDs | multi-select | (empty) | Filter properties by one or more property types. |
| State IDs | text | (empty) | Comma-separated state IDs to filter by location. |
| City IDs | text | (empty) | Comma-separated city IDs to filter by location. |
| Featured Properties Only | radio | No | When enabled, only featured properties are included in the slider. |
| Min Price | text | (empty) | Minimum property price filter. |
| Max Price | text | (empty) | Maximum property price filter. |
| Property IDs | text | (empty) | Comma-separated list of specific property IDs to include. |
| Exclude Property IDs | text | (empty) | Comma-separated list of property IDs to exclude. |
| Limit Items | text | 12 | Maximum number of properties to display in the slider. |
| Ordering | list | Created (Ascending) | Controls the order of properties. Options: by ID, by ordering weight, by hits, by creation date, by publish date, featured first, or random. |
Parameters — Item Layout
| Parameter | Type | Default | Description |
|---|---|---|---|
| Show Title | radio | Yes | Displays the property title on each slide item. |
| Limit Title By | list | Word | Controls how the title is truncated. Options: Word or Character. |
| Title Max Length | text | 8 | Maximum number of words or characters shown in the title. |
| Show Price | radio | Yes | Displays the property price. |
| Show Category | radio | Yes | Displays the property category name. |
| Show Property Type | radio | Yes | Displays the property type name. |
| Show Address | radio | Yes | Displays the property address. |
| Show Short Description | radio | Yes | Displays the property intro/description text. |
| Limit Description By | list | Character | Controls how the description is truncated. Options: Word or Character. |
| Description Max Length | text | 100 | Maximum number of words or characters shown in the description. |
| Show Read More Button | radio | Yes | Displays a "Read More" link on each slide item. |
| Read More Text | text | Read More | Custom label for the Read More button. |
| Slide Width | text | 800 | Width of each individual slide in pixels. |
| Show Pretext | radio | No | Displays an optional pretext title and content block above the property details. |
| Pretext Title | text | (empty) | Title of the pretext block (only visible when Show Pretext is enabled). |
| Pretext Content | textarea | (empty) | Content of the pretext block (only visible when Show Pretext is enabled). |
| Content Padding | text | 10px 10px 10px 10px | CSS padding applied to the content area of each slide item. |
| Article Block Padding | text | 10px 10px 10px 10px | CSS padding applied to the article block wrapper. |
Parameters — Slider Behavior
| Parameter | Type | Default | Description |
|---|---|---|---|
| Slide Columns | text | 3 | Number of property cards visible at one time on large screens. |
| Slide Rows | text | 1 | Number of rows of property cards in the slider. |
| Show Navigation | radio | Yes | Displays previous/next arrow buttons for manual slide navigation. |
| Infinite Loop | radio | Yes | When enabled, the slider loops back to the first item after reaching the last. |
| Center Items | radio | No | When enabled, the active slide item is centered in the viewport. |
| Slide By | list | Page | Controls how many items advance per navigation click. Options: Page (one full set) or a number from 1 to 12. |
| Margin Right | text | 20 | Right margin (in pixels) between slide items. |
| Stage Padding | text | 0 | Horizontal padding applied to the slider stage, used to create a peek effect. |
| Auto Transition | radio | No | When enabled, slides advance automatically without user interaction. |
| Autoplay Speed | text | 300 | Transition animation duration in milliseconds (visible when Auto Transition is enabled). |
| Autoplay Timeout | text | 4000 | Interval in milliseconds between automatic slide transitions. |
| Pause on Hover | radio | Yes | Pauses autoplay when the user hovers over the slider. |
| Smart Speed | text | 300 | Speed of the slide transition animation in milliseconds. |
| Mouse Drag | radio | Yes | Enables drag-to-scroll behavior for mouse users. |
Parameters — Thumbnail Settings
| Parameter | Type | Default | Description |
|---|---|---|---|
| Show Thumbnails | radio | Yes | Displays property thumbnail images in each slide item. |
| Thumbnail Alignment | list | None | Aligns the thumbnail within the item. Options: Left, Right, or None. |
| Keep Aspect Ratio | radio | No | When enabled, thumbnail height is calculated automatically to preserve the image aspect ratio. |
| Thumbnail Width | text | 480 | Width of generated thumbnails in pixels. |
| Thumbnail Height | text | 380 | Height of generated thumbnails in pixels (ignored when Keep Aspect Ratio is enabled). |
| Thumbnail Margin | text | 15px | CSS margin applied around each thumbnail image. |
| Show Default Thumbnail | radio | Yes | Displays a placeholder image when a property has no photo. |
| Show Hover Icons | radio | Yes | Displays action icons (e.g., zoom, link) when hovering over a thumbnail. |
| Link Image | radio | No | Makes the thumbnail image a clickable link to the property detail page. |
| Use Caption | radio | No | Overlays a caption text on the thumbnail image. |
Parameters — Lightbox Settings
| Parameter | Type | Default | Description |
|---|---|---|---|
| Fade Duration | text | 300 | Duration (ms) of the fade animation when the lightbox opens or closes. |
| Fit Images in Viewport | radio | Yes | Scales large images down to fit within the browser viewport. |
| Image Fade Duration | text | 300 | Duration (ms) of the fade transition between images in the lightbox. |
| Position from Top | text | 150 | Distance from the top of the viewport (in pixels) at which the lightbox is positioned. |
| Resize Duration | text | 150 | Duration (ms) of the resize animation when navigating between images of different sizes. |
Parameters — Mobile
| Parameter | Type | Default | Description |
|---|---|---|---|
| Slide Columns (Small Screens) | text | 2 | Number of columns on small screens (e.g., tablets). |
| Slide Rows (Small Screens) | text | 3 | Number of rows on small screens. |
| Slide Columns (Extra Small Screens) | text | 3 | Number of columns on extra-small screens (e.g., phones). |
| Slide Rows (Extra Small Screens) | text | 4 | Number of rows on extra-small screens. |
Displays a full-featured property slideshow using the Camera.js library. It supports a wide range of transition effects, multiple themes and color skins, thumbnail strip navigation, pagination dots, and highly customizable caption overlay styling. This module does not require jQuery.
Parameters — Slides
| Parameter | Type | Default | Description |
|---|---|---|---|
| Property IDs | text | (empty) | Comma-separated list of specific property IDs to include in the slideshow. |
| Category IDs | text | (empty) | Comma-separated list of category IDs. Properties from these categories are included. |
| Property Type IDs | text | (empty) | Comma-separated list of property type IDs to filter slides. |
| City IDs | text | (empty) | Comma-separated list of city IDs to filter properties by city. |
| State IDs | text | (empty) | Comma-separated list of state IDs to filter properties by state. |
| Country IDs | text | (empty) | Comma-separated list of country IDs to filter properties by country. |
| Featured Properties Only | radio | No | When enabled, only featured properties are included. |
| Sold Properties Only | radio | No | When enabled, only sold properties are included. |
| Ordering | list | Created (Ascending) | Sort order for slides. Options: by ID, by hits, by creation date, by featured, by ordering weight, or random. |
| Limit Items | text | 5 | Maximum number of properties to show in the slideshow. |
Parameters — Styles
| Parameter | Type | Default | Description |
|---|---|---|---|
| Theme | folder list | (default) | Selects the slideshow theme from available theme folders in modules/mod_ospslideshow/themes/. |
| Skin | list | Amber | Color skin for the slideshow UI. Over 30 options available (amber, ash, azure, beige, black, brown, burgundy, and more). |
| Image Alignment | list | Center | Position of the slide image within the frame. Options include top-left, top-center, top-right, center-left, center, center-right, bottom-left, bottom-center, bottom-right. |
| Loader Style | list | Pie | Visual style of the loading indicator. Options: Pie, Bar, or None. |
| Width | text | auto | Width of the slideshow. Use auto to match the container width, or specify a pixel value. |
| Height | text | 600 | Height of the slideshow in pixels. |
| Minimum Height | text | 150 | Minimum height (in pixels) of the slideshow on small screens. |
| Navigation | radio | Hover | Controls when navigation arrows are visible. Options: Hover (show on hover), Always (always visible), or None. |
| Show Thumbnails | radio | No | Displays a thumbnail strip below the slideshow for direct slide selection. |
| Thumbnail Width | text | 100 | Width of each thumbnail in pixels. |
| Thumbnail Height | text | 75 | Height of each thumbnail in pixels. |
| Show Pagination | radio | No | Displays pagination dots at the bottom of the slideshow. |
Parameters — Effects
| Parameter | Type | Default | Description |
|---|---|---|---|
| Transition Effect | list (multi-select) | Random | The transition animation between slides. Over 30 options including: random, kenburns, simpleFade, curtainTopLeft, curtainTopRight, and more. |
| Time Between Slides | text | 7000 | Duration (in milliseconds) each slide is displayed before transitioning. |
| Transition Duration | text | 1500 | Duration (in milliseconds) of the slide transition animation. |
| Caption Effect | list | Random | Animation effect for the caption overlay. Options include: moveFromLeft, moveFromRight, moveFromTop, moveFromBottom, fadeIn. |
| Portrait Mode | radio | No | Optimizes the slideshow layout for portrait-oriented images. |
| Auto Advance | radio | Yes | Automatically advances slides after the configured time interval. |
| Pause on Hover | radio | Yes | Pauses automatic advancement when the user hovers over the slideshow. |
| Display Order | list | Normal | Controls the order in which slides are displayed. Options: Normal (as configured) or Shuffle (randomized). |
| Limit Slides | text | (empty) | Restricts the number of slides shown regardless of the source limit. |
| Fullpage Mode | radio | No | Expands the slideshow to fill the entire browser viewport. |
| Image Target | list | Same Window | Determines where the property link opens. Options: Same Window, New Window, or Lightbox. |
| Container ID | text | (empty) | Custom HTML ID of the container element. Leave empty to use the default. |
| Use Mobile Image Resolution | radio | No | When enabled, serves a lower-resolution image on mobile devices. |
| Mobile Image Resolution | text | 640 | Maximum width (in pixels) of images served to mobile devices. |
Parameters — Advanced
| Parameter | Type | Default | Description |
|---|---|---|---|
| Auto Create Thumbnails | radio | Yes | Automatically generates and caches thumbnail images for slides. |
| Module Layout | — | Default | Selects an alternative layout template for the module output. |
| Module Class Suffix | text | (empty) | A CSS class suffix applied to the module wrapper element. |
| Caching | list | Use Global | Enables or disables module output caching. Options: Use Global (follows site caching settings) or No Cache. |
| Cache Time | text | 900 | Duration (in seconds) that cached output is stored. The default value of 900 equals 15 minutes. |
Provides a compact, responsive property search form with location autocomplete and property type quick-filter buttons. It is designed to integrate with RealHomes-style templates and is commonly placed on the homepage hero section or banner area.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| Width of Search Box (px) | text | 715 | Total width of the search form container in pixels. The form uses responsive CSS for smaller screens. |
| Show Search Form in Results | radio | No | When enabled, the search form remains visible on the results page after a search is submitted. |
| Show Category Filter | radio | No | Displays a category dropdown inside the search form. |
| Property Types | multi-select | (empty) | Selects the property types displayed as quick-filter buttons below the search input. |
The default output of any OS Property module can be overridden by placing a custom template file inside the active Joomla template's html directory. This allows you to change the layout without modifying the original module files.
The required directory structure is:
TEMPLATE_NAME/html/MODULE_NAME/default.phpFor example, to customize the output of the Property Listing module, copy the default template:
PATH_TO_JOOMLA/modules/mod_ospropertyrandom/tmpl/default.phpto:
TEMPLATE_NAME/html/mod_ospropertyrandom/default.phpThen edit the copy as needed. The original module files remain unchanged, ensuring your customizations are preserved through upgrades.