Skip to content

fix(theme-common): relax Tabs children validation to enable component composition #11728

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

Open
abdulalim110 wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −21
Open

fix(theme-common): relax Tabs children validation to enable component composition #11728

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 1 addition & 21 deletions packages/docusaurus-theme-common/src/utils/tabsUtils.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
*/

import React, {
isValidElement,
useCallback,
useState,
useMemo,
Expand Down Expand Up @@ -52,30 +51,11 @@ export interface TabItemProps {
readonly attributes?: {[key: string]: unknown};
}

// A very rough duck type, but good enough to guard against mistakes while
// allowing customization
function isTabItem(
comp: ReactElement<unknown>,
): comp is ReactElement<TabItemProps> {
const {props} = comp;
return !!props && typeof props === 'object' && 'value' in props;
}

export function sanitizeTabsChildren(children: TabsProps['children']) {
return (React.Children.toArray(children)
.filter((child) => child !== '\n')
.map((child) => {
if (!child || (isValidElement(child) && isTabItem(child))) {
return child;
}
// child.type.name will give non-sensical values in prod because of
// minification, but we assume it won't throw in prod.
throw new Error(
`Docusaurus error: Bad <Tabs> child <${
// @ts-expect-error: guarding against unexpected cases
typeof child.type === 'string' ? child.type : child.type.name
}>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`,
);
return child;
})
?.filter(Boolean) ?? []) as ReactElement<TabItemProps>[];
}
Expand Down