doxygen-awesome-darkmode-toggle.js 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. /**
  2. Doxygen Awesome
  3. https://github.com/jothepro/doxygen-awesome-css
  4. MIT License
  5. Copyright (c) 2021 - 2023 jothepro
  6. Permission is hereby granted, free of charge, to any person obtaining a copy
  7. of this software and associated documentation files (the "Software"), to deal
  8. in the Software without restriction, including without limitation the rights
  9. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. copies of the Software, and to permit persons to whom the Software is
  11. furnished to do so, subject to the following conditions:
  12. The above copyright notice and this permission notice shall be included in all
  13. copies or substantial portions of the Software.
  14. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20. SOFTWARE.
  21. */
  22. class DoxygenAwesomeDarkModeToggle extends HTMLElement {
  23. // SVG icons from https://fonts.google.com/icons
  24. // Licensed under the Apache 2.0 license:
  25. // https://www.apache.org/licenses/LICENSE-2.0.html
  26. 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>`
  27. 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>`
  28. static title = "Toggle Light/Dark Mode"
  29. static prefersLightModeInDarkModeKey = "prefers-light-mode-in-dark-mode"
  30. static prefersDarkModeInLightModeKey = "prefers-dark-mode-in-light-mode"
  31. static _staticConstructor = function() {
  32. DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.userPreference)
  33. // Update the color scheme when the browsers preference changes
  34. // without user interaction on the website.
  35. window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
  36. DoxygenAwesomeDarkModeToggle.onSystemPreferenceChanged()
  37. })
  38. // Update the color scheme when the tab is made visible again.
  39. // It is possible that the appearance was changed in another tab
  40. // while this tab was in the background.
  41. document.addEventListener("visibilitychange", visibilityState => {
  42. if (document.visibilityState === 'visible') {
  43. DoxygenAwesomeDarkModeToggle.onSystemPreferenceChanged()
  44. }
  45. });
  46. }()
  47. static init() {
  48. $(function() {
  49. $(document).ready(function() {
  50. const toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
  51. toggleButton.title = DoxygenAwesomeDarkModeToggle.title
  52. toggleButton.updateIcon()
  53. window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
  54. toggleButton.updateIcon()
  55. })
  56. document.addEventListener("visibilitychange", visibilityState => {
  57. if (document.visibilityState === 'visible') {
  58. toggleButton.updateIcon()
  59. }
  60. });
  61. $(document).ready(function(){
  62. document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
  63. })
  64. $(window).resize(function(){
  65. document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
  66. })
  67. })
  68. })
  69. }
  70. constructor() {
  71. super();
  72. this.onclick=this.toggleDarkMode
  73. }
  74. /**
  75. * @returns `true` for dark-mode, `false` for light-mode system preference
  76. */
  77. static get systemPreference() {
  78. return window.matchMedia('(prefers-color-scheme: dark)').matches
  79. }
  80. /**
  81. * @returns `true` for dark-mode, `false` for light-mode user preference
  82. */
  83. static get userPreference() {
  84. return (!DoxygenAwesomeDarkModeToggle.systemPreference && localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)) ||
  85. (DoxygenAwesomeDarkModeToggle.systemPreference && !localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey))
  86. }
  87. static set userPreference(userPreference) {
  88. DoxygenAwesomeDarkModeToggle.darkModeEnabled = userPreference
  89. if(!userPreference) {
  90. if(DoxygenAwesomeDarkModeToggle.systemPreference) {
  91. localStorage.setItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey, true)
  92. } else {
  93. localStorage.removeItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)
  94. }
  95. } else {
  96. if(!DoxygenAwesomeDarkModeToggle.systemPreference) {
  97. localStorage.setItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey, true)
  98. } else {
  99. localStorage.removeItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey)
  100. }
  101. }
  102. DoxygenAwesomeDarkModeToggle.onUserPreferenceChanged()
  103. }
  104. static enableDarkMode(enable) {
  105. if(enable) {
  106. DoxygenAwesomeDarkModeToggle.darkModeEnabled = true
  107. document.documentElement.classList.add("dark-mode")
  108. document.documentElement.classList.remove("light-mode")
  109. } else {
  110. DoxygenAwesomeDarkModeToggle.darkModeEnabled = false
  111. document.documentElement.classList.remove("dark-mode")
  112. document.documentElement.classList.add("light-mode")
  113. }
  114. }
  115. static onSystemPreferenceChanged() {
  116. DoxygenAwesomeDarkModeToggle.darkModeEnabled = DoxygenAwesomeDarkModeToggle.userPreference
  117. DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.darkModeEnabled)
  118. }
  119. static onUserPreferenceChanged() {
  120. DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.darkModeEnabled)
  121. }
  122. toggleDarkMode() {
  123. DoxygenAwesomeDarkModeToggle.userPreference = !DoxygenAwesomeDarkModeToggle.userPreference
  124. this.updateIcon()
  125. }
  126. updateIcon() {
  127. if(DoxygenAwesomeDarkModeToggle.darkModeEnabled) {
  128. this.innerHTML = DoxygenAwesomeDarkModeToggle.darkModeIcon
  129. } else {
  130. this.innerHTML = DoxygenAwesomeDarkModeToggle.lightModeIcon
  131. }
  132. }
  133. }
  134. customElements.define("doxygen-awesome-dark-mode-toggle", DoxygenAwesomeDarkModeToggle);