Skip to main content

Overview

Display plugins render dynamic HTML blocks inside CMS pages or product descriptions using shortcodes. All built-in display plugins are pre-installed and available immediately after running the plugin seeder. Each shortcode follows the format [plugin:shortcode-name param=value].

Slideshow Plugin

Shortcode: [plugin:slideshow-2026] Displays an active slideshow using Swiper.js with full overlay content controls, flexible alignment, and CSS customizations. Slide data is managed at Admin → CMS → Slideshows.

Parameters

Admin Settings

Access from Admin → Plugin Manager → Slideshow → Settings:
  • Custom CSS Overrides — syntax-highlighted CSS editor applied on top of default styles, site-wide
  • Default Plugin CSS (Read-Only Reference) — built-in base stylesheet for reference only

Examples


Shortcode: [plugin:featured-items] Displays products that have the Featured Item flag enabled. Supports grid, list, and Swiper slider display modes. Mark products as featured in Admin → Products → Edit → Advanced Settings → Featured Item toggle → Save.

Parameters

Examples


Cross-Sell List Plugin

Shortcode: [plugin:cross-sell-list product_id=X] Displays the cross-selling products linked to a specific product. Supports grid, list, and Swiper slider display modes.

Setting Up Cross-Sells

Configure cross-sell relationships in Admin → Products → Edit → Cross-Selling. Only items with Display on Item View enabled will appear.

Parameters

Examples

Post-Cart Intermediary Page

When a product has cross-sells configured with Display on Post Cart enabled, adding that product to the cart redirects to shop/post-cart/{productId} before proceeding to the cart.

Brands Plugin

Shortcode: [plugin:brands-2026] Displays brand logos with links to brand SEO slug pages. Supports Slider, Grid, and List modes. Logos display in grayscale by default and full color on hover.

Parameters

Examples


Top-Level Categories Plugin

Shortcode: [plugin:categories-2026] Displays top-level categories only with image, name, and link to each category SEO slug page. Supports Grid, Slider, and List modes.

Parameters

Examples


Newsflash Banner Plugin

Shortcode: [plugin:newsflash-2026] Renders an announcement ticker/banner strip. Ideal for headers, hero sections, or above-navigation placement.

Parameters

Admin Settings

Access from Admin → Plugin Manager → Newsflash → Settings:
  • News Message Text — default announcement text when no message= parameter is passed
  • Background Color — default background color
  • Text Color — default text color
  • Allow Dismiss — default dismissibility (on / off)

Examples


Testimonials Plugin

Shortcode: [plugin:testimonials-2026] Renders customer testimonials from the CMS Testimonials table in Slider or List view with star ratings and quote icons.

Managing Testimonials

Add and manage testimonials at Admin → CMS → Testimonials.

Parameters

Examples


Social Media Icons Plugin

Shortcode: [plugin:social-icons-2026] Renders social media profile links using Font Awesome 6 icons. Profile URLs are configured globally in the plugin settings panel.

Parameters

Admin Settings

Access from Admin → Plugin Manager → Social Media Icons → Settings:

Examples


Events Calendar Plugin

Shortcode: [plugin:events-calendar-2026] Interactive events calendar displaying products marked as events based on start and stop dates. Supports Month Grid, Agenda List, and Cards Grid display modes.

Setting Up Events

Mark a product as an event in Admin → Products → Edit → Advanced Settings → Event Settings, then set the event title, location, and start/end dates.

Parameters

Display Modes

Month Grid — A traditional 7-column monthly calendar with Prev/Next navigation and a Today button. Color-coded event pills appear on calendar days. Clicking an event pill opens a glassmorphism modal with full event details and a “Book Event Ticket” button linking to the product page. Agenda List — Chronological event rows showing thumbnail, label/badge, date and time, location, price, and a “Book Event” button. Clicking opens the event detail modal. Cards Grid — A responsive 3-column grid of event cards with full-width image header, badge overlay, and a call-to-action button. Clicking a card opens the event modal.

Examples


FAQ Accordion Plugin

Shortcode: [plugin:faqs-2026] Renders frequently asked questions in an interactive Alpine.js accordion layout. FAQ content is managed at Admin → CMS → FAQs.

Parameters

Examples


Order Status Tracker Plugin

Shortcode: [plugin:order-tracker-2026] Front-end order lookup widget. Customers enter an order number and email address to view their current fulfillment status and ordered items on the page without logging in.

Parameters

Admin Settings

Access from Admin → Plugin Manager → Order Tracker → Settings to customize all visible form labels:

Examples


CMS Modal Display Plugin

Shortcode: [plugin:modal id=X] Renders a CMS Modal popup by its ID. The modal must be active in Admin → CMS → Modals. Supports auto-open on page load, trigger selectors, cookie lifetime, and positioning.

Parameters

Modals are configured individually in Admin → CMS → Modals, where you can set:
  • Title and Body Content (rich HTML)
  • Trigger — auto-open on load, on button click, or by CSS selector
  • Positioncenter, left, right, or bottom
  • Cookie Lifetime — days before re-showing a dismissed modal
  • Active / Inactive status

Examples

Multiple modal shortcodes with different IDs can appear on the same page.

Live Search Plugin

Shortcode: [plugin:live-search-2026] Multi-content live search input and full-page results display. Searches across Products, CMS Pages, Knowledge Base Articles, and Customer Testimonials simultaneously.

Parameters

Live Search API

The plugin fetches results from a built-in JSON endpoint:
Response includes category badges, thumbnails, content snippets, and URLs for each result type.

Pre-Seeded Search Page

A search results page is pre-seeded at /search using:
This page is ready to use immediately after installation with no additional configuration.

Examples


Plugin CSS System

All display plugins support a three-tier CSS precedence model that gives full control over styling.

How It Works

Each display plugin outputs a scoped <style> block immediately before its HTML. CSS is layered in this order (later layers override earlier ones): All CSS values are minified via CssMinifierService before output.

Admin - Plugin Settings Panel

Navigate to Admin → Plugin Manager and select any display plugin. The Settings tab exposes two CSS fields:
  • Default Plugin CSS (Read-Only Reference) — the plugin’s built-in base stylesheet. Informational only; cannot be edited. Copy rules from here into the Custom CSS field to customise them.
  • Custom CSS Overrides — a syntax-highlighted CSS code editor. Anything entered here is appended after the default CSS and will override matching rules. Changes apply site-wide to every instance of that plugin shortcode.

Shortcode Parameter - custom_css

Any individual shortcode can inject its own CSS by passing a custom_css parameter. This overrides both the default and admin custom CSS for that specific instance only.
The custom_css shortcode value completely replaces the admin-level Custom CSS for that render. The default_css base layer is always output first regardless.

CSS Class Reference

Slideshow (slideshow-2026)

Live Search (live-search-2026)

Brands (brands-2026)

Events Calendar (events-calendar-2026)

FAQ Accordion (faqs-2026)

Testimonials (testimonials-2026)

Top-Level Categories (categories-2026)

CMS Modal (modal)


Implementation Details


Plugin System

Plugin discovery, the Admin Panel, shortcode syntax, and PluginManager usage.

Custom Plugins

Build your own display plugin using the drop-in plugin system.