refactor: use options object in useDocLink calls

This commit is contained in:
yyh
2026-02-13 10:37:38 +08:00
parent e45d4d8d90
commit c0bba03b13
4 changed files with 18 additions and 10 deletions

View File

@@ -313,7 +313,7 @@ const CreateFromDSLModal = ({ show, onSuccess, onClose, activeTab = CreateFromDS
<div className="flex items-center justify-between px-6 pb-6 pt-5">
<a
className="flex items-center gap-1 text-text-accent system-xs-regular"
href={docLink('/use-dify/workspace/app-management#app-export-and-import', undefined, appManagementAnchorMap)}
href={docLink('/use-dify/workspace/app-management#app-export-and-import', { anchorMap: appManagementAnchorMap })}
target="_blank"
rel="noopener noreferrer"
>

View File

@@ -33,7 +33,7 @@ const ArtifactsEmpty = ({ description }: { description: string }) => {
<div className="text-text-tertiary system-xs-regular">{description}</div>
<a
className="cursor-pointer text-text-accent system-xs-regular"
href={docLink('/use-dify/build/file-system#artifacts' as DocPathWithoutLang, undefined, fileSystemArtifactsAnchorMap)}
href={docLink('/use-dify/build/file-system#artifacts' as DocPathWithoutLang, { anchorMap: fileSystemArtifactsAnchorMap })}
target="_blank"
rel="noopener noreferrer"
>

View File

@@ -103,7 +103,7 @@ describe('useDocLink', () => {
}
const { result } = renderHook(() => useDocLink())
const url = result.current('/use-dify/getting-started/quick-start' as DocPathWithoutLang, pathMap)
const url = result.current('/use-dify/getting-started/quick-start' as DocPathWithoutLang, { pathMap })
expect(url).toBe(`${defaultDocBaseUrl}/zh/use-dify/getting-started/introduction`)
})
@@ -119,7 +119,7 @@ describe('useDocLink', () => {
}
const { result } = renderHook(() => useDocLink())
const url = result.current('/use-dify/getting-started/quick-start' as DocPathWithoutLang, pathMap)
const url = result.current('/use-dify/getting-started/quick-start' as DocPathWithoutLang, { pathMap })
expect(url).toBe(`${defaultDocBaseUrl}/ja/use-dify/getting-started/quick-start`)
})
@@ -266,7 +266,7 @@ describe('useDocLink', () => {
}
const { result } = renderHook(() => useDocLink())
const url = result.current('/use-dify/workspace/app-management#app-export-and-import', undefined, anchorMap)
const url = result.current('/use-dify/workspace/app-management#app-export-and-import', { anchorMap })
expect(url).toBe(`${defaultDocBaseUrl}/zh/use-dify/workspace/app-management#${encodeURIComponent('应用导出和导入')}`)
})

View File

@@ -1,7 +1,7 @@
import type { Locale } from '@/i18n-config/language'
import type { DocPathWithoutLang } from '@/types/doc-paths'
import { useTranslation } from '#i18n'
import { useCallback } from 'react'
import { useCallback, useMemo } from 'react'
import { getDocLanguage, getLanguage, getPricingPageLanguage } from '@/i18n-config/language'
import { apiReferencePathTranslations } from '@/types/doc-paths'
@@ -24,6 +24,11 @@ export const useGetPricingPageLanguage = () => {
export const defaultDocBaseUrl = 'https://docs.bash-is-all-you-need.dify.dev'
export type DocPathMap = Partial<Record<Locale, DocPathWithoutLang>>
export type DocAnchorMap = Partial<Record<Locale, string>>
export type DocLinkOptions = {
pathMap?: DocPathMap
anchorMap?: DocAnchorMap
}
export type BuildDocLink = (path?: DocPathWithoutLang, options?: DocLinkOptions) => string
const splitPathWithHash = (path: string) => {
const [pathname, ...hashParts] = path.split('#')
@@ -45,14 +50,17 @@ const normalizeAnchor = (anchor: string) => {
return encodeURIComponent(normalizedAnchor)
}
export const useDocLink = (baseUrl?: string): ((path?: DocPathWithoutLang, pathMap?: DocPathMap, anchorMap?: DocAnchorMap) => string) => {
let baseDocUrl = baseUrl || defaultDocBaseUrl
baseDocUrl = (baseDocUrl.endsWith('/')) ? baseDocUrl.slice(0, -1) : baseDocUrl
export const useDocLink = (baseUrl?: string): BuildDocLink => {
const baseDocUrl = useMemo(() => {
const resolvedBaseUrl = baseUrl || defaultDocBaseUrl
return resolvedBaseUrl.endsWith('/') ? resolvedBaseUrl.slice(0, -1) : resolvedBaseUrl
}, [baseUrl])
const locale = useLocale()
return useCallback(
(path?: DocPathWithoutLang, pathMap?: DocPathMap, anchorMap?: DocAnchorMap): string => {
(path?: DocPathWithoutLang, options?: DocLinkOptions): string => {
const docLanguage = getDocLanguage(locale)
const pathUrl = path || ''
const { pathMap, anchorMap } = options || {}
const targetPath = (pathMap) ? pathMap[locale] || pathUrl : pathUrl
const { pathname: pathWithoutHash, hash: pathAnchor } = splitPathWithHash(targetPath)
let targetPathWithoutHash = pathWithoutHash