-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into docs/components.json
- Loading branch information
Showing
27 changed files
with
238 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| title: Dark Mode | ||
| description: Adding dark mode to your site. | ||
| --- | ||
|
|
||
| <div className="grid sm:grid-cols-2 gap-4 sm:gap-6"> | ||
| <LinkedCard href="/docs/dark-mode/next"> | ||
| <svg | ||
| role="img" | ||
| viewBox="0 0 24 24" | ||
| xmlns="http://www.w3.org/2000/svg" | ||
| className="w-10 h-10" | ||
| fill="currentColor" | ||
| > | ||
| <title>Next.js</title> | ||
| <path d="M11.5725 0c-.1763 0-.3098.0013-.3584.0067-.0516.0053-.2159.021-.3636.0328-3.4088.3073-6.6017 2.1463-8.624 4.9728C1.1004 6.584.3802 8.3666.1082 10.255c-.0962.659-.108.8537-.108 1.7474s.012 1.0884.108 1.7476c.652 4.506 3.8591 8.2919 8.2087 9.6945.7789.2511 1.6.4223 2.5337.5255.3636.04 1.9354.04 2.299 0 1.6117-.1783 2.9772-.577 4.3237-1.2643.2065-.1056.2464-.1337.2183-.1573-.0188-.0139-.8987-1.1938-1.9543-2.62l-1.919-2.592-2.4047-3.5583c-1.3231-1.9564-2.4117-3.556-2.4211-3.556-.0094-.0026-.0187 1.5787-.0235 3.509-.0067 3.3802-.0093 3.5162-.0516 3.596-.061.115-.108.1618-.2064.2134-.075.0374-.1408.0445-.495.0445h-.406l-.1078-.068a.4383.4383 0 01-.1572-.1712l-.0493-.1056.0053-4.703.0067-4.7054.0726-.0915c.0376-.0493.1174-.1125.1736-.143.0962-.047.1338-.0517.5396-.0517.4787 0 .5584.0187.6827.1547.0353.0377 1.3373 1.9987 2.895 4.3608a10760.433 10760.433 0 004.7344 7.1706l1.9002 2.8782.096-.0633c.8518-.5536 1.7525-1.3418 2.4657-2.1627 1.5179-1.7429 2.4963-3.868 2.8247-6.134.0961-.6591.1078-.854.1078-1.7475 0-.8937-.012-1.0884-.1078-1.7476-.6522-4.506-3.8592-8.2919-8.2087-9.6945-.7672-.2487-1.5836-.42-2.4985-.5232-.169-.0176-1.0835-.0366-1.6123-.037zm4.0685 7.217c.3473 0 .4082.0053.4857.047.1127.0562.204.1642.237.2767.0186.061.0234 1.3653.0186 4.3044l-.0067 4.2175-.7436-1.14-.7461-1.14v-3.066c0-1.982.0093-3.0963.0234-3.1502.0375-.1313.1196-.2346.2323-.2955.0961-.0494.1313-.054.4997-.054z" /> | ||
| </svg> | ||
| <p className="font-medium mt-2">Next.js</p> | ||
| </LinkedCard> | ||
| <LinkedCard href="/docs/dark-mode/vite"> | ||
| <svg | ||
| role="img" | ||
| viewBox="0 0 24 24" | ||
| xmlns="http://www.w3.org/2000/svg" | ||
| className="w-10 h-10" | ||
| fill="currentColor" | ||
| > | ||
| <title>Vite</title> | ||
| <path d="m8.286 10.578.512-8.657a.306.306 0 0 1 .247-.282L17.377.006a.306.306 0 0 1 .353.385l-1.558 5.403a.306.306 0 0 0 .352.385l2.388-.46a.306.306 0 0 1 .332.438l-6.79 13.55-.123.19a.294.294 0 0 1-.252.14c-.177 0-.35-.152-.305-.369l1.095-5.301a.306.306 0 0 0-.388-.355l-1.433.435a.306.306 0 0 1-.389-.354l.69-3.375a.306.306 0 0 0-.37-.36l-2.32.536a.306.306 0 0 1-.374-.316zm14.976-7.926L17.284 3.74l-.544 1.887 2.077-.4a.8.8 0 0 1 .84.369.8.8 0 0 1 .034.783L12.9 19.93l-.013.025-.015.023-.122.19a.801.801 0 0 1-.672.37.826.826 0 0 1-.634-.302.8.8 0 0 1-.16-.67l1.029-4.981-1.12.34a.81.81 0 0 1-.86-.262.802.802 0 0 1-.165-.67l.63-3.08-2.027.468a.808.808 0 0 1-.768-.233.81.81 0 0 1-.217-.6l.389-6.57-7.44-1.33a.612.612 0 0 0-.64.906L11.58 23.691a.612.612 0 0 0 1.066-.004l11.26-20.135a.612.612 0 0 0-.644-.9z" /> | ||
| </svg> | ||
| <p className="font-medium mt-2">Vite</p> | ||
| </LinkedCard> | ||
| </div> | ||
|
|
||
| ## Other frameworks | ||
|
|
||
| I'm looking for help writing guides for other frameworks. Help me write guides for Remix, Astro and Vite by [opening an PR](https://github.com/shadcn/ui). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| --- | ||
| title: Vite | ||
| description: Adding dark mode to your vite app. | ||
| --- | ||
|
|
||
| ## Dark mode | ||
|
|
||
| <Steps> | ||
|
|
||
| ### Create a theme provider | ||
|
|
||
| ```tsx title="components/theme-provider.tsx" | ||
| import { createContext, useContext, useEffect, useState } from "react" | ||
|
|
||
| type ThemeProviderProps = { | ||
| children: React.ReactNode | ||
| defaultTheme?: string | ||
| storageKey?: string | ||
| } | ||
|
|
||
| type ThemeProviderState = { | ||
| theme: string | ||
| setTheme: (theme: string) => void | ||
| } | ||
|
|
||
| const initialState = { | ||
| theme: "system", | ||
| setTheme: () => null, | ||
| } | ||
|
|
||
| const ThemeProviderContext = createContext<ThemeProviderState>(initialState) | ||
|
|
||
| export function ThemeProvider({ | ||
| children, | ||
| defaultTheme = "system", | ||
| storageKey = "vite-ui-theme", | ||
| ...props | ||
| }: ThemeProviderProps) { | ||
| const [theme, setTheme] = useState( | ||
| () => localStorage.getItem(storageKey) || defaultTheme | ||
| ) | ||
|
|
||
| useEffect(() => { | ||
| const root = window.document.documentElement | ||
|
|
||
| root.classList.remove("light", "dark") | ||
|
|
||
| if (theme === "system") { | ||
| const systemTheme = window.matchMedia("(prefers-color-scheme: dark)") | ||
| .matches | ||
| ? "dark" | ||
| : "light" | ||
|
|
||
| root.classList.add(systemTheme) | ||
| return | ||
| } | ||
|
|
||
| root.classList.add(theme) | ||
| }, [theme]) | ||
|
|
||
| const value = { | ||
| theme, | ||
| setTheme: (theme: string) => { | ||
| localStorage.setItem(storageKey, theme) | ||
| setTheme(theme) | ||
| }, | ||
| } | ||
|
|
||
| return ( | ||
| <ThemeProviderContext.Provider {...props} value={value}> | ||
| {children} | ||
| </ThemeProviderContext.Provider> | ||
| ) | ||
| } | ||
|
|
||
| export const useTheme = () => { | ||
| const context = useContext(ThemeProviderContext) | ||
|
|
||
| if (context === undefined) | ||
| throw new Error("useTheme must be used within a ThemeProvider") | ||
|
|
||
| return context | ||
| } | ||
| ``` | ||
|
|
||
| ### Wrap your root layout | ||
|
|
||
| Add the `ThemeProvider` to your root layout. | ||
|
|
||
| ```tsx {1,5-7} title="App.tsx" | ||
| import { ThemeProvider } from "@/components/theme-provider" | ||
|
|
||
| function App() { | ||
| return ( | ||
| <ThemeProvider defaultTheme="dark" storageKey="vite-ui-theme"> | ||
| {children} | ||
| </ThemeProvider> | ||
| ) | ||
| } | ||
|
|
||
| export default App | ||
| ``` | ||
|
|
||
| ### Add a mode toggle | ||
|
|
||
| Place a mode toggle on your site to toggle between light and dark mode. | ||
|
|
||
| ```tsx title="components/mode-toggle.tsx" | ||
| import { Moon, Sun } from "lucide-react" | ||
|
|
||
| import { Button } from "@/components/ui/button" | ||
| import { | ||
| DropdownMenu, | ||
| DropdownMenuContent, | ||
| DropdownMenuItem, | ||
| DropdownMenuTrigger, | ||
| } from "@/components/ui/dropdown-menu" | ||
| import { useTheme } from "@/components/theme-provider" | ||
|
|
||
| export function ModeToggle() { | ||
| const { setTheme } = useTheme() | ||
|
|
||
| return ( | ||
| <DropdownMenu> | ||
| <DropdownMenuTrigger asChild> | ||
| <Button variant="outline" size="icon"> | ||
| <Sun className="h-[1.2rem] w-[1.2rem] rotate-0 scale-100 transition-all dark:-rotate-90 dark:scale-0" /> | ||
| <Moon className="absolute h-[1.2rem] w-[1.2rem] rotate-90 scale-0 transition-all dark:rotate-0 dark:scale-100" /> | ||
| <span className="sr-only">Toggle theme</span> | ||
| </Button> | ||
| </DropdownMenuTrigger> | ||
| <DropdownMenuContent align="end"> | ||
| <DropdownMenuItem onClick={() => setTheme("light")}> | ||
| Light | ||
| </DropdownMenuItem> | ||
| <DropdownMenuItem onClick={() => setTheme("dark")}> | ||
| Dark | ||
| </DropdownMenuItem> | ||
| <DropdownMenuItem onClick={() => setTheme("system")}> | ||
| System | ||
| </DropdownMenuItem> | ||
| </DropdownMenuContent> | ||
| </DropdownMenu> | ||
| ) | ||
| } | ||
| ``` | ||
|
|
||
| </Steps> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.