From 551ebcf5b3769815e791b29cf1ee52c5e8cd0ed0 Mon Sep 17 00:00:00 2001
From: maropboia <164220066+maropboia@users.noreply.github.com>
Date: Fri, 3 May 2024 11:38:35 +0600
Subject: [PATCH] comment

---
 .vitepress/theme/Layout.vue | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/.vitepress/theme/Layout.vue b/.vitepress/theme/Layout.vue
index ada010bfb..8e3cc55a2 100644
--- a/.vitepress/theme/Layout.vue
+++ b/.vitepress/theme/Layout.vue
@@ -1,22 +1,28 @@
 <script setup lang="ts">
+// Import necessary components and functions from VitePress, Vue, and the local project.
 import DefaultTheme from 'vitepress/theme'
 import { useData } from 'vitepress'
 import { nextTick, provide } from 'vue'
 import Sidebar from './components/SidebarCard.vue'
 import Announcement from './components/Announcement.vue'
 
+// Get the isDark value from the VitePress data object.
 const { isDark } = useData()
 
+// Define a function to check if the browser supports transitions and reduced motion preferences.
 const enableTransitions = () =>
   'startViewTransition' in document &&
   window.matchMedia('(prefers-reduced-motion: no-preference)').matches
 
+// Provide a method for toggling the appearance (dark/light mode) with an optional MouseEvent parameter.
 provide('toggle-appearance', async ({ clientX: x, clientY: y }: MouseEvent) => {
   if (!enableTransitions()) {
+    // If transitions are not supported, simply toggle the isDark value.
     isDark.value = !isDark.value
     return
   }
 
+  // Calculate the clip path for the transition animation.
   const clipPath = [
     `circle(0px at ${x}px ${y}px)`,
     `circle(${Math.hypot(
@@ -25,12 +31,14 @@ provide('toggle-appearance', async ({ clientX: x, clientY: y }: MouseEvent) => {
     )}px at ${x}px ${y}px)`
   ]
 
-  // @ts-expect-error
+  // Use the startViewTransition function to create a smooth transition effect.
+  // @ts-expect-error: TypeScript error due to the use of a non-standard function.
   await document.startViewTransition(async () => {
     isDark.value = !isDark.value
     await nextTick()
   }).ready
 
+  // Apply an animation to the document element for the transition.
   document.documentElement.animate(
     { clipPath: isDark.value ? clipPath.reverse() : clipPath },
     {
@@ -41,22 +49,28 @@ provide('toggle-appearance', async ({ clientX: x, clientY: y }: MouseEvent) => {
   )
 })
 
+// Destructure the Layout component from the DefaultTheme.
 const { Layout } = DefaultTheme
 </script>
 
 <template>
+  <!-- Use the Layout component as the base for the page. -->
   <Layout>
+    <!-- Add the Sidebar component after the default sidebar navigation. -->
     <template #sidebar-nav-after>
       <Sidebar />
     </template>
+    <!-- Add the Announcement component before the page content on the home page. -->
     <template #home-hero-prelink>
       <Announcement />
     </template>
+    <!-- Display the page content. -->
     <Content />
   </Layout>
 </template>
 
 <style>
+// Style the view-transition pseudo-elements for smooth transitions between dark and light modes.
 ::view-transition-old(root),
 ::view-transition-new(root) {
   animation: none;
@@ -73,10 +87,12 @@ const { Layout } = DefaultTheme
   z-index: 9999;
 }
 
+// Style the VPSwitchAppearance component.
 .VPSwitchAppearance {
   width: 22px !important;
 }
 
+// Style the check icon within the VPSwitchAppearance component.
 .VPSwitchAppearance .check {
   transform: none !important;
 }