Skip to content

Commit 1453e26

Browse files
kartbennashif
kartben
authored and
nashif
committed
doc: update doxygen awesome to v2.3.1
Update to a more recent version of Doyxgen Awesome for better compatibilty with recent versions of Doxygen. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 7d2b330 commit 1453e26

6 files changed

+1436
-233
lines changed

‎doc/_doxygen/doxygen-awesome-darkmode-toggle.js

+48-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ https://github.com/jothepro/doxygen-awesome-css
55
66
MIT License
77
8-
Copyright (c) 2021 jothepro
8+
Copyright (c) 2021 - 2023 jothepro
99
1010
Permission is hereby granted, free of charge, to any person obtaining a copy
1111
of this software and associated documentation files (the "Software"), to deal
@@ -28,19 +28,25 @@ SOFTWARE.
2828
*/
2929

3030
class DoxygenAwesomeDarkModeToggle extends HTMLElement {
31+
// SVG icons from https://fonts.google.com/icons
32+
// Licensed under the Apache 2.0 license:
33+
// https://www.apache.org/licenses/LICENSE-2.0.html
34+
static lightModeIcon = `<svg xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#FCBF00"><rect fill="none" height="24" width="24"/><circle cx="12" cy="12" opacity=".3" r="3"/><path d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg>`
35+
static darkModeIcon = `<svg xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#FE9700"><rect fill="none" height="24" width="24"/><path d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27 C17.45,17.19,14.93,19,12,19c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z" opacity=".3"/><path d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg>`
36+
static title = "Toggle Light/Dark Mode"
37+
3138
static prefersLightModeInDarkModeKey = "prefers-light-mode-in-dark-mode"
3239
static prefersDarkModeInLightModeKey = "prefers-dark-mode-in-light-mode"
3340

3441
static _staticConstructor = function() {
35-
DoxygenAwesomeDarkModeToggle.darkModeEnabled = DoxygenAwesomeDarkModeToggle.userPreference
36-
DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.darkModeEnabled)
42+
DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.userPreference)
3743
// Update the color scheme when the browsers preference changes
3844
// without user interaction on the website.
3945
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
4046
DoxygenAwesomeDarkModeToggle.onSystemPreferenceChanged()
4147
})
4248
// Update the color scheme when the tab is made visible again.
43-
// It is possible that the appearance was changed in another tab
49+
// It is possible that the appearance was changed in another tab
4450
// while this tab was in the background.
4551
document.addEventListener("visibilitychange", visibilityState => {
4652
if (document.visibilityState === 'visible') {
@@ -49,6 +55,32 @@ class DoxygenAwesomeDarkModeToggle extends HTMLElement {
4955
});
5056
}()
5157

58+
static init() {
59+
$(function() {
60+
$(document).ready(function() {
61+
const toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
62+
toggleButton.title = DoxygenAwesomeDarkModeToggle.title
63+
toggleButton.updateIcon()
64+
65+
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
66+
toggleButton.updateIcon()
67+
})
68+
document.addEventListener("visibilitychange", visibilityState => {
69+
if (document.visibilityState === 'visible') {
70+
toggleButton.updateIcon()
71+
}
72+
});
73+
74+
$(document).ready(function(){
75+
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
76+
})
77+
$(window).resize(function(){
78+
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
79+
})
80+
})
81+
})
82+
}
83+
5284
constructor() {
5385
super();
5486
this.onclick=this.toggleDarkMode
@@ -65,7 +97,7 @@ class DoxygenAwesomeDarkModeToggle extends HTMLElement {
6597
* @returns `true` for dark-mode, `false` for light-mode user preference
6698
*/
6799
static get userPreference() {
68-
return (!DoxygenAwesomeDarkModeToggle.systemPreference && localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)) ||
100+
return (!DoxygenAwesomeDarkModeToggle.systemPreference && localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)) ||
69101
(DoxygenAwesomeDarkModeToggle.systemPreference && !localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey))
70102
}
71103

@@ -88,11 +120,12 @@ class DoxygenAwesomeDarkModeToggle extends HTMLElement {
88120
}
89121

90122
static enableDarkMode(enable) {
91-
let head = document.getElementsByTagName('head')[0]
92123
if(enable) {
124+
DoxygenAwesomeDarkModeToggle.darkModeEnabled = true
93125
document.documentElement.classList.add("dark-mode")
94126
document.documentElement.classList.remove("light-mode")
95127
} else {
128+
DoxygenAwesomeDarkModeToggle.darkModeEnabled = false
96129
document.documentElement.classList.remove("dark-mode")
97130
document.documentElement.classList.add("light-mode")
98131
}
@@ -109,6 +142,15 @@ class DoxygenAwesomeDarkModeToggle extends HTMLElement {
109142

110143
toggleDarkMode() {
111144
DoxygenAwesomeDarkModeToggle.userPreference = !DoxygenAwesomeDarkModeToggle.userPreference
145+
this.updateIcon()
146+
}
147+
148+
updateIcon() {
149+
if(DoxygenAwesomeDarkModeToggle.darkModeEnabled) {
150+
this.innerHTML = DoxygenAwesomeDarkModeToggle.darkModeIcon
151+
} else {
152+
this.innerHTML = DoxygenAwesomeDarkModeToggle.lightModeIcon
153+
}
112154
}
113155
}
114156

‎doc/_doxygen/doxygen-awesome-sidebar-only-darkmode-toggle.css

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
21
/**
32
43
Doxygen Awesome
54
https://github.com/jothepro/doxygen-awesome-css
65
76
MIT License
87
9-
Copyright (c) 2021 jothepro
8+
Copyright (c) 2021 - 2023 jothepro
109
1110
Permission is hereby granted, free of charge, to any person obtaining a copy
1211
of this software and associated documentation files (the "Software"), to deal

‎doc/_doxygen/doxygen-awesome-sidebar-only.css

+10-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ https://github.com/jothepro/doxygen-awesome-css
55
66
MIT License
77
8-
Copyright (c) 2021 jothepro
8+
Copyright (c) 2021 - 2023 jothepro
99
1010
Permission is hereby granted, free of charge, to any person obtaining a copy
1111
of this software and associated documentation files (the "Software"), to deal
@@ -31,10 +31,16 @@ html {
3131
/* side nav width. MUST be = `TREEVIEW_WIDTH`.
3232
* Make sure it is wide enough to contain the page title (logo + title + version)
3333
*/
34-
--side-nav-fixed-width: 340px;
34+
--side-nav-fixed-width: 335px;
3535
--menu-display: none;
3636

3737
--top-height: 120px;
38+
--toc-sticky-top: -25px;
39+
--toc-max-height: calc(100vh - 2 * var(--spacing-medium) - 25px);
40+
}
41+
42+
#projectname {
43+
white-space: nowrap;
3844
}
3945

4046

@@ -64,6 +70,7 @@ html {
6470
height: var(--top-height);
6571
margin-bottom: calc(0px - var(--top-height));
6672
max-width: var(--side-nav-fixed-width);
73+
overflow: hidden;
6774
background: var(--side-nav-background);
6875
}
6976
#main-nav {
@@ -74,6 +81,7 @@ html {
7481
.ui-resizable-handle {
7582
cursor: default;
7683
width: 1px !important;
84+
background: var(--separator-color);
7785
box-shadow: 0 calc(-2 * var(--top-height)) 0 0 var(--separator-color);
7886
}
7987

0 commit comments

Comments
 (0)