Loading...

Documentation Plugin

bs Dark Mode

The bs Dark Mode plugin is a simple and easy-to-use solution for enabling Bootstrap dark mode theme. With this plugin, your visitors can toggle between a light and dark mode view of your website, making it easier on the eyes and reducing eye strain, particularly in low-light conditions.

Installation

  1. Buy plugin
  2. In your admin panel, go to Plugins > and click the Add New button.
  3. Click Upload Plugin and Choose File, then select the Plugin’s .zip file. Click Install Now.
  4. Click Activate to use your new Plugin right away.

Usage

If the plugin is installed and activated, dark mode is already active and follows the OS settings. Additionally, there are two templates available that allow users to overwrite the OS settings using a switch/dropdown via shortcode in a widget position.

Only one template should be used at a time, as using both may create issues because they do not update each other.

Switch template

Click me!

To enable the Switch template, use the

[bs-dark-mode]

shortcode on any widget position where you want to add the switch. The plugin will automatically detect the OS’s dark/light theme and switch accordingly when the user clicks on the switch.

Wrap shortcode in a div with Bootstrap font-size classes to adjust the size (non-working dark-theme, just a switch size demo).

<div class="fs-1">
  [bs-dark-mode]
</div>

Dropdown template

To enable the Dropdown template, use the

[bs-dark-mode-dropdown]

shortcode on on any widget position where you want to add the dropdown toggler. The dropdown has options for light, dark, and auto mode. The plugin will automatically detect the OS’s dark/light theme and switch to auto mode accordingly.

The logo isn’t part of Bootstrap’s dark mode because it depends on the type of logo being used.

Switching a single-color logo to dark mode is simple using filters, such as filter: invert(1); or filter: brightness(9);. Combinations are also possible, as used here on bootscore.me.

[data-bs-theme="dark"] {
  
  .logo {
    filter: invert(0.48) brightness(1.8);
  }
}

Switching a multi-color logo to dark mode can be approached in various ways. Here is a method that utilizes background-images while respecting bootScore’s responsive logos.

  • Create light versions of your logo, name them as logo-light-sm.svg and logo-light.svg and copy them to the /img/logo/ folder in your child-theme.
  • Add the following SCSS code to your child’s /scss/_bscore_custom.scss file.
#masthead {

  // Set logo image opacity to 0
  .logo {
    opacity: 0;
  }

  // Use a background-image logo instead
  .navbar-brand {
    background-image: url(../img/logo/logo-sm.svg);
    background-repeat: no-repeat;
    background-position: center;
  }

  // Use different logo on breakpoint md up
  @include media-breakpoint-up(md) {
    .navbar-brand {
      background-image: url(../img/logo/logo.svg);
    }
  }
}

// Use light logo background-image variants if dark-mode is enabled
[data-bs-theme="dark"] {

  #masthead {

    .navbar-brand {
      background-image: url(../img/logo/logo-light-sm.svg);
    }

    @include media-breakpoint-up(md) {
      .navbar-brand {
        background-image: url(../img/logo/logo-light.svg);
      }
    }
  }
}

Overriding templates via theme

Template files can be found within the /bs-dark-mode/templates/ plugin directory.

Edit files in an upgrade-safe way using overrides. Copy the template into a directory within your theme named bs-dark-mode keeping the same file structure but removing the templates subdirectory. Path must be your-theme/bs-dark-mode/[file].php.

The copied file will now override the bs Dark Mode template file. Change HTML as you want.

Templates that can be overridden

  • sc-switch.php
  • sc-dropdown.php

Changelog

  • [IMPROVEMENT] Moved css and src to assets folder
  • [UPDATE] Bootstrap 5.3.3 script
  • [UPDATE] Update checker 5.4

  • [FEATURE] Rewrite locate template script to skip -main suffix in child folder
  • [IMPROVEMENT] Removed -main branch suffix from plugin’s folder. This does not affect existing bs-dark-mode-main installations.
  • [UPDATE] Update checker 5.3

  • [BUGFIX] Incorrect use of label for=FORM_ELEMENT in switch template
  • [IMPROVEMENT] Deny direct access
  • [IMPROVEMENT] Reformat files
  • [FEATURE] Include Update Checker

  • [REMOVED] Custom dark-theme
  • [UPDATE] Bootstrap 5.3.0 dark theme
  • [FEATURE] Template engine
  • [FEATURE] Dropdown template

  • [IMPROVEMENT] Moon icon

  • [IMPROVEMENT] Refactored switch.css to svg background images
  • [UPDATE] dark-mode.css
  • [UPDATE] Ready for Bootstrap 5.2.0
  • [NEW] Added responsive offcanvas

  • [BUGFIX] .form-check-input:checked
  • [IMPROVEMENT] .form-switch
  • [IMPROVEMENT] .form-range
  • [IMPROVEMENT] .form-control::file-selector-button
  • [IMPROVEMENT] Reformat all files
  • [IMPROVEMENT] Added .cursor-pointer class to switch

  • [IMPROVEMENT] Changed cookie function name
  • [IMPROVEMENT] Refactored dark-theme.css to Bootstrap variables
  • [IMPROVEMENT] Refactored switch.css
  • [IMPROVEMENT] Switch icons uses now em instead of rem
  • [IMPROVEMENT] jQuery is now separated
  • [BUGFIX] Switch icons in Firefox

  • [BUGFIX] Assigned icons to dark-mode-switch only
  • [UPDATE] Added text-dark to text-light

  • [UPDATE] Offcanvas cart blockUI

  • [UPDATE] Accordion item dark
  • [UPDATE] Bootstrap 5.0.0 Beta 3

  • [BUGFIX] Added dark-theme to modal, new offcanvas component and blockquote

  • [BUGFIX] Adjusted icon positions in Firefox

  • [BUGFIX] Added dark-theme to accordion

  • [BUGFIX] Added dark-theme background-color to pre

  • [SEO] Load dark-mode.js in footer

  • Initial release

45 Comments on “bs Dark Mode”

  • Daniel Munoz Rey

    says:

    With the Dark mode plugin, how can I have dark mode as dark as default (not light) without clicking in the button?

    Thank you.

    • Basti

      says:

      Yes, that is possible thinking the other way. Make a dark theme as default and the dark-theme as light.

      1. Dequeue plugin dark-theme.css as described in the article above

      2. Add CSS to make body dark

      body {
          background-color: var(--bs-gray-dark) !important;
          color: var(--bs-light) !important;
      }
      

      3. Copy header.php and footer.php to child theme.
      Change classes in these files from bg-light to bg-dark.
      Change class navbar-light to navbar-dark.
      Add class text-light to footer. Now you should have a dark theme.

      4. Create you new light-theme by using the dark-theme body class.

      body.dark-theme {
          color: var(--bs-dark) !important;
          background-color: #fff !important;
      }
      
      .dark-theme .bg-dark {
          background-color: var(--bs-light) !important;
      }
      
      .dark-theme .navbar-dark .navbar-nav .nav-link {
          color: rgba(0,0,0,.55);
      }
      
      .dark-theme .text-light {
          color: #212529!important;
      }
      

      5. Change icons in switch

      .form-switch .form-check-input::before {
          content: "\f185 ";
      }
      
      .form-switch .form-check-input::after {
          content: "\f186";
      }
      
      • Daniel Munoz Rey

        says:

        Cannot this just be an option in the plugin?… deciding the default?… like activating the button to be dark on load?… just a thought… Thank you.

      • Basti

        says:

        That would mean that the cookie is set and will be removed when the switch is clicked. At the moment I don’t see any reason why that should be the case.

        • Daniel Munoz Rey

          says:

          OK… I just like more the dark mode than the light mode and would like that as default or option in admin area, but I understand… Thank you Basti.

      • Basti

        says:

        All plugins here, except bS Isotope do not have any backend settings. The only thing what the dark mode do is setting a cookie, add a class to body and keep both until you switch it off. With the body class, you can do whatever you want.

        • Daniel Munoz Rey

          says:

          Could it be done by adding a parameter to the shortcode?… juts a thought:

          [bs-dark-mode default="dark"]
          [bs-dark-mode default="light"]

          Daniel.

      • Basti

        says:

        Maybe yes, but I don’t really see the point. You have to adjust your themes anyway. So, make your default theme dark and change to the light one by clicking the switch. The easiest and best method.

      • Nathan Hardwick

        says:

        Hi Basti – I’ve just tried this method with the updated theme and plugin but it no longer works for everything. My widget areas are still retaining the original light theme backgrounds. Any ideas on how to fix? Thanks.

      • Nathan Hardwick

        says:

        I’ve found the the issuse is that in tag there is data-bs-theme=”light” but can’t seem to find how to override this? I added data-bs-theme=”dark” to me header templates but that doesn’t work – it just reverts back to data-bs-theme=”light”

        • Basti

          says:

          Hi Nathan,

          I have to check this on your site. Please send WP admin and ftp here https://bootscore.me/private-info-form/. Which theme and plugin version are you using?

          Asking this because dark-mode has been refactored and uses included dark-mode since Bootstrap 5.3.

    • Pavel Lazarev

      says:

      Hi, I know, that’s too late to answer, but if it can be useful for anybody, why not…
      I wrote a simple script for Jquery that simulates pressing a button only once and writes it to cookie:

      if(!cookieStorage.getCookie(‘dark_mode_custom’)) {
      $(‘body’).addClass(‘dark-theme’);
      $(‘#dark-mode’).addClass(‘active’);
      $(‘#dark-mode’).prop(‘checked’, true);
      cookieStorage.setCookie(‘dark_mode_custom’, ‘true’, 2629000000, ‘/’);
      cookieStorage.setCookie(‘bS-Dark-Mode’, ‘true’, 2628000000, ‘/’);
      }

      • Basti

        says:

        Hi Pavel,

        it’s never too late, thank you for this script. Maybe we’ll add it to the documentation. Changed the to ' and works fine.

        if (!cookieStorage.getCookie('dark_mode_custom')) {
          $('body').addClass('dark-theme');
          $('#dark-mode').addClass('active');
          $('#dark-mode').prop('checked', true);
          cookieStorage.setCookie('dark_mode_custom', 'true', 2629000000, '/');
          cookieStorage.setCookie('bS-Dark-Mode', 'true', 2628000000, '/');
        }
        
        • Ersin Koray Gonce

          says:

          where to paste this code?

          • Basti

            says:

            To child’s custom.js. But this code won’t work with new dark-mode anymore, it was for the old version.

  • Daniel Munoz Rey

    says:

    The main point is for clients who are not developers so they can decide easily the default mode, in a way your plugin would have more options which is always good… but I will try to do it the developer way… Thank you.

    Daniel.

    • Basti

      says:

      Everything here is for developers and not for end users. Clients should pay you to develop a site and customize plugins.

  • Bart Boerendans

    says:

    So for i really enjoy these plugins. Maybe you can add a feature in an upcoming release? Just fire a Google analytics event if a user enabled Dark mode. Would love to see how many users just change to dark mode.

    • Basti

      says:

      Hello Bart,

      tracking will not be part of the project, but you can setup your own. Try something like this:

      $('#dark-mode').click(function () {
      
          console.log('testing google anayltics custom event');
      
          //you should first check if ga is set
          if (typeof ga !== 'undefined') {
              ga('send', 'event', 'Dark-Mode', 'Switch is checked');
          }
          //check if _gaq is set too
          if (typeof _gaq !== 'undefined') {
              _gaq.push(['_trackEvent', 'Dark-Mode', 'Switch is checked']);
          }
      
      });
      

      https://stackoverflow.com/questions/18696998/ga-or-gaq-push-for-google-analytics-event-tracking

    • Bryan

      says:

      You can actually do it purely with Google Tag Manager, and that seems preferable. No need to add the additional JS to your site and maintain it with future changes. Plus, if you’re using GA4 or UA, I don’t believe ga and _gaq.push work for them. Just use click event triggers and attach them to tags (two triggers, two tags).

      1. Enable the Click ID and Click Classes variables in the Variables link in the sidebar of GTM (“Configure” button under Built-In Variables and select them).

      2. Go to Triggers and click on New. Click on Trigger Configuration and then select All Elements under the Click section. Select the “Some Clicks” radio button and add two fields to match the items below. Repeat this step once more for the second set of triggers.

      `Click ID ‘EQUALS’ dark-mode` and
      `Click Classes ‘EQUALS’ form-check-input btn-toggle position-relative active`

      `Click ID ‘EQUALS’ dark-mode` and
      `Click Classes ‘DOES NOT EQUAL’ form-check-input btn-toggle position-relative active`

      Name the triggers whatever is easiest for you to remember. Mine are `Clicks – Dark Mode Switch Off` and `Clicks – Dark Mode Switch On`.

      3. Add the Tags as GA4 Events and attach the above triggers to each one (be sure to use your GA4 Measurement ID as the Configuration Tag). The Event Name is what gets sent to Analytics, so name them to make it easier for yourself. I named my events `dark_mode_switch_dark` and `dark_mode_switch_light` to indicate which one was switched on — easy enough to tell in Analytics.

      4. Go to Analytics and create a custom dimension to be able to save these new events. Without the custom dimension, you’ll only be able to see them in the Realtime overview. Simply name it what you want and input the event name from step 3 as the Event Parameter. Do it for both events.

  • Bart

    says:

    Is it an idea to add the modalbox in darkmode too for a future version?

    • Basti

      says:

      Hi Bart,

      there is a new version with a dark theme to modal. Download the plugin via the dashboard https://bootscore.me/account/downloads/ and update via the plugin uploader.

      Please check


  • Manuel Lamer

    says:

    Hello, how is it possible to use another file as a logo for dark mode? For example, „logo-light.svg“ and „logo-dark.svg“.
    Because it doesn’t work as it should with filters for multicolor logos and it’s an image file in dark mode instead of an SVG file. Thank you for your help.

    • Basti

      says:

      Hello Manuel,

      1. Remove logo filter in dark-theme.css line 70 to 73
      2. Add jQuery to js/custom.js in child-theme or in any .js file you want

      // Change dark-mode logo. Use full URL
      jQuery(document).ready(function ($) {
      
          // Toggle logo on click dark-mode switch
          $(".btn-toggle").click(function () {
              if ($(this).is(":checked")) {
                  $('.logo').attr('src', 'https://yourdomain/wp-content/themes/bootscore-5-child/img/logo/logo-dark-theme.svg');
              } else {
                  $('.logo').attr('src', 'https://yourdomain/wp-content/themes/bootscore-5-child/img/logo/logo-light-theme.svg');
              }
          });
      
          // Keep logo via body class
          if ($('body').hasClass("dark-theme")) {
              $('.logo').attr('src', 'https://yourdomain/wp-content/themes/bootscore-5-child/img/logo/logo-dark-theme.svg');
          }
      
      });
      

      That should work

      • Manuel Lamer

        says:

        Hello, thank you for the quick answer. However, I still have one problem: when I switch to dark mode with the switch, it changes the logo. However, if I switch to another side in dark mode, only the alt-Tag comes from the logo.

        • Basti

          says:

          HeIlo Manuel,

          it seems that the path to the second part “// Keep logo via body class” is not correct. But I cannot say something without checking your site. Please share a link to your site, if you do not want to share public, you can send me the link via the contact form https://bootscore.me/support/

          • Manuel Lamer

            says:

            Oh dear, it was the path to the file that was incorrect. How embarrassing =)
            It works fine now, thanks for your quick and easy help, really great.

            • Basti

              says:

              👍 You‘re welcome

  • Bart

    says:

    How to achieve that if no cookie is placed (user did not switch manually), choose the darkmode switch based on the device mode. Maybe with a media query like https://drafts.csswg.org/mediaqueries-5/#prefers-color-scheme?

    That if the user uses dark mode on the device, bs-darkmode is automatically enabled too.

    • Basti

      says:

      Hi Bart,

      basically yes, but you need a cookie to keep body class and remove it if you switch to light mode. In case to provide both options, theme selected by OS and switching manually, the plugin has to be rewritten with a new approach. Please check here https://css-tricks.com/a-complete-guide-to-dark-mode-on-the-web/

  • ramis can

    says:

    Dear admin, thank you for this nice plugin. Is it possible to change the colors of links (a) only when switching to dark mode? I tried a few things, it didn’t work. Thank you in advance for your help.

    • Basti

      says:

      Hi ramis,

      of course, that’s possible.

      1. If you haven’t done already, update theme and child to latest version as described here https://bootscore.me/blog/bootstrap/bootstrap-source-in-theme/.

      2. Dequeue dark-theme.css by adding the code snippet in article above to functions.php.

      3. Add following CSS to _bscore_custom.scss

      .dark-theme a {
          color: red;
      }
      
      • ramis can

        says:

        Thank you so much. Worked. Have a nice day.

  • ramis can

    says:

    Dear Manager; Thank you again for this great theme.
    I am using wordpress.org/plugins/w3-total-cache/ on my wordpress website. I wonder what should I do to prevent the dark-mode plugin and the selected preferences from being cached? Thank you in advance for your help.

    • Basti

      says:

      Hi ramis,

      caching files is what a caching plugin do. Why do you want to exclude dark-mode files from caching?

  • ramis can

    says:

    You are right. to block the cache; That’s why I asked if there is a cookie or other method used by the plugin. While the w3 total cache plugin is active, it does not work when you return to the same page and switch to light mode. that is, the cache shows which one (dark or light) is cached. If it is cached while dark mode is active; light doesn’t work when I switch to view.

    • Basti

      says:

      Hi ramis,

      a link to your site will be very helpful to reproduce the issue.

      Plugin uses a cookie to store the body class to prevent flickering while reloading the page. Once loaded, all CSS and JS files are cached, that’s what a caching plugin do.

      Here on bootscore.me Autoptimize plugin is used for caching https://wordpress.org/plugins/autoptimize/. This does exactly the same as W3 Total Cache. Please check if the issue is on bootscore.me the same as on your site in the same use case.

      Here, all files are cached. I’m sure there is a field in Backend where you can exclude files from caching in plugin settings. But usually you do not need that.

      • ramis can

        says:

        Nice person; Thank you for your help and interest. I understood what you said. I will define cookie information and block it. Thanks again, regards.

        • Basti

          says:

          Hi ramis,

          I am absolutely sure that you do not have to change anything in the dark mode or caching plugin.

          cookieStorage.setCookie(‘bS-Dark-Mode’, ‘true;secure;SameSite=Lax’, 2628000000, ‘/’);

          That looks for me that you are trying to setup a reCaptcha on your computers localhost.

  • Derrick Boddie

    says:

    Dear admin, The plugin is not working on mobile devices like iPhones. It looks like the javascript is not running on mobile devices. Any idea how I can fix this problem?

    • Basti

      says:

      Hi Derrick,

      we need a link to your project to check this. If you do not want to share public, simply send a mail through the support form https://bootscore.me/support/.

      Additionally, it would be very helpful if you could provide the version numbers of both the theme and plugin. Both of them received an update last week (see https://bootscore.me/blog/bootstrap/bootscore-5-3-0/). It’s possible that you may be using the new plugin version with an earlier theme version, or vice versa.

      Thank you!

  • Murat Esgin

    says:

    Hello Basti. Thank you again for the new version of bootscore theme. Now I’m trying the 5.3 version trial on localhost. I set the link color #00bc8c in the dark theme. In light theme, I want to #d13241. However, even though I made additions to the _bscore_variables.scss file under the scss folder, there is no change when I refresh the theme. Without using the _bscore_custom.scss file. In summary, I want to change the default value of link colors on bootstrap. I’ll be glad, if you help me.

    • Basti

      says:

      Hi Murat,

      please post this in a new discussion because this has nothing to do with the plugin, it’s a general Bootstrap thing. Sharing code snippets on GitHub is much more better than here in the comments. Will help you out there.

  • Murat Esgin

    says:

    I am sorry. Comments were closed in the 5.3 version news in the blog section. I also wrote here. Ok, I’m going to the discussion section. Thank you very much. Enjoy your work.

Leave a Comment

To top