Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Switch Dark/Light mode using JS #1653

Closed
wants to merge 2 commits into from
Closed

Switch Dark/Light mode using JS #1653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d475b01
Update demo-theme.js
YousefAlsbaihi Jul 16, 2023
829d00d
Update navbar-side.html
YousefAlsbaihi Jul 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 22 additions & 21 deletions src/js/demo-theme.js
View file
Open in desktop
@@ -1,28 +1,29 @@
/**
* demo-theme is specifically loaded right after the body and not deferred
* to ensure we switch to the chosen dark/light theme as fast as possible.
* This will prevent any flashes of the light theme (default) before switching.
*
* This will allow you to load dark/light theme wihtout reloading the page
* and without depending on the link variables
* default theme is light and can be default dark by changing the specified code below
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your new comment is not a substitute for the original.

The reason the original comment is there is to explain why the script is loaded at the top of the body and not what it does. As this reason still applies please leave it intact.

*/

const themeStorageKey = "tablerTheme"
const defaultTheme = "light"
let selectedTheme
var themeStorageKey = "tablerTheme";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the themeStorageKey and defaultTheme do not change during the execution of the script they where made const what is the reason you are turning them into vars?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

var is like $() ... time to let go 😁 (meaning: use let or const instead).

var storedTheme = localStorage.getItem(themeStorageKey);

// https://stackoverflow.com/a/901144
const params = new Proxy(new URLSearchParams(window.location.search), {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of removing the functionality to switch theme with the url why not have both?

Have the button switch using javascript and leave the url variable intact to allow overriding what is currently set in local storage.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be unnecessary, having both of them

get: (searchParams, prop) => searchParams.get(prop),
// Change "light" to "dark" to set default theme dark
var defaultTheme = "light";

selectedTheme = storedTheme ? storedTheme : defaultTheme;

setTheme(selectedTheme)
$(".switchMode").on('click', function (e) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is jQuery actually available here?

The demo-theme.js file is intentionally loaded at the top of the body so as to switch as fast as possible before the dom fully loads but the rest of the javascript is all loaded at the end so i wonder if this will work.

And even if it does work, i think using vanilla JS here to not have the overhead of jQuery loading in might be beneficial.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the time the user clicks, jQuery is likely loaded... so it works by accident.
But you are right, no reason to use jQuery for a simple click event.

let body = document.querySelector("body")
let currentMode = body.getAttribute('data-bs-theme');
let mode = currentMode == 'dark' ? "light" : 'dark';
setTheme(mode);
})

if (!!params.theme) {
localStorage.setItem(themeStorageKey, params.theme)
selectedTheme = params.theme
} else {
const storedTheme = localStorage.getItem(themeStorageKey)
selectedTheme = storedTheme ? storedTheme : defaultTheme
}

if (selectedTheme === 'dark') {
document.body.setAttribute("data-bs-theme", selectedTheme)
} else {
document.body.removeAttribute("data-bs-theme")
}
function setTheme(mode) {
let body = document.querySelector("body")
body.setAttribute('data-bs-theme', mode)
localStorage.setItem(themeStorageKey, mode);
}
4 changes: 2 additions & 2 deletions src/pages/_includes/layout/navbar-side.html
View file
Open in desktop
Expand Up @@ -14,7 +14,7 @@
{% endunless %}

<div class="d-none d-{{ include.breakpoint }}-flex">
<a href="?theme=dark" class="nav-link px-0 hide-theme-dark" title="Enable dark mode" data-bs-toggle="tooltip"
<a href="javascript:;" class="switchMode nav-link px-0 hide-theme-dark" title="Enable dark mode" data-bs-toggle="tooltip"
data-bs-placement="bottom">
{% include ui/icon.html icon="moon" %}
</a>
Expand Down Expand Up @@ -55,4 +55,4 @@
<a href="{{ site.base }}/sign-in.html" class="dropdown-item">Logout</a>
</div>
</div>
</div>
</div>