docs(v2): useThemeContext hook (#2521)

facebook · Apr 3, 2020 · 3052e40 · 3052e40
1 parent b4acb89
commit 3052e40
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/website/docs/theme-classic.md b/website/docs/theme-classic.md
@@ -60,6 +60,27 @@ module.exports = {
 }
 ```
 
+## Hooks
+
+### `useThemeContext`
+
+React hook to access theme context. This context contains functions for setting light and dark mode and boolean property, indicating which mode is currently in use.
+
+Usage example:
+
+```jsx
+import React from 'react';
+// highlight-next-line
+import useThemeContext from '@theme/hooks/useThemeContext';
+
+const Test = () => {
+  // highlight-next-line
+  const {isDarkTheme, setLightTheme, setDarkTheme} = useThemeContext();
+
+  return <h1>Dark mode is now {isDarkTheme ? 'on' : 'off'}</h1>;
+};
+```
+
 ## Navbar
 
 ### Navbar Title & Logo