JP AJAX Search

Latest Version: 1.0.0

Changelog

Built for Fast Joomla AJAX Search

JP Ajax Search provides instant search results directly inside a compact dropdown. It is built to work well on content-heavy Joomla websites, webshop projects, documentation sites, public-sector websites, and YOOtheme Pro builds where users need quick access to articles, products, files, and events.

• Lightweight AJAX search module for Joomla
• No heavy indexing component required
• Designed for fast frontend dropdown search
• Works well in navbars, headers, offcanvas layouts, and content sections
• Built for Joomla 5 and Joomla 6 workflows
• Prepared for YOOtheme Pro and UIkit-based frontend layouts
• Clean JSON response structure
• Provider-based architecture for multiple search sources
• Safe frontend rendering using DOM/text output
• Compact dropdown layout with thumbnails, metadata, and optional Load more

Multiple Search Sources

JP Ajax Search is built around a provider/source architecture. Each source can be enabled or disabled from the module settings, making it possible to use the module as a simple article search, a product search, a document search, or a mixed search across several extensions.

• Joomla Articles
• Phoca Cart products
• HikaShop products
• J2Commerce products
• Event Booking events
• JEvents events
• jDownloads files
• DOCman documents
• eDocman documents
• Additional source architecture prepared for future providers

Each provider has its own settings where relevant, such as searchable fields, display options, source priority, and source-specific metadata.

Joomla Articles Search

The built-in Joomla Articles source is useful for normal site search, news search, knowledge base sections, or article-based landing pages.

• Enable or disable Joomla Articles completely
• Search in title
• Search in intro text
• Search in full text
• Search in alias
• Restrict results to selected categories
• Optionally include child categories
• Respects Joomla article publishing state
• Respects Joomla category publishing state
• Supports Joomla access levels
• Supports article intro image
• Falls back to full article image when intro image is missing
• Uses Joomla routing and menu Itemid detection where possible for cleaner SEF URLs
• Supports translated result type labels, such as Article / Artikel

Product Search for Webshops

JP Ajax Search is designed to work well for e-commerce sites where visitors need to find products quickly.

Supported product sources include:

• Phoca Cart
• HikaShop
• J2Commerce

Depending on the provider, product results can include:

• Product title
• Product category
• Manufacturer
• Price
• Old price / discounted price where available
• Product image
• SKU / product code
• EAN where supported
• Product description search where enabled
• Product URL routing through the e-commerce component
• Source priority for mixed search results

Document and File Search

JP Ajax Search includes support for document and file-oriented Joomla components, making it useful for municipalities, organisations, documentation portals, intranets, and public information websites.

Supported document/file sources include:

• jDownloads
• DOCman
• eDocman

Document and file results can include:

• Document title
• Category
• File type
• File size
• Version
• Download date
• Thumbnail or icon
• Document page link
• Direct download link where safely supported
• Filename search
• Description/content search where supported
• Access-level aware visibility

The module is designed to avoid exposing filesystem paths and uses safe public URLs or component routes where possible.

Event Search

JP Ajax Search can also return event results from supported event components.

Supported and prepared event sources include:

• Event Booking
• JEvents

Event results can include:

• Event title
• Event category
• Event date
• End date where available
• Location
• Event image
• Event detail URL
• Translated result type label
• Smart relevance scoring fields for testing

Smart Relevance Ranking

JP Ajax Search includes two result ordering modes: Simple source ordering and Smart relevance.

Simple mode keeps results close to source priority and provider order. This is useful when the site owner wants a predictable order, for example products before articles or documents before events.

Smart relevance ranks mixed results by match quality first, then adds source priority as a small boost.

Smart relevance can score matches from:

• Exact title matches
• Titles starting with the search term
• SKU / product code / EAN
• File names
• Categories
• Manufacturers
• Locations
• Descriptions
• Multi-word query matches

The scoring model keeps source priority useful without letting it completely override strong search matches. For example, a strong filename or SKU match can rank above a weaker article match even if the article source has a higher priority.

Debug mode can expose score information in the JSON response for testing:

• score
• final_score
• score_debug
• priority

This makes it easier to understand why results appear in a specific order during setup and QA.

Source Priorities

Each source can have a priority from 1 to 9.

• 9 is highest
• 1 is lowest
• Simple mode uses priority more directly
• Smart relevance uses priority as a smaller boost
• Priorities help tune mixed result ordering between articles, products, files, and events

This gives site builders control without making the search setup overly complex.

Clean Dropdown Layout

The frontend dropdown is designed to stay compact and readable across desktop and mobile layouts.

• Result thumbnail support
• Optional fallback image
• Option to hide missing image area
• Configurable thumbnail size
• Title and metadata layout
• Optional result type label
• Product price alignment
• File metadata display
• Event date/location metadata
• Internal scrolling with configurable max height
• Load more support
• Maximum dropdown results limit
• Mobile-friendly result rows
• Long title truncation
• No unsafe innerHTML rendering for result content

Load More Support

For larger result sets, JP Ajax Search can show a Load more button inside the dropdown.

• Enable or disable Load more
• Configurable Load more text
• Result limit controls the batch size
• Maximum dropdown results prevents unlimited loading
• Dropdown max height keeps the search panel compact
• Results append inside the existing dropdown
• Works with mixed-source results
• Works with Simple and Smart relevance ranking

Multilingual and Translation-Friendly

JP Ajax Search includes multilingual support for frontend and backend labels.

Included language files:

• English
• Swedish
• German
• Italian
• Russian

Configurable frontend text fields can use either plain custom text or Joomla language constants.

For example, the Load more text field can contain:

Load more

or:

MOD_JP_AJAX_SEARCH_DEFAULT_LOAD_MORE_TEXT

This makes it easier to use the module on multilingual Joomla websites while still allowing manual text overrides per module instance.

YOOtheme Pro and UIkit Friendly

JP Ajax Search is designed with YOOtheme Pro and UIkit websites in mind.

• Works well in YOOtheme navbar/module positions
• UIkit-friendly search styles
• Optional UIkit input class
• Configurable search width
• Configurable dropdown width
• Dropdown alignment options
• Light/dark section compatibility
• Custom CSS class fields
• CSS variables for styling
• Works in compact header layouts
• Mobile layout support

Access-Level Aware Search

Search results should respect Joomla visibility rules where supported by the provider.

JP Ajax Search is designed to check access and visibility so restricted content is not exposed to guests.

Depending on the source, this includes:

• Joomla view access levels
• Published/unpublished state
• Category access
• Language visibility
• Publish up/down dates
• Component-specific visibility fields
• Provider-specific access rules where available

This is especially important for document libraries, member-only content, events, and product/customer-specific data.

Admin-Friendly Configuration

The module settings are grouped so admins can configure sources, display behavior, ranking, and frontend text without editing code.

• Source status overview
• Installed / missing source detection
• Per-source enable settings
• Per-source priority
• Per-provider search field toggles
• Per-provider display toggles
• Display settings for dropdown and thumbnails
• Load more settings
• Missing image behavior
• Smart relevance settings
• Debug mode for ranking tests
• Language-constant support in text fields

Developer-Oriented Result Model

The module uses a normalized result structure across sources. This makes mixed-source rendering more predictable and easier to extend.

Common result fields include:

• source
• source_group
• type
• type_label
• id
• title
• url
• image
• category
• manufacturer
• price
• price_old
• file_type
• file_size
• version
• event_date
• location
• priority

Internal scoring fields are used for Smart relevance but are hidden from normal JSON output unless debug mode is enabled.

Good Use Cases

JP Ajax Search is useful for:

• Joomla site search
• Webshop product search
• Documentation portals
• Public-sector websites
• File/document libraries
• Event websites
• Knowledge bases
• Mixed article/product/document search
• YOOtheme Pro header search
• Lightweight alternatives to larger indexed search components
• Websites where search needs to be fast, compact, and easy to place

Why Use JP Ajax Search?

JP Ajax Search is built for practical Joomla projects where a full search component may be too heavy, but basic article search is not enough.

It gives site builders a compact AJAX search module with support for multiple common Joomla extensions, clean frontend output, smart ranking, multilingual labels, and YOOtheme-friendly styling — while staying small enough to use in real client projects without turning search into a complex subsystem.