pull/18314/merge
GuanMu 7 months ago committed by GitHub
commit 0dab08245c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -1,6 +1,6 @@
'use client'
import { useEffect, useMemo, useState } from 'react'
import { useEffect, useMemo, useRef, useState } from 'react'
import { useContext } from 'use-context-selector'
import { useTranslation } from 'react-i18next'
import { RiListUnordered } from '@remixicon/react'
@ -12,57 +12,145 @@ import { LanguagesSupported } from '@/i18n/language'
import useTheme from '@/hooks/use-theme'
import { Theme } from '@/types/app'
import cn from '@/utils/classnames'
import { throttle } from 'lodash-es'
type TocItem = {
href: string;
text: string;
index: number;
}
type DocProps = {
apiBaseUrl: string
}
const Doc = ({ apiBaseUrl }: DocProps) => {
const { locale } = useContext(I18n)
const { t } = useTranslation()
const [toc, setToc] = useState<Array<{ href: string; text: string }>>([])
const [isTocExpanded, setIsTocExpanded] = useState(false)
const { theme } = useTheme()
const useToc = (apiBaseUrl: string, locale: string) => {
const [toc, setToc] = useState<TocItem[]>([])
const [headingElements, setHeadingElements] = useState<HTMLElement[]>([])
// Set initial TOC expanded state based on screen width
useEffect(() => {
const mediaQuery = window.matchMedia('(min-width: 1280px)')
setIsTocExpanded(mediaQuery.matches)
}, [])
// Extract TOC from article content
useEffect(() => {
const extractTOC = () => {
const article = document.querySelector('article')
if (article) {
const headings = article.querySelectorAll('h2')
const tocItems = Array.from(headings).map((heading) => {
const anchor = heading.querySelector('a')
if (anchor) {
return {
href: anchor.getAttribute('href') || '',
text: anchor.textContent || '',
const headingElementsArray = Array.from(headings) as HTMLElement[]
setHeadingElements(headingElementsArray)
const tocItems: TocItem[] = headingElementsArray.map((heading, index) => ({
href: `#section-${index}`,
text: (heading.textContent || '').trim(),
index,
}))
setToc(tocItems)
}
}
return null
}).filter((item): item is { href: string; text: string } => item !== null)
setToc(tocItems)
const timeoutId = setTimeout(extractTOC, 0)
return () => clearTimeout(timeoutId)
}, [locale, apiBaseUrl])
return { toc, headingElements }
}
const useScrollPosition = (headingElements: HTMLElement[]) => {
const [activeIndex, setActiveIndex] = useState<number | null>(null)
const activeIndexRef = useRef<number | null>(null)
useEffect(() => {
const scrollContainer = document.querySelector('.scroll-container')
if (!scrollContainer || headingElements.length === 0) return
const handleScroll = () => {
const scrollContainerTop = scrollContainer.scrollTop
const scrollContainerHeight = scrollContainer.clientHeight
const scrollContainerBottom = scrollContainerTop + scrollContainerHeight
const totalScrollHeight = scrollContainer.scrollHeight
const offset = 110
let currentActiveIndex: number | null = null
for (let i = headingElements.length - 1; i >= 0; i--) {
const heading = headingElements[i]
if (heading.offsetTop <= scrollContainerTop + offset) {
currentActiveIndex = i
break
}
}
setTimeout(extractTOC, 0)
}, [locale])
if (scrollContainerBottom >= totalScrollHeight - 20) {
currentActiveIndex = headingElements.length - 1
}
else if (currentActiveIndex === null && headingElements.length > 0) {
const firstHeadingTop = headingElements[0].offsetTop
if (firstHeadingTop >= scrollContainerTop && firstHeadingTop < scrollContainerBottom)
currentActiveIndex = 0
}
// Handle TOC item click
const handleTocClick = (e: React.MouseEvent<HTMLAnchorElement>, item: { href: string; text: string }) => {
if (currentActiveIndex !== activeIndexRef.current) {
activeIndexRef.current = currentActiveIndex
setActiveIndex(currentActiveIndex)
}
}
const throttledScrollHandler = throttle(handleScroll, 100)
scrollContainer.addEventListener('scroll', throttledScrollHandler)
handleScroll()
return () => {
scrollContainer.removeEventListener('scroll', throttledScrollHandler)
throttledScrollHandler.cancel()
}
}, [headingElements])
return activeIndex
}
const useResponsiveToc = () => {
const [isTocExpanded, setIsTocExpanded] = useState(false)
const userToggled = useRef(false)
useEffect(() => {
const mediaQuery = window.matchMedia('(min-width: 1280px)')
if (!userToggled.current)
setIsTocExpanded(mediaQuery.matches)
const handleChange = (e: MediaQueryListEvent) => {
if (!userToggled.current)
setIsTocExpanded(e.matches)
}
mediaQuery.addEventListener('change', handleChange)
return () => mediaQuery.removeEventListener('change', handleChange)
}, [])
const setTocExpandedWithTracking = (expanded: boolean) => {
userToggled.current = true
setIsTocExpanded(expanded)
}
return { isTocExpanded, setIsTocExpanded: setTocExpandedWithTracking }
}
const Doc = ({ apiBaseUrl }: DocProps) => {
const { locale } = useContext(I18n)
const { t } = useTranslation()
const { toc, headingElements } = useToc(apiBaseUrl, locale)
const { isTocExpanded, setIsTocExpanded } = useResponsiveToc()
const activeIndex = useScrollPosition(headingElements)
const { theme } = useTheme()
const handleTocClick = (e: React.MouseEvent<HTMLAnchorElement>, item: TocItem) => {
e.preventDefault()
const targetId = item.href.replace('#', '')
const element = document.getElementById(targetId)
if (element) {
const targetElement = headingElements[item.index]
if (targetElement) {
const scrollContainer = document.querySelector('.scroll-container')
if (scrollContainer) {
const headerOffset = -40
const elementTop = element.offsetTop - headerOffset
const headerOffset = 110
const elementTop = targetElement.offsetTop - headerOffset
scrollContainer.scrollTo({
top: elementTop,
behavior: 'smooth',
@ -98,11 +186,16 @@ const Doc = ({ apiBaseUrl }: DocProps) => {
</button>
</div>
<ul className="space-y-2">
{toc.map((item, index) => (
<li key={index}>
{toc.map(item => (
<li key={item.index}>
<a
href={item.href}
className="text-text-secondary transition-colors duration-200 hover:text-text-primary hover:underline"
className={cn(
'block rounded px-2 py-1 text-sm transition-colors duration-200',
item.index === activeIndex
? 'bg-primary-50 font-semibold text-primary-600'
: 'text-text-secondary hover:bg-gray-100 hover:text-text-primary',
)}
onClick={e => handleTocClick(e, item)}
>
{item.text}

@ -1,5 +1,5 @@
'use client'
import { useEffect, useState } from 'react'
import { useCallback, useEffect, useMemo, useRef, useState } from 'react'
import { useContext } from 'use-context-selector'
import { useTranslation } from 'react-i18next'
import { RiListUnordered } from '@remixicon/react'
@ -20,68 +20,206 @@ import { LanguagesSupported } from '@/i18n/language'
import useTheme from '@/hooks/use-theme'
import { Theme } from '@/types/app'
import cn from '@/utils/classnames'
import { throttle } from 'lodash-es'
type TocItem = {
href: string;
text: string;
index: number;
}
type IDocProps = {
appDetail: any
}
const Doc = ({ appDetail }: IDocProps) => {
const { locale } = useContext(I18n)
const { t } = useTranslation()
const [toc, setToc] = useState<Array<{ href: string; text: string }>>([])
const [isTocExpanded, setIsTocExpanded] = useState(false)
const { theme } = useTheme()
const variables = appDetail?.model_config?.configs?.prompt_variables || []
const inputs = variables.reduce((res: any, variable: any) => {
res[variable.key] = variable.name || ''
return res
}, {})
useEffect(() => {
const mediaQuery = window.matchMedia('(min-width: 1280px)')
setIsTocExpanded(mediaQuery.matches)
}, [])
const useToc = (appDetail: any, locale: string) => {
const [toc, setToc] = useState<TocItem[]>([])
const [headingElements, setHeadingElements] = useState<HTMLElement[]>([])
useEffect(() => {
const extractTOC = () => {
const article = document.querySelector('article')
if (article) {
const headings = article.querySelectorAll('h2')
const tocItems = Array.from(headings).map((heading) => {
const anchor = heading.querySelector('a')
if (anchor) {
return {
href: anchor.getAttribute('href') || '',
text: anchor.textContent || '',
}
}
return null
}).filter((item): item is { href: string; text: string } => item !== null)
const headingElementsArray = Array.from(headings) as HTMLElement[]
setHeadingElements(headingElementsArray)
const tocItems: TocItem[] = headingElementsArray.map((heading, index) => ({
href: `#section-${index}`,
text: (heading.textContent || `章节 ${index + 1}`).trim(),
index,
}))
setToc(tocItems)
}
}
// Run after component has rendered
setTimeout(extractTOC, 0)
const timeoutId = setTimeout(extractTOC, 0)
return () => clearTimeout(timeoutId)
}, [appDetail, locale])
const handleTocClick = (e: React.MouseEvent<HTMLAnchorElement>, item: { href: string; text: string }) => {
return { toc, headingElements }
}
const useScrollPosition = (headingElements: HTMLElement[]) => {
const [activeIndex, setActiveIndex] = useState<number | null>(null)
const activeIndexRef = useRef<number | null>(null)
useEffect(() => {
const scrollContainer = document.querySelector('.overflow-auto')
if (!scrollContainer || headingElements.length === 0) return
const handleScroll = () => {
const scrollContainerTop = scrollContainer.scrollTop
const scrollContainerHeight = scrollContainer.clientHeight
const scrollContainerBottom = scrollContainerTop + scrollContainerHeight
const totalScrollHeight = scrollContainer.scrollHeight
const offset = 80
let currentActiveIndex: number | null = null
for (let i = headingElements.length - 1; i >= 0; i--) {
const heading = headingElements[i]
const headingTop = heading.offsetTop
const headingBottom = headingTop + heading.offsetHeight
if (headingTop <= scrollContainerTop + offset) {
currentActiveIndex = i
break
}
}
if (scrollContainerBottom >= totalScrollHeight - 20) {
currentActiveIndex = headingElements.length - 1
}
else if (currentActiveIndex === null && headingElements.length > 0) {
const firstHeadingTop = headingElements[0].offsetTop
if (firstHeadingTop >= scrollContainerTop && firstHeadingTop < scrollContainerBottom)
currentActiveIndex = 0
}
if (currentActiveIndex !== activeIndexRef.current) {
activeIndexRef.current = currentActiveIndex
setActiveIndex(currentActiveIndex)
}
}
const throttledScrollHandler = throttle(handleScroll, 100)
scrollContainer.addEventListener('scroll', throttledScrollHandler)
handleScroll()
return () => {
scrollContainer.removeEventListener('scroll', throttledScrollHandler)
throttledScrollHandler.cancel()
}
}, [headingElements])
return activeIndex
}
const useResponsiveToc = () => {
const [isTocExpanded, setIsTocExpanded] = useState(false)
const userToggled = useRef(false)
useEffect(() => {
const mediaQuery = window.matchMedia('(min-width: 1280px)')
if (!userToggled.current)
setIsTocExpanded(mediaQuery.matches)
const handleChange = (e: MediaQueryListEvent) => {
if (!userToggled.current)
setIsTocExpanded(e.matches)
}
mediaQuery.addEventListener('change', handleChange)
return () => mediaQuery.removeEventListener('change', handleChange)
}, [])
const setTocExpandedWithTracking = (expanded: boolean) => {
userToggled.current = true
setIsTocExpanded(expanded)
}
return { isTocExpanded, setIsTocExpanded: setTocExpandedWithTracking }
}
const Doc = ({ appDetail }: IDocProps) => {
const { locale } = useContext(I18n)
const { t } = useTranslation()
const { toc, headingElements } = useToc(appDetail, locale)
const { isTocExpanded, setIsTocExpanded } = useResponsiveToc()
const activeIndex = useScrollPosition(headingElements)
const { theme } = useTheme()
const variables = appDetail?.model_config?.configs?.prompt_variables || []
const inputs = variables.reduce((res: any, variable: any) => {
res[variable.key] = variable.name || ''
return res
}, {})
const handleTocClick = useCallback((e: React.MouseEvent<HTMLAnchorElement>, item: TocItem) => {
e.preventDefault()
const targetId = item.href.replace('#', '')
const element = document.getElementById(targetId)
if (element) {
const targetElement = headingElements[item.index]
if (targetElement) {
const scrollContainer = document.querySelector('.overflow-auto')
if (scrollContainer) {
const headerOffset = 80
const elementTop = element.offsetTop - headerOffset
const elementTop = targetElement.offsetTop - headerOffset
scrollContainer.scrollTo({
top: elementTop,
behavior: 'smooth',
})
}
}
}, [headingElements])
const Template = useMemo(() => {
if (appDetail?.mode === 'chat' || appDetail?.mode === 'agent-chat') {
switch (locale) {
case LanguagesSupported[1]:
return <TemplateChatZh appDetail={appDetail} variables={variables} inputs={inputs} />
case LanguagesSupported[7]:
return <TemplateChatJa appDetail={appDetail} variables={variables} inputs={inputs} />
default:
return <TemplateChatEn appDetail={appDetail} variables={variables} inputs={inputs} />
}
}
if (appDetail?.mode === 'advanced-chat') {
switch (locale) {
case LanguagesSupported[1]:
return <TemplateAdvancedChatZh appDetail={appDetail} variables={variables} inputs={inputs} />
case LanguagesSupported[7]:
return <TemplateAdvancedChatJa appDetail={appDetail} variables={variables} inputs={inputs} />
default:
return <TemplateAdvancedChatEn appDetail={appDetail} variables={variables} inputs={inputs} />
}
}
if (appDetail?.mode === 'workflow') {
switch (locale) {
case LanguagesSupported[1]:
return <TemplateWorkflowZh appDetail={appDetail} variables={variables} inputs={inputs} />
case LanguagesSupported[7]:
return <TemplateWorkflowJa appDetail={appDetail} variables={variables} inputs={inputs} />
default:
return <TemplateWorkflowEn appDetail={appDetail} variables={variables} inputs={inputs} />
}
}
if (appDetail?.mode === 'completion') {
switch (locale) {
case LanguagesSupported[1]:
return <TemplateZh appDetail={appDetail} variables={variables} inputs={inputs} />
case LanguagesSupported[7]:
return <TemplateJa appDetail={appDetail} variables={variables} inputs={inputs} />
default:
return <TemplateEn appDetail={appDetail} variables={variables} inputs={inputs} />
}
}
return null
}, [appDetail, locale, variables, inputs])
return (
<div className="flex">
<div className={`fixed right-8 top-32 z-10 transition-all ${isTocExpanded ? 'w-64' : 'w-10'}`}>
@ -98,11 +236,16 @@ const Doc = ({ appDetail }: IDocProps) => {
</button>
</div>
<ul className="space-y-2">
{toc.map((item, index) => (
<li key={index}>
{toc.map(item => (
<li key={item.index}>
<a
href={item.href}
className="text-text-secondary transition-colors duration-200 hover:text-text-primary hover:underline"
className={cn(
'block rounded px-2 py-1 text-sm transition-colors duration-200',
item.index === activeIndex
? 'bg-primary-50 font-semibold text-primary-600'
: 'text-text-secondary hover:bg-gray-100 hover:text-text-primary',
)}
onClick={e => handleTocClick(e, item)}
>
{item.text}

Loading…
Cancel
Save