Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(theme): refactor Tabs, make groupId + queryString work fine together #8486

Merged
merged 7 commits into from Dec 29, 2022
Merged

fix(theme): refactor Tabs, make groupId + queryString work fine together #8486

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9aa0e33
make it work
slorber Dec 28, 2022
c5d914c
remove useless TabGroupChoiceProvider
slorber Dec 28, 2022
8446195
cleanup
slorber Dec 28, 2022
f872fbd
cleanup
slorber Dec 28, 2022
4294f6b
cleanup
slorber Dec 28, 2022
a7ed687
localStorage: dispatch real storage events: allow subscribing from bo…
slorber Dec 29, 2022
3acb760
nit
slorber Dec 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 4 additions & 26 deletions packages/docusaurus-theme-classic/src/theme-classic.d.ts
View file
Open in desktop
Expand Up @@ -1232,39 +1232,17 @@ declare module '@theme/Mermaid' {
}

declare module '@theme/TabItem' {
import type {ReactNode} from 'react';
import type {TabItemProps} from '@docusaurus/theme-common/internal';

export interface Props {
readonly children: ReactNode;
readonly value: string;
readonly default?: boolean;
readonly label?: string;
readonly hidden?: boolean;
readonly className?: string;
readonly attributes?: {[key: string]: unknown};
}
export interface Props extends TabItemProps {}

export default function TabItem(props: Props): JSX.Element;
}

declare module '@theme/Tabs' {
import type {ReactElement} from 'react';
import type {Props as TabItemProps} from '@theme/TabItem';
import type {TabsProps} from '@docusaurus/theme-common/internal';

export interface Props {
readonly lazy?: boolean;
readonly block?: boolean;
readonly children: readonly ReactElement<TabItemProps>[];
readonly defaultValue?: string | null;
readonly values?: readonly {
value: string;
label?: string;
attributes?: {[key: string]: unknown};
}[];
readonly groupId?: string;
readonly className?: string;
readonly queryString?: string | boolean;
}
export interface Props extends TabsProps {}

export default function Tabs(props: Props): JSX.Element;
}
Expand Down
2 changes: 0 additions & 2 deletions packages/docusaurus-theme-classic/src/theme/Layout/Provider/index.tsx
View file
Open in desktop
Expand Up @@ -9,7 +9,6 @@ import React from 'react';
import {composeProviders} from '@docusaurus/theme-common';
import {
ColorModeProvider,
TabGroupChoiceProvider,
AnnouncementBarProvider,
DocsPreferredVersionContextProvider,
ScrollControllerProvider,
Expand All @@ -21,7 +20,6 @@ import type {Props} from '@theme/Layout/Provider';
const Provider = composeProviders([
ColorModeProvider,
AnnouncementBarProvider,
TabGroupChoiceProvider,
ScrollControllerProvider,
DocsPreferredVersionContextProvider,
PluginHtmlClassNameProvider,
Expand Down
9 changes: 2 additions & 7 deletions packages/docusaurus-theme-classic/src/theme/Tabs/__tests__/index.test.tsx
View file
Open in desktop
Expand Up @@ -7,10 +7,7 @@

import React, {type ReactNode} from 'react';
import renderer from 'react-test-renderer';
import {
TabGroupChoiceProvider,
ScrollControllerProvider,
} from '@docusaurus/theme-common/internal';
import {ScrollControllerProvider} from '@docusaurus/theme-common/internal';
import {StaticRouter} from 'react-router-dom';
import Tabs from '../index';
import TabItem from '../../TabItem';
Expand All @@ -24,9 +21,7 @@ function TestProviders({
}) {
return (
<StaticRouter location={{pathname}}>
<ScrollControllerProvider>
<TabGroupChoiceProvider>{children}</TabGroupChoiceProvider>
</ScrollControllerProvider>
<ScrollControllerProvider>{children}</ScrollControllerProvider>
</StaticRouter>
);
}
Expand Down