From dacd95987fc5f5a36e11218ad9ff486e8a1ec3e2 Mon Sep 17 00:00:00 2001 From: witt Date: Sat, 26 Jun 2021 23:49:06 +0800 Subject: [PATCH] docs: improve the copywriting content of the document (#571) * docs: export individual style types for each component * docs: improve the copywriting content of the document * docs: optimize the document site experience on mobile devices --- components/use-toasts/index.ts | 2 +- components/use-toasts/use-toast.tsx | 4 +- lib/components/layout.tsx | 14 +++---- lib/components/menu/menu-links.tsx | 2 +- lib/components/menu/menu-sticker.tsx | 38 +++++++++++++---- lib/components/sidebar/active-catalog.tsx | 13 ++++++ lib/components/sidebar/active-link.tsx | 26 +++++++++++- lib/components/sidebar/index.tsx | 2 +- lib/components/sidebar/tabbar-mobile.tsx | 21 ++++++---- lib/data/metadata-en-us.json | 2 +- pages/_app.tsx | 15 ++----- pages/en-us/components/auto-complete.mdx | 46 +++++++++++--------- pages/en-us/components/badge.mdx | 6 +-- pages/en-us/components/button-dropdown.mdx | 32 ++++++++------ pages/en-us/components/card.mdx | 4 +- pages/en-us/components/checkbox.mdx | 36 ++++++++-------- pages/en-us/components/dot.mdx | 14 +++++-- pages/en-us/components/fieldset.mdx | 38 ++++++++--------- pages/en-us/components/input.mdx | 32 +++++++------- pages/en-us/components/link.mdx | 18 ++++---- pages/en-us/components/loading.mdx | 6 +-- pages/en-us/components/note.mdx | 18 +++++--- pages/en-us/components/progress.mdx | 24 +++++++---- pages/en-us/components/radio.mdx | 24 +++++------ pages/en-us/components/select.mdx | 6 +-- pages/en-us/components/slider.mdx | 6 +-- pages/en-us/components/snippet.mdx | 38 +++++++++++------ pages/en-us/components/tabs.mdx | 18 ++++---- pages/en-us/components/text.mdx | 2 +- pages/en-us/components/textarea.mdx | 36 +++++++++------- pages/en-us/components/toast.mdx | 16 +++---- pages/en-us/components/toggle.mdx | 6 +-- pages/en-us/components/tooltip.mdx | 2 +- pages/en-us/components/user.mdx | 2 +- pages/zh-cn/components/auto-complete.mdx | 44 ++++++++++--------- pages/zh-cn/components/badge.mdx | 6 +-- pages/zh-cn/components/button-dropdown.mdx | 32 ++++++++------ pages/zh-cn/components/dot.mdx | 14 +++++-- pages/zh-cn/components/input.mdx | 49 +++++++++++----------- pages/zh-cn/components/loading.mdx | 6 +-- pages/zh-cn/components/note.mdx | 18 +++++--- pages/zh-cn/components/progress.mdx | 24 +++++++---- pages/zh-cn/components/snippet.mdx | 38 +++++++++++------ pages/zh-cn/components/text.mdx | 2 +- pages/zh-cn/components/textarea.mdx | 38 ++++++++++------- pages/zh-cn/components/toast.mdx | 6 +-- pages/zh-cn/components/tooltip.mdx | 2 +- pages/zh-cn/components/user.mdx | 2 +- 48 files changed, 499 insertions(+), 351 deletions(-) diff --git a/components/use-toasts/index.ts b/components/use-toasts/index.ts index a559ff2..ff8b50e 100644 --- a/components/use-toasts/index.ts +++ b/components/use-toasts/index.ts @@ -1,4 +1,4 @@ import useToasts from './use-toast' -export type { ToastAction, Toast, ToastType } from './use-toast' +export type { ToastAction, Toast, ToastTypes } from './use-toast' export default useToasts diff --git a/components/use-toasts/use-toast.tsx b/components/use-toasts/use-toast.tsx index bca6d9b..8abc782 100644 --- a/components/use-toasts/use-toast.tsx +++ b/components/use-toasts/use-toast.tsx @@ -10,10 +10,10 @@ export interface ToastAction { handler: (event: React.MouseEvent, cancel: () => void) => void passive?: boolean } -export type ToastType = NormalTypes +export type ToastTypes = NormalTypes export interface Toast { text?: string | React.ReactNode - type?: ToastType + type?: ToastTypes delay?: number actions?: Array } diff --git a/lib/components/layout.tsx b/lib/components/layout.tsx index f2c2c76..e33a697 100644 --- a/lib/components/layout.tsx +++ b/lib/components/layout.tsx @@ -62,7 +62,6 @@ export const Layout: React.FC> = React.memo( display: flex; box-sizing: border-box; } - .sidebar { width: 200px; margin-right: 20px; @@ -76,13 +75,11 @@ export const Layout: React.FC> = React.memo( transition: transform 200ms ease-out; z-index: 100; } - .side-shadow { width: 220px; flex-shrink: 0; height: 100vh; } - .main { display: flex; max-width: calc(100% - 220px); @@ -97,7 +94,7 @@ export const Layout: React.FC> = React.memo( .layout { max-width: 100%; width: 100%; - padding: 5rem 1rem; + padding: 20px 1rem; } .sidebar { @@ -107,11 +104,14 @@ export const Layout: React.FC> = React.memo( right: 0; z-index: 10; width: 100vw; - height: ${expanded ? '100vh' : '0'}; - background-color: ${theme.palette.background}; - padding: 0; + box-sizing: border-box; + height: ${expanded ? '90vh' : '0'}; + background-color: transparent; + backdrop-filter: invert(15%) blur(5px); + padding: var(--geist-page-nav-height) 0 0 0; overflow: hidden; transition: height 250ms ease; + box-shadow: ${expanded ? theme.expressiveness.shadowSmall : 'none'}; } .main { diff --git a/lib/components/menu/menu-links.tsx b/lib/components/menu/menu-links.tsx index 78b9378..672a38a 100644 --- a/lib/components/menu/menu-links.tsx +++ b/lib/components/menu/menu-links.tsx @@ -33,7 +33,7 @@ const MenuLinks = () => { position: relative; margin: 0 auto; padding: 0 ${theme.layout.gap}; - height: 60px; + height: var(--geist-page-nav-height); } .site-name { diff --git a/lib/components/menu/menu-sticker.tsx b/lib/components/menu/menu-sticker.tsx index dec89f9..6fa7bad 100644 --- a/lib/components/menu/menu-sticker.tsx +++ b/lib/components/menu/menu-sticker.tsx @@ -1,5 +1,5 @@ import React, { useEffect, useMemo } from 'react' -import { Tabs, useTheme } from 'components' +import { useMediaQuery, Tabs, useTheme } from 'components' import useCurrentState from 'components/utils/use-current-state' import Router from 'next/router' import Metadatas from 'lib/data' @@ -12,10 +12,13 @@ const MenuSticker = () => { const { tabbar: currentUrlTabValue, locale } = useLocale() const [tabValue, setTabValue, tabValueRef] = useCurrentState('') const [fixed, setFixed, fixedRef] = useCurrentState(false) + const isSM = useMediaQuery('sm', { match: 'down' }) + const isXS = useMediaQuery('xs', { match: 'down' }) + const isFixedTabs = fixed && !isXS const tabbarData = useMemo(() => Metadatas[locale], [locale]) - useEffect(() => updateTabbarFixed(fixed), [fixed]) + useEffect(() => updateTabbarFixed(isFixedTabs), [isFixedTabs]) useEffect(() => setTabValue(currentUrlTabValue), [currentUrlTabValue]) useEffect(() => { const scrollHandler = () => { @@ -36,15 +39,18 @@ const MenuSticker = () => { return ( <> -
-