Skip to content

fix: locale switcher common slug #110

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

Merged
carolinamenezes merged 1 commit into from
Sep 13, 2026
Merged

fix: locale switcher common slug #110

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
41 changes: 19 additions & 22 deletions dist/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9965,22 +9965,26 @@ var SidebarElements = ({
locale
} = useContext2(LibraryContext);
const router = useRouter3();
const navigationLocale = router.locale || locale;
const isElementOpen = (slug, defaultOpen) => forceOpen || (sidebarElementStatus.has(slug) ? sidebarElementStatus.get(slug) : !!defaultOpen);
const getPath = (prefix, pathSuffix, slug) => {
const href = prefix === "docs/api-reference" ? `/${prefix}/${slug}/${pathSuffix}` : `/${prefix}/${slug}`;
return href.replaceAll("//", "/");
};
const getHref = (prefix, pathSuffix, slug) => {
const path = getPath(prefix, pathSuffix, slug);
const localePrefix = navigationLocale && navigationLocale !== "en" ? `/${navigationLocale}` : "";
return `${localePrefix}${path}`.replaceAll("//", "/");
};
const handleClick = (e, pathSuffix, slug) => {
e.preventDefault();
const hasEndpointQuery = router.query.endpoint;
const href = getHref(slugPrefix || "", pathSuffix, slug);
router.push(href, href, { locale }).then(() => {
const path = getPath(slugPrefix || "", pathSuffix, slug);
router.push(path, void 0, { locale: navigationLocale }).then(() => {
if (hasEndpointQuery)
router.reload();
});
};
const getHref = (slugPrefix2, pathSuffix, slug) => {
const validLocales = ["pt", "es"];
const localePrefix = locale && validLocales.includes(locale) ? `/${locale}` : "";
const href = slugPrefix2 === "docs/api-reference" ? `/${slugPrefix2}/${slug}/${pathSuffix}` : `${localePrefix}/${slugPrefix2}/${slug}`;
return href.replaceAll("//", "/");
};
const ElementRoot = ({
slug,
name: name2,
Expand Down Expand Up @@ -10018,13 +10022,7 @@ var SidebarElements = ({
size: "regular",
variant: "tertiary",
sx: isHamburgerMenu ? isArrowActive ? styles_default16.arrowIconActiveHamburger : styles_default16.arrowIconHamburger : isArrowActive ? styles_default16.arrowIconActive : styles_default16.arrowIcon,
icon: () => /* @__PURE__ */ jsx23(
IconCaret4,
{
direction: isOpen ? "down" : "right",
size: 16
}
),
icon: () => /* @__PURE__ */ jsx23(IconCaret4, { direction: isOpen ? "down" : "right", size: 16 }),
onClick: () => toggleSidebarElementStatus(localizedSlug, isOpen)
}
) : /* @__PURE__ */ jsx23(
Expand All @@ -10046,7 +10044,7 @@ var SidebarElements = ({
},
href: getHref(slugPrefix || "", pathSuffix, localizedSlug),
target: isEditorPreview === true ? "_blank" : "_self",
locale,
locale: navigationLocale,
children: [
method && /* @__PURE__ */ jsx23(
method_category_default,
Expand Down Expand Up @@ -22505,6 +22503,7 @@ var date_text_default = DateText;

// src/components/article-pagination/index.tsx
import Link14 from "next/link.js";
import { useRouter as useRouter12 } from "next/router.js";
import { Flex as Flex39, Text as Text36, Box as Box44 } from "@vtex/brand-ui";

// src/utils/format-article-date.ts
Expand Down Expand Up @@ -22644,16 +22643,14 @@ var ArticlePagination = ({
previousChildren,
nextChildren
}) => {
const locale = useLocale();
const router = useRouter12();
const contextLocale = useLocale();
const locale = router.locale === "pt" || router.locale === "es" || router.locale === "en" ? router.locale : contextLocale;
const previousLabel = messages[locale]["article_pagination.previous"] || "Previous";
const nextLabel = messages[locale]["article_pagination.next"] || "Next";
const showPrevious = !hidePaginationPrevious && Boolean(pagination?.previousDoc?.slug) && Boolean(pagination?.previousDoc?.name);
const showNext = !hidePaginationNext && Boolean(pagination?.nextDoc?.slug) && Boolean(pagination?.nextDoc?.name);
const previousExtra = previousChildren ?? pagination?.previousDoc?.children ?? formatArticleDateValue(
pagination?.previousDoc?.createdAt,
locale,
"medium"
);
const previousExtra = previousChildren ?? pagination?.previousDoc?.children ?? formatArticleDateValue(pagination?.previousDoc?.createdAt, locale, "medium");
const nextExtra = nextChildren ?? pagination?.nextDoc?.children ?? formatArticleDateValue(pagination?.nextDoc?.createdAt, locale, "medium");
return /* @__PURE__ */ jsx121(Box44, { as: "nav", sx: styles_default48.mainContainer, children: /* @__PURE__ */ jsxs98(Flex39, { sx: styles_default48.flexContainer, children: [
showPrevious && /* @__PURE__ */ jsx121(Box44, { sx: styles_default48.paginationLinkPrevious, children: /* @__PURE__ */ jsx121(
Expand Down
2 changes: 1 addition & 1 deletion dist/index.mjs.map
View file
Open in desktop

Large diffs are not rendered by default.

224 changes: 113 additions & 111 deletions src/components/article-pagination/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,111 +1,113 @@
import { type ReactNode } from 'react'
import Link from 'next/link.js'
import { Flex, Text, Box } from '@vtex/brand-ui'

import { useLocale } from 'utils/context/libraryContext'
import { formatArticleDateValue } from 'utils/format-article-date'
import { messages } from 'utils/get-message'
import styles from './styles'

export type ArticlePaginationDoc = {
slug: string | null
name: string | null
createdAt?: string | null
children?: ReactNode
}

export type ArticlePaginationData = {
previousDoc: ArticlePaginationDoc
nextDoc: ArticlePaginationDoc
}

export type ArticlePaginationProps = {
pagination: ArticlePaginationData
hidePaginationPrevious?: boolean
hidePaginationNext?: boolean
previousChildren?: ReactNode
nextChildren?: ReactNode
}

const ArticlePagination = ({
pagination,
hidePaginationNext = false,
hidePaginationPrevious = false,
previousChildren,
nextChildren,
}: ArticlePaginationProps) => {
const locale = useLocale()
const previousLabel =
messages[locale]['article_pagination.previous'] || 'Previous'
const nextLabel = messages[locale]['article_pagination.next'] || 'Next'

const showPrevious =
!hidePaginationPrevious &&
Boolean(pagination?.previousDoc?.slug) &&
Boolean(pagination?.previousDoc?.name)
const showNext =
!hidePaginationNext &&
Boolean(pagination?.nextDoc?.slug) &&
Boolean(pagination?.nextDoc?.name)

const previousExtra =
previousChildren ??
pagination?.previousDoc?.children ??
formatArticleDateValue(
pagination?.previousDoc?.createdAt,
locale,
'medium'
)
const nextExtra =
nextChildren ??
pagination?.nextDoc?.children ??
formatArticleDateValue(pagination?.nextDoc?.createdAt, locale, 'medium')

return (
<Box as="nav" sx={styles.mainContainer}>
<Flex sx={styles.flexContainer}>
{showPrevious && (
<Box sx={styles.paginationLinkPrevious}>
<Link
style={styles.linkReset}
href={pagination.previousDoc.slug as string}
locale={locale}
>
<Box sx={styles.paginationBox}>
<Text sx={styles.subTitle}>{`« ${previousLabel}`}</Text>
<Text sx={styles.paginationText}>
{pagination.previousDoc.name}
</Text>
{previousExtra != null && previousExtra !== false && (
<Box sx={styles.paginationChildren}>{previousExtra}</Box>
)}
</Box>
</Link>
</Box>
)}

{showNext && (
<Box sx={styles.paginationLinkNext}>
<Link
style={styles.linkReset}
href={pagination.nextDoc.slug as string}
locale={locale}
>
<Box sx={styles.paginationBoxNext}>
<Text sx={styles.subTitle}>{`${nextLabel} »`}</Text>
<Text sx={styles.paginationText}>
{pagination.nextDoc.name}
</Text>
{nextExtra != null && nextExtra !== false && (
<Box sx={styles.paginationChildren}>{nextExtra}</Box>
)}
</Box>
</Link>
</Box>
)}
</Flex>
</Box>
)
}

export default ArticlePagination
import { type ReactNode } from 'react'
import Link from 'next/link.js'
import { useRouter } from 'next/router.js'
import { Flex, Text, Box } from '@vtex/brand-ui'

import { useLocale } from 'utils/context/libraryContext'
import { formatArticleDateValue } from 'utils/format-article-date'
import { messages } from 'utils/get-message'
import styles from './styles'

export type ArticlePaginationDoc = {
slug: string | null
name: string | null
createdAt?: string | null
children?: ReactNode
}

export type ArticlePaginationData = {
previousDoc: ArticlePaginationDoc
nextDoc: ArticlePaginationDoc
}

export type ArticlePaginationProps = {
pagination: ArticlePaginationData
hidePaginationPrevious?: boolean
hidePaginationNext?: boolean
previousChildren?: ReactNode
nextChildren?: ReactNode
}

const ArticlePagination = ({
pagination,
hidePaginationNext = false,
hidePaginationPrevious = false,
previousChildren,
nextChildren,
}: ArticlePaginationProps) => {
const router = useRouter()
const contextLocale = useLocale()
const locale =
router.locale === 'pt' || router.locale === 'es' || router.locale === 'en'
? router.locale
: contextLocale
const previousLabel =
messages[locale]['article_pagination.previous'] || 'Previous'
const nextLabel = messages[locale]['article_pagination.next'] || 'Next'

const showPrevious =
!hidePaginationPrevious &&
Boolean(pagination?.previousDoc?.slug) &&
Boolean(pagination?.previousDoc?.name)
const showNext =
!hidePaginationNext &&
Boolean(pagination?.nextDoc?.slug) &&
Boolean(pagination?.nextDoc?.name)

const previousExtra =
previousChildren ??
pagination?.previousDoc?.children ??
formatArticleDateValue(pagination?.previousDoc?.createdAt, locale, 'medium')
const nextExtra =
nextChildren ??
pagination?.nextDoc?.children ??
formatArticleDateValue(pagination?.nextDoc?.createdAt, locale, 'medium')

return (
<Box as="nav" sx={styles.mainContainer}>
<Flex sx={styles.flexContainer}>
{showPrevious && (
<Box sx={styles.paginationLinkPrevious}>
<Link
style={styles.linkReset}
href={pagination.previousDoc.slug as string}
locale={locale}
>
<Box sx={styles.paginationBox}>
<Text sx={styles.subTitle}>{`« ${previousLabel}`}</Text>
<Text sx={styles.paginationText}>
{pagination.previousDoc.name}
</Text>
{previousExtra != null && previousExtra !== false && (
<Box sx={styles.paginationChildren}>{previousExtra}</Box>
)}
</Box>
</Link>
</Box>
)}

{showNext && (
<Box sx={styles.paginationLinkNext}>
<Link
style={styles.linkReset}
href={pagination.nextDoc.slug as string}
locale={locale}
>
<Box sx={styles.paginationBoxNext}>
<Text sx={styles.subTitle}>{`${nextLabel} »`}</Text>
<Text sx={styles.paginationText}>
{pagination.nextDoc.name}
</Text>
{nextExtra != null && nextExtra !== false && (
<Box sx={styles.paginationChildren}>{nextExtra}</Box>
)}
</Box>
</Link>
</Box>
)}
</Flex>
</Box>
)
}

export default ArticlePagination
42 changes: 24 additions & 18 deletions src/components/sidebar-elements/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,37 +61,46 @@ const SidebarElements = ({
locale,
} = useContext(LibraryContext)
const router = useRouter()
const navigationLocale = router.locale || locale

const isElementOpen = (slug: string, defaultOpen?: boolean) =>
forceOpen ||
(sidebarElementStatus.has(slug)
? sidebarElementStatus.get(slug)
: !!defaultOpen)

const getPath = (prefix: string, pathSuffix: string, slug: string) => {
const href =
prefix === 'docs/api-reference'
? `/${prefix}/${slug}/${pathSuffix}`
: `/${prefix}/${slug}`
return href.replaceAll('//', '/')
}

const getHref = (prefix: string, pathSuffix: string, slug: string) => {
const path = getPath(prefix, pathSuffix, slug)
const localePrefix =
navigationLocale && navigationLocale !== 'en'
? `/${navigationLocale}`
: ''
return `${localePrefix}${path}`.replaceAll('//', '/')
}

const handleClick = (
e: { preventDefault: () => void },
pathSuffix: string,
slug: string
) => {
e.preventDefault()
const hasEndpointQuery = router.query.endpoint
const href = getHref(slugPrefix || '', pathSuffix, slug)
router.push(href, href, { locale }).then(() => {
const path = getPath(slugPrefix || '', pathSuffix, slug)
// Do not put the locale in both the path and the locale option. That makes
// Next/Netlify treat shared slugs (e.g. amazon in en/es/pt) as English.
router.push(path, undefined, { locale: navigationLocale }).then(() => {
if (hasEndpointQuery) router.reload()
})
}

const getHref = (slugPrefix: string, pathSuffix: string, slug: string) => {
const validLocales = ['pt', 'es']
const localePrefix =
locale && validLocales.includes(locale) ? `/${locale}` : ''
const href =
slugPrefix === 'docs/api-reference'
? `/${slugPrefix}/${slug}/${pathSuffix}`
: `${localePrefix}/${slugPrefix}/${slug}`
return href.replaceAll('//', '/')
}

const ElementRoot = ({
slug,
name,
Expand Down Expand Up @@ -141,10 +150,7 @@ const SidebarElements = ({
: styles.arrowIcon
}
icon={() => (
<IconCaret
direction={isOpen ? 'down' : 'right'}
size={16}
/>
<IconCaret direction={isOpen ? 'down' : 'right'} size={16} />
)}
onClick={() => toggleSidebarElementStatus(localizedSlug, isOpen)}
/>
Expand All @@ -169,7 +175,7 @@ const SidebarElements = ({
}}
href={getHref(slugPrefix || '', pathSuffix, localizedSlug)}
target={isEditorPreview === true ? '_blank' : '_self'}
locale={locale}
locale={navigationLocale}
>
{method && (
<MethodCategory
Expand Down
Loading