Installation & Updates

Requirements

Check what your site needs to run Dark Mode.

Installation

Install Dark Mode through Composer or the Plugin Store.

Updating

Update to the latest release of Dark Mode 1.x.

Disabling

Temporarily turn off Dark Mode for your site.

Uninstalling

Remove Dark Mode from your site.

Requirements

Dark Mode 1.x requires:

• Craft CMS 5.x
• PHP 8.2 or later within PHP 8.x

Your site must also meet Craft 5’s system requirements. Use a current version of Chrome, Edge, Firefox, or Safari.

Dark Mode is free and open source. There are no paid editions or license purchases.

Installation

Install Dark Mode using Composer or the Craft Plugin Store.

Composer (CLI)

Run these commands in your terminal. Recommended

1

Open your Craft project

cd /path/to/project

2

Get Dark Mode

Latest Version

composer require solspace/craft-dark-mode -w

Specific Version

composer require solspace/craft-dark-mode:1.1.0 -w

3

Install Dark Mode

CLI

php craft plugin/install dark-mode

Control Panel

To finish installation in the Craft control panel:

1. Go to Settings → Plugins.
2. Open Dark Mode’s action menu.
3. Choose Install.

Control Panel

1

Find Dark Mode

Open the Plugin Store in your Craft control panel and search for Dark Mode by Solspace.

2

Install the plugin

Open Dark Mode’s product page and click Install.

Once installed, click the appearance icon beside your account avatar to choose Auto, Light, or Dark. There are no additional settings or build steps.

Updating

Dark Mode has no content tables or database migrations. You can update it using Craft’s updater, Composer, or the control panel.

Craft Update (CLI)

Use Craft’s update command. Recommended

1

Open your Craft project

cd /path/to/project

2

Check for updates

php craft update

3

Update Dark Mode

Latest Version

php craft update dark-mode

Specific Version

php craft update dark-mode:1.1.0

Composer (CLI)

Use Composer to update Dark Mode within the version allowed by your project.

1

Update composer.json

Latest Versions

Use ^1.0.0 to allow updates within Dark Mode 1.x:

{
  "require": {
    "craftcms/cms": "^5.0.0",
    "solspace/craft-dark-mode": "^1.0.0"
  }
}

Locked Versions

If your project uses an exact version, change it to the release you want to install:

"require": {
    "craftcms/cms": "^5.0.0",
-   "solspace/craft-dark-mode": "1.0.0"
+   "solspace/craft-dark-mode": "1.1.0"
}

2

Open your Craft project

cd /path/to/project

3

Get updates

composer update solspace/craft-dark-mode --with-dependencies

Control Panel

1

Check for updates

Open Utilities → Updates in the Craft control panel and review the available Dark Mode update.

2

Run the update

Click Update for Dark Mode and follow Craft’s prompts to finish the update.

Check your team’s main screens after updating Dark Mode or another plugin. See Plugin Compatibility for supported versions.

Disable Dark Mode

Disable Dark Mode to temporarily turn it off for everyone without uninstalling it. To change only your own appearance, choose Light instead.

CLI

1

Open your Craft project

cd /path/to/project

2

Disable Dark Mode

php craft plugin/disable dark-mode

Control Panel

1

Go to Settings → Plugins.

2

Click the Cog button for Dark Mode.

3

Select Disable.

To turn it back on, choose Enable from the same menu or run php craft plugin/enable dark-mode.

Uninstall Dark Mode

Uninstalling Dark Mode returns Craft to its normal appearance. It does not affect your site’s content, and you can reinstall it at any time.

CLI

1

Open your Craft project

cd /path/to/project

2

Uninstall Dark Mode

php craft plugin/uninstall dark-mode

3

Remove the package

After uninstalling the plugin:

composer remove solspace/craft-dark-mode

Control Panel

1

Uninstall Dark Mode

Go to Settings → Plugins, open Dark Mode’s action menu, and choose Uninstall.

2

Remove the package

From your Craft project directory:

composer remove solspace/craft-dark-mode

To reinstall, follow the installation steps above. For help, contact Solspace Support.