Files
MokoCassiopeia/docs/MODULE_OVERRIDES.md
2026-02-27 00:25:03 +00:00

16 KiB

Module & Component Overrides — MokoCassiopeia

This document provides a comprehensive guide to all mobile-responsive module and component overrides included in MokoCassiopeia.

Overview

MokoCassiopeia includes 19 mobile-responsive module overrides and 7 component view overrides designed to enhance the mobile user experience across standard Joomla, VirtueMart, Community Builder, and popular third-party extensions.

Key Features

All module overrides share these characteristics:

  • Mobile-First Design: Optimized for mobile devices with responsive breakpoints
  • Touch Targets: 48px on mobile, 44px on desktop (WCAG 2.1 compliant)
  • Input Font Size: 16px minimum on mobile (prevents iOS zoom)
  • Accessibility: Full ARIA labels, keyboard navigation, semantic HTML
  • BEM Naming: Consistent CSS class naming convention
  • CSS Variables: Integration with template color schemes
  • Security: Proper escaping, _JEXEC checks, index.html protection
  • Documentation: Each override includes comprehensive README

Module Categories

1. Search Module

Location: src/templates/html/mod_search/

Search box with multiple button position options and responsive design.

Features:

  • Button positions: left, right, top, bottom
  • Text, icon, or both display modes
  • 48px touch targets on mobile
  • Prevents iOS zoom with 16px input font

Documentation: mod_search/README.md


2. VirtueMart E-Commerce Modules

Five comprehensive overrides for VirtueMart shopping functionality.

Master Documentation: VIRTUEMART_MODULES_README.md

mod_virtuemart_cart

Location: src/templates/html/mod_virtuemart_cart/

Shopping cart display with product list and checkout button.

Features:

  • Responsive product cards
  • Remove item buttons with confirmations
  • Price display with currency formatting
  • Checkout button with prominent styling

mod_virtuemart_product

Location: src/templates/html/mod_virtuemart_product/

Product showcase with grid layouts.

Features:

  • Responsive grid: 1-4 columns based on screen size
  • Product images with hover effects
  • Price display and "Add to Cart" buttons
  • Rating display support

mod_virtuemart_currencies

Location: src/templates/html/mod_virtuemart_currencies/

Currency selector dropdown for multi-currency stores.

Features:

  • Accessible dropdown with proper labels
  • Currency symbol and name display
  • Responsive button styling

mod_virtuemart_category

Location: src/templates/html/mod_virtuemart_category/

Category navigation with hierarchical display.

Features:

  • Expandable subcategories
  • Product count display
  • Hierarchical indentation
  • Active category highlighting

mod_virtuemart_manufacturer

Location: src/templates/html/mod_virtuemart_manufacturer/

Manufacturer/brand display with grid layout.

Features:

  • Responsive grid: 2-4 columns
  • Logo display support
  • Product count per manufacturer

3. Standard Joomla & Community Builder Modules

Five essential Joomla core and Community Builder module overrides.

Master Documentation: STANDARD_MODULES_README.md

Note: The mod_menu override has been removed to prevent conflicts with Joomla's core menu system. Use Joomla's default menu rendering or apply custom CSS to the .mod-menu class for styling.

mod_breadcrumbs

Location: src/templates/html/mod_breadcrumbs/

Breadcrumb navigation with Schema.org markup.

Features:

  • Structured data for SEO
  • Responsive text truncation
  • Proper separators
  • Home icon support

mod_login

Location: src/templates/html/mod_login/

User login/logout form with 2FA support.

Features:

  • Login and logout states
  • Two-factor authentication fields
  • Remember me checkbox
  • User greeting when logged in

mod_articles_latest

Location: src/templates/html/mod_articles_latest/

Latest articles display with metadata.

Features:

  • Responsive article cards
  • Author, date, category metadata
  • Read more links
  • Featured article badges

mod_cblogin

Location: src/templates/html/mod_cblogin/

Community Builder login with avatar display.

Features:

  • User avatar when logged in
  • CB-specific login form
  • Profile link
  • Logout button

mod_comprofilerOnline

Location: src/templates/html/mod_comprofilerOnline/

Community Builder online users display.

Features:

  • User count display
  • Avatar grid layout
  • Username display
  • Online status indicators

4. Industry Extension Modules

Eight popular third-party extension module overrides plus component views.

Master Documentation: INDUSTRY_MODULES_README.md

K2 Content Extension

mod_k2_content

Location: src/templates/html/mod_k2_content/

K2 content display with advanced layouts.

Features:

  • Responsive grid: 1-3 columns
  • Featured images with lazy loading
  • Category, author, date metadata
  • Excerpt support
  • Tag display

AcyMailing Newsletter

mod_acymailing

Location: src/templates/html/mod_acymailing/

Newsletter subscription form.

Features:

  • Email validation
  • Privacy checkbox
  • Success/error messaging
  • GDPR compliance fields

HikaShop E-Commerce

mod_hikashop_cart

Location: src/templates/html/mod_hikashop_cart/

HikaShop shopping cart module.

Features:

  • Product list with images
  • Quantity adjustment
  • Price totals
  • Checkout button

Kunena Forum

Four comprehensive forum modules plus component view.

mod_kunenalatest

Location: src/templates/html/mod_kunenalatest/

Latest forum posts display.

Features:

  • Post excerpts
  • Author avatars
  • Reply count
  • Post date
mod_kunenalogin

Location: src/templates/html/mod_kunenalogin/

Forum-specific login module.

Features:

  • User avatar display
  • Forum statistics
  • Quick login form
  • Profile link
mod_kunenasearch

Location: src/templates/html/mod_kunenasearch/

Forum search with button positions.

Features:

  • Multiple button positions (left, right, top)
  • Search placeholder text
  • Icon support
  • 48px touch targets
mod_kunenastats

Location: src/templates/html/mod_kunenastats/

Forum statistics display.

Features:

  • Visual stat cards
  • Member count
  • Topic/post totals
  • Latest member
  • Responsive grid layout
com_kunena (Component)

Location: src/templates/html/com_kunena/

Forum category list view.

Views:

  • category/default.php - Category listing with icons

OS Membership Pro

Module and component overrides for membership management.

mod_osmembership

Location: src/templates/html/mod_osmembership/

Membership plans module.

Features:

  • Plan cards with pricing
  • Feature lists
  • Signup buttons
  • Badge displays (popular, featured)
com_osmembership (Component)

Location: src/templates/html/com_osmembership/

Membership pricing tables.

Views:

  • plans/default.php - Responsive pricing table with comparison features

5. Community Builder Components

Four comprehensive component view overrides for Community Builder user management.

com_comprofiler

Location: src/templates/html/com_comprofiler/

Mobile-responsive views for Community Builder user profiles, registration, and login.

userprofile

User profile display with tabbed interface.

Features:

  • Large avatar display (150px)
  • Tabbed interface for profile sections
  • Custom field display with labels
  • Online status indicator
  • Responsive layout: vertical mobile → horizontal desktop
userslist

User directory with search and grid layout.

Features:

  • Search functionality with accessible form
  • Responsive grid: 1 column mobile → 2-3 columns desktop
  • User cards with avatars (80px)
  • Custom field display
  • Profile view buttons
  • Pagination support
registers

Multi-step registration form with validation.

Features:

  • Fieldset organization with legends
  • Required field indicators (*)
  • Input validation and error display
  • Captcha support section
  • Terms & conditions checkbox
  • GDPR-compliant design
  • 16px input font on mobile
login

Login page with remember me and helper links.

Features:

  • Centered login container (max-width: 450px)
  • Username/password fields with autocomplete
  • Remember me checkbox
  • Registration and password recovery links
  • CSRF token support
  • Responsive padding adjustments

CSS Architecture

All module styles are located in src/media/css/template.css with dedicated sections:

CSS Sections

  1. MOD_SEARCH MOBILE RESPONSIVE STYLES (Lines ~18400+)

    • Search box layouts
    • Button position variants
    • Input styling
  2. VIRTUEMART MODULE MOBILE RESPONSIVE STYLES (Lines ~18500+)

    • Cart product cards
    • Product grids
    • Currency selector
    • Category navigation
    • Manufacturer displays
  3. STANDARD JOOMLA & COMMUNITY BUILDER MODULE STYLES (Lines ~19300+)

    • Menu navigation
    • Breadcrumbs
    • Login forms
    • Article displays
    • CB module components
  4. INDUSTRY EXTENSION MODULE STYLES (Lines ~19800+)

    • K2 content grids
    • AcyMailing forms
    • HikaShop cart
    • Kunena forum modules
    • OS Membership pricing
  5. COMMUNITY BUILDER COMPONENT STYLES (Lines ~21000+)

    • User profile layouts
    • Users list grids
    • Registration forms
    • Login pages
    • Tab interfaces

CSS Variables Integration

All modules integrate with template CSS variables:

/* Common Variables Used */
--body-color              /* Text color */
--link-color              /* Link color */
--link-hover-color        /* Link hover color */
--border-color            /* Border color */
--secondary-bg            /* Background color */
--border-radius           /* Border radius */
--input-bg                /* Input background */
--input-border-color      /* Input border */
--btn-primary-bg          /* Primary button */
--btn-primary-hover-bg    /* Button hover */

See CSS_VARIABLES.md for complete reference.


Responsive Breakpoints

All modules use Bootstrap-aligned breakpoints:

Breakpoint Size Typical Changes
xs < 576px Single column, stacked layouts
sm ≥ 576px 2 columns for grids
md ≥ 768px 3 columns, horizontal layouts
lg ≥ 992px 4 columns, expanded spacing
xl ≥ 1200px Maximum width, optimal spacing
xxl ≥ 1400px Extra spacing

Accessibility Features

All overrides implement comprehensive accessibility:

ARIA Labels

  • Descriptive labels for all interactive elements
  • aria-label for icon-only buttons
  • aria-describedby for form fields
  • aria-live for dynamic content

Keyboard Navigation

  • Proper tab order
  • Focus states on all interactive elements
  • Keyboard-accessible dropdowns
  • Skip links where appropriate

Screen Readers

  • Semantic HTML5 elements
  • Hidden text for icon-only elements
  • Proper heading hierarchy
  • Alternative text for images

WCAG 2.1 Compliance

  • Touch targets: 48px minimum on mobile
  • Color contrast ratios meet AA standards
  • Text resizable to 200% without loss
  • No content relies on color alone

Customization Guide

Override Customization

Each module can be customized in two ways:

1. CSS Customization

Edit src/media/css/user.css to add custom styles:

/* Example: Customize search button color */
.mod-search__button {
	background-color: #ff6600;
}

/* Example: Change product grid columns */
@media (min-width: 768px) {
	.mod-vm-product__grid {
		grid-template-columns: repeat(3, 1fr);
	}
}

2. Template Override Customization

Copy the entire module directory and modify:

# Keep original override as reference
cp -r src/templates/html/mod_search src/templates/html/mod_search_original

# Modify your version
# Edit src/templates/html/mod_search/default.php

CSS Variables Override

Override CSS variables in your custom color scheme:

/* src/media/css/colors/light/colors_custom.css */
:root {
	--mod-search-bg: #f8f9fa;
	--mod-search-border: #dee2e6;
	--vm-price-color: #28a745;
}

Best Practices

When Using Overrides

  1. Test Across Devices: Always test on actual mobile devices
  2. Maintain Accessibility: Don't remove ARIA labels or keyboard navigation
  3. Keep BEM Naming: Use established class naming patterns
  4. Security First: Always escape output and validate input
  5. Document Changes: Comment your customizations

When Updating

  1. Backup First: Always backup your site before updating
  2. Review Changes: Check CHANGELOG.md for breaking changes
  3. Test Thoroughly: Test all modules after updates
  4. Custom Overrides: May need adjustments after template updates

Troubleshooting

Common Issues

Module Not Displaying Correctly

  1. Clear Joomla cache (System → Clear Cache)
  2. Check module is published and assigned to correct position
  3. Verify template is assigned to menu items
  4. Check browser console for JavaScript errors

Styles Not Applying

  1. Clear browser cache (Ctrl+F5 / Cmd+Shift+R)
  2. Verify template.css is loading
  3. Check CSS specificity conflicts
  4. Review custom CSS in user.css

Mobile View Issues

  1. Test with browser dev tools responsive mode
  2. Check viewport meta tag in template
  3. Verify breakpoint media queries
  4. Test on actual devices when possible

Accessibility Issues

  1. Run WAVE or axe DevTools accessibility check
  2. Test with keyboard navigation only
  3. Verify screen reader compatibility
  4. Check color contrast ratios

Getting Help


Version History

Version Date Changes
03.07.00 2026-02-22 Initial release of all mobile-responsive overrides

Additional Resources


Metadata

  • Document: docs/MODULE_OVERRIDES.md
  • Repository: https://github.com/mokoconsulting-tech/MokoCassiopeia
  • Path: /docs/MODULE_OVERRIDES.md
  • Owner: Moko Consulting
  • Version: 03.07.00
  • Status: Active
  • Effective Date: 2026-02-22
  • Classification: Public Open Source Documentation

Revision History

Date Change Summary Author
2026-02-22 Initial creation with comprehensive module override documentation GitHub Copilot