diff --git a/packages/docusaurus-theme-classic/src/theme/Tabs/index.tsx b/packages/docusaurus-theme-classic/src/theme/Tabs/index.tsx index d1148a27a5..4c56b2e9a7 100644 --- a/packages/docusaurus-theme-classic/src/theme/Tabs/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/Tabs/index.tsx @@ -21,18 +21,32 @@ function isInViewport(element: HTMLElement): boolean { return top >= 0 && right <= innerWidth && bottom <= innerHeight && left >= 0; } -const keys = { - left: 37, - right: 39, -} as const; - function Tabs(props: Props): JSX.Element { - const {lazy, block, defaultValue, values, groupId, className} = props; - const {tabGroupChoices, setTabGroupChoices} = useUserPreferencesContext(); - const [selectedValue, setSelectedValue] = useState(defaultValue); + const { + lazy, + block, + defaultValue: defaultValueProp, + values: valuesProp, + groupId, + className, + } = props; const children = Children.toArray( props.children, ) as ReactElement[]; + const values = + valuesProp ?? + children.map((child) => { + return { + value: child.props.value, + label: child.props.label, + }; + }); + const defaultValue = + defaultValueProp ?? + children.find((child) => child.props.default)?.props.value; + + const {tabGroupChoices, setTabGroupChoices} = useUserPreferencesContext(); + const [selectedValue, setSelectedValue] = useState(defaultValue); const tabRefs: (HTMLLIElement | null)[] = []; if (groupId != null) { @@ -77,17 +91,17 @@ function Tabs(props: Props): JSX.Element { } }; - const handleKeydown = (event) => { - let focusElement; + const handleKeydown = (event: React.KeyboardEvent) => { + let focusElement: HTMLLIElement | null = null; - switch (event.keyCode) { - case keys.right: { - const nextTab = tabRefs.indexOf(event.target) + 1; + switch (event.key) { + case 'ArrowRight': { + const nextTab = tabRefs.indexOf(event.target as HTMLLIElement) + 1; focusElement = tabRefs[nextTab] || tabRefs[0]; break; } - case keys.left: { - const prevTab = tabRefs.indexOf(event.target) - 1; + case 'ArrowLeft': { + const prevTab = tabRefs.indexOf(event.target as HTMLLIElement) - 1; focusElement = tabRefs[prevTab] || tabRefs[tabRefs.length - 1]; break; } @@ -123,7 +137,7 @@ function Tabs(props: Props): JSX.Element { onKeyDown={handleKeydown} onFocus={handleTabChange} onClick={handleTabChange}> - {label} + {label ?? value} ))} diff --git a/packages/docusaurus-theme-classic/src/types.d.ts b/packages/docusaurus-theme-classic/src/types.d.ts index bf6df3a329..0f0711ae69 100644 --- a/packages/docusaurus-theme-classic/src/types.d.ts +++ b/packages/docusaurus-theme-classic/src/types.d.ts @@ -522,6 +522,8 @@ declare module '@theme/TabItem' { export type Props = { readonly children: ReactNode; readonly value: string; + readonly default?: boolean; + readonly label?: string; readonly hidden?: boolean; readonly className?: string; }; @@ -539,7 +541,7 @@ declare module '@theme/Tabs' { readonly block?: boolean; readonly children: readonly ReactElement[]; readonly defaultValue?: string; - readonly values: readonly {value: string; label: string}[]; + readonly values?: readonly {value: string; label?: string}[]; readonly groupId?: string; readonly className?: string; }; diff --git a/website/docs/guides/markdown-features/markdown-features-tabs.mdx b/website/docs/guides/markdown-features/markdown-features-tabs.mdx index efc8b2c3d4..4e4e2da682 100644 --- a/website/docs/guides/markdown-features/markdown-features-tabs.mdx +++ b/website/docs/guides/markdown-features/markdown-features-tabs.mdx @@ -5,32 +5,46 @@ description: Using tabs inside Docusaurus Markdown slug: /markdown-features/tabs --- +```mdx-code-block +import BrowserWindow from '@site/src/components/BrowserWindow'; import Tabs from '@theme/Tabs'; - import TabItem from '@theme/TabItem'; +``` -To show tabbed content within Markdown files, you can fall back on MDX. Docusaurus provides `` components out-of-the-box. +Docusaurus provides `` components that you can use thanks to [MDX](./markdown-features-react.mdx): ```jsx import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; - - This is an apple 🍎 - This is an orange 🍊 - This is a banana 🍌 + + + This is an apple 🍎 + + + This is an orange 🍊 + + + This is a banana 🍌 + ; ``` -And you will get the following: - ```mdx-code-block + + + This is an apple 🍎 + This is an orange 🍊 + This is a banana 🍌 + + +``` + +--- + +It is also possible to provide `values` and `defaultValue` props to `Tabs`: + +```jsx ``` -:::info +```mdx-code-block + + + This is an apple 🍎 + This is an orange 🍊 + This is a banana 🍌 + + +
+``` -By default, tabs are rendered eagerly, but it is possible to load them lazily by passing the `lazy` prop to the `Tabs` component. +
+ Tabs props take precedence over the TabItem props: + +```jsx + + + This is an apple 🍎 + + + This is an orange 🍊 + + + This is a banana 🍌 + + +``` + +```mdx-code-block + + + This is an apple 🍎 + This is an orange 🍊 + This is a banana 🍌 + + +
+``` + +
+ +:::tip + +By default, all tabs are rendered eagerly during the build process, and search engines can index hidden tabs. + +It is possible to only render the default tab with ``. ::: ## Displaying a default tab -Set the `defaultValue` prop in the `Tabs` component to the label value of your choice to show the matching tab by default. +Add `default` to one of the tab items to make it displayed by default. You can also set the `defaultValue` prop in the `Tabs` component to the label value of your choice. -For example, in the example above, `defaultValue="apple"` forces the `Apple` tab to be open by default. +For example, in the example above, setting `default` for the `value="apple"` tab forces it to be open by default. -If the `defaultValue` prop is not provided or refers to an non-existing value, only the tab headings appear until the user clicks on a tab. +If none of the children contains the `default` prop, neither is the `defaultValue` provided for the `Tabs`, or it refers to an non-existing value, only the tab headings appear until the user clicks on a tab. ## Syncing tab choices {#syncing-tab-choices} You may want choices of the same kind of tabs to sync with each other. For example, you might want to provide different instructions for users on Windows vs users on macOS, and you want to changing all OS-specific instructions tabs in one click. To achieve that, you can give all related tabs the same `groupId` prop. Note that doing this will persist the choice in `localStorage` and all `` instances with the same `groupId` will update automatically when the value of one of them is changed. Note that `groupID` are globally-namespaced. -```jsx {2,14} - -Use Ctrl + C to copy. -Use Command + C to copy. +```jsx +// highlight-next-line + + Use Ctrl + C to copy. + Use Command + C to copy. - -Use Ctrl + V to paste. -Use Command + V to paste. +// highlight-next-line + + Use Ctrl + V to paste. + Use Command + V to paste. ``` ```mdx-code-block - - Use Ctrl + C to copy. - Use Command + C to copy. - + + + Use Ctrl + C to copy. + Use Command + C to copy. + - - Use Ctrl + V to paste. - Use Command + V to paste. - + + Use Ctrl + V to paste. + Use Command + V to paste. + + +
``` For all tab groups that have the same `groupId`, the possible values do not need to be the same. If one tab group with chooses an value that does not exist in another tab group with the same `groupId`, the tab group with the missing value won't change its tab. You can see that from the following example. Try to select Linux, and the above tab groups doesn't change. ```jsx - - I am Windows. - I am macOS. - I am Linux. + + + I am Windows. + + + I am macOS. + + + I am Linux. + ``` ```mdx-code-block - - I am Windows. - I am macOS. - I am Linux. - + + + I am Windows. + I am macOS. + I am Linux. + + ``` --- Tab choices with different `groupId`s will not interfere with each other: -```jsx {2,14} - -Windows in windows. -macOS is macOS. +```jsx +// highlight-next-line + + Windows in windows. + macOS is macOS. - -Windows is windows. -Unix is unix. +// highlight-next-line + + Windows is windows. + Unix is unix. ``` ```mdx-code-block - - Windows in windows. - macOS is macOS. - + + + Windows in windows. + macOS is macOS. + - - Windows is windows. - Unix is unix. - + + Windows is windows. + Unix is unix. + + ``` ## Customizing tabs {#customizing-tabs} You might want to customize the appearance of certain set of tabs. To do that you can pass the string in `className` prop and the specified CSS class will be added to the `Tabs` component: -```jsx {5} +```jsx import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; - - This is an apple 🍎 - This is an orange 🍊 - This is a banana 🍌 +// highlight-next-line + + + This is an apple 🍎 + + This is an orange 🍊 + This is a banana 🍌 ; ``` ```mdx-code-block - - This is an apple 🍎 - This is an orange 🍊 - This is a banana 🍌 - + + + This is an apple 🍎 + This is an orange 🍊 + This is a banana 🍌 + + ``` diff --git a/website/src/components/BrowserWindow/styles.module.css b/website/src/components/BrowserWindow/styles.module.css index 40f5a4db4e..c1aa5645fc 100644 --- a/website/src/components/BrowserWindow/styles.module.css +++ b/website/src/components/BrowserWindow/styles.module.css @@ -9,6 +9,7 @@ border: 3px solid var(--ifm-color-emphasis-200); border-top-left-radius: var(--ifm-global-radius); border-top-right-radius: var(--ifm-global-radius); + box-shadow: var(--ifm-global-shadow-lw); } .browserWindowHeader { diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 0302fa6640..5b8f461dda 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -69,7 +69,6 @@ html[data-theme='dark'] .header-github-link:before { } .unique-tabs .tabs__item { - height: 18px; line-height: 16px; margin-right: 8px; }