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

feat(plugin-docs): docs sidebar item link: support "autoAddBaseUrl" attribute #7949

Merged
merged 1 commit into from
Aug 12, 2022
Merged

feat(plugin-docs): docs sidebar item link: support "autoAddBaseUrl" attribute #7949

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-content-docs/src/sidebars/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export type SidebarItemLink = SidebarItemBase & {
type: 'link';
href: string;
label: string;
autoAddBaseUrl?: boolean;
};

export type SidebarItemAutogenerated = SidebarItemBase & {
Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-content-docs/src/sidebars/validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ const sidebarItemHtmlSchema = sidebarItemBaseSchema.append<SidebarItemHtml>({
const sidebarItemLinkSchema = sidebarItemBaseSchema.append<SidebarItemLink>({
type: 'link',
href: URISchema.required(),
autoAddBaseUrl: Joi.boolean(),
label: Joi.string()
.required()
.messages({'any.unknown': '"label" must be a string'}),
Expand Down
3 changes: 2 additions & 1 deletion packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Link/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export default function DocSidebarItemLink({
index,
...props
}: Props): JSX.Element {
const {href, label, className} = item;
const {href, label, className, autoAddBaseUrl} = item;
const isActive = isActiveSidebarItem(item, activePath);
const isInternalLink = isInternalUrl(href);
return (
Expand All @@ -44,6 +44,7 @@ export default function DocSidebarItemLink({
'menu__link--active': isActive,
},
)}
autoAddBaseUrl={autoAddBaseUrl}
aria-current={isActive ? 'page' : undefined}
to={href}
{...(isInternalLink && {
Expand Down
23 changes: 20 additions & 3 deletions website/_dogfooding/docs-tests-sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,27 @@ const sidebars = {
],
},
{
type: 'link',
label: 'External link',
href: 'https://github.com/facebook/docusaurus',
type: 'category',
label: 'Link tests',
className: 'red',
items: [
{
type: 'link',
label: 'External link absolute',
href: 'https://github.com/facebook/docusaurus',
},
{
type: 'link',
label: 'pathname:/// link',
href: 'pathname:///some/local/path',
},
{
type: 'link',
label: 'pathname:/// link (no baseUrl)',
href: 'pathname:///some/local/path',
autoAddBaseUrl: false,
},
],
},
{
type: 'category',
Expand Down