Dark Mode

The Dark Mode feature provides users with a comfortable viewing experience in low-light environments. It intelligently detects user preferences and allows manual toggling with session persistence.

Overview

The dark mode system includes:


Admin Settings

Navigate to Routes → Config → Styles tab to find the Dark Mode settings.

Enable Dark Mode

Default: Enabled

This master toggle enables or disables the entire dark mode system:

Show Dark Mode Toggle

Default: Enabled

Controls whether the floating toggle button appears on the frontend:

Follow Browser Preference

Default: Enabled

Enables automatic detection of the user's browser/system preference:


How It Works for Users

Default Behaviour (No Manual Toggle)

When a user first visits your site:

  1. The plugin checks their browser/system dark mode preference
  2. If their system is set to dark mode, the site displays in dark mode
  3. If their system is set to light mode, the site displays in light mode
  4. No preference is stored - the plugin simply follows the system setting

After Manual Toggle

When a user clicks the toggle button:

  1. Their choice is saved to the browser's session storage
  2. This choice persists across page navigation within the session
  3. The manual choice overrides the system preference
  4. When the browser closes, the preference is cleared
💡 Privacy-Friendly: Session storage is used rather than cookies or local storage, meaning the preference automatically resets when the user closes their browser.

Toggle Button Appearance


What Changes in Dark Mode

Dark mode applies comprehensive styling across all plugin elements:

Affected Elements

Colour Scheme

Element Light Mode Dark Mode
Background White (#ffffff) Dark grey (#1a1a1a)
Text Dark (#212529) Light (#e9ecef)
Cards White Slightly lighter grey (#242424)

Troubleshooting

Dark Mode Not Showing

Toggle Button Not Visible

Theme Not Persisting

Colours Look Wrong


Accessibility

The dark mode feature is built with accessibility in mind: