computer-scienceangular-roadmapbackend-roadmapblockchain-roadmapdba-roadmapdeveloper-roadmapdevops-roadmapfrontend-roadmapgo-roadmaphactoberfestjava-roadmapjavascript-roadmapnodejs-roadmappython-roadmapqa-roadmapreact-roadmaproadmapstudy-planvue-roadmapweb3-roadmap
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
372 lines
13 KiB
372 lines
13 KiB
import { useEffect, useMemo, useRef, useState } from 'react'; |
|
|
|
import { useKeydown } from '../../hooks/use-keydown'; |
|
import { useLoadTopic } from '../../hooks/use-load-topic'; |
|
import { useOutsideClick } from '../../hooks/use-outside-click'; |
|
import { useToggleTopic } from '../../hooks/use-toggle-topic'; |
|
import { httpGet } from '../../lib/http'; |
|
import { isLoggedIn } from '../../lib/jwt'; |
|
import type { ResourceType } from '../../lib/resource-progress'; |
|
import { |
|
isTopicDone, |
|
refreshProgressCounters, |
|
renderTopicProgress, |
|
updateResourceProgress as updateResourceProgressApi, |
|
} from '../../lib/resource-progress'; |
|
import { pageProgressMessage, sponsorHidden } from '../../stores/page'; |
|
import { TopicProgressButton } from './TopicProgressButton'; |
|
import { showLoginPopup } from '../../lib/popup'; |
|
import { useToast } from '../../hooks/use-toast'; |
|
import type { |
|
AllowedLinkTypes, |
|
RoadmapContentDocument, |
|
} from '../CustomRoadmap/CustomRoadmap'; |
|
import { markdownToHtml, sanitizeMarkdown } from '../../lib/markdown'; |
|
import { cn } from '../../lib/classname'; |
|
import { Ban, FileText, X } from 'lucide-react'; |
|
import { getUrlParams } from '../../lib/browser'; |
|
import { Spinner } from '../ReactIcons/Spinner'; |
|
import { GitHubIcon } from '../ReactIcons/GitHubIcon.tsx'; |
|
import { GoogleIcon } from '../ReactIcons/GoogleIcon.tsx'; |
|
import { YouTubeIcon } from '../ReactIcons/YouTubeIcon.tsx'; |
|
|
|
type TopicDetailProps = { |
|
resourceTitle?: string; |
|
resourceType?: ResourceType; |
|
|
|
isEmbed?: boolean; |
|
canSubmitContribution: boolean; |
|
}; |
|
|
|
const linkTypes: Record<AllowedLinkTypes, string> = { |
|
article: 'bg-yellow-200', |
|
course: 'bg-green-200', |
|
opensource: 'bg-blue-200', |
|
podcast: 'bg-purple-200', |
|
video: 'bg-pink-200', |
|
website: 'bg-red-200', |
|
}; |
|
|
|
export function TopicDetail(props: TopicDetailProps) { |
|
const { canSubmitContribution, isEmbed = false, resourceTitle } = props; |
|
|
|
const [hasEnoughLinks, setHasEnoughLinks] = useState(false); |
|
const [contributionUrl, setContributionUrl] = useState(''); |
|
const [isActive, setIsActive] = useState(false); |
|
const [isLoading, setIsLoading] = useState(false); |
|
const [isContributing, setIsContributing] = useState(false); |
|
const [error, setError] = useState(''); |
|
const [topicHtml, setTopicHtml] = useState(''); |
|
const [topicTitle, setTopicTitle] = useState(''); |
|
const [topicHtmlTitle, setTopicHtmlTitle] = useState(''); |
|
const [links, setLinks] = useState<RoadmapContentDocument['links']>([]); |
|
const toast = useToast(); |
|
|
|
const { secret } = getUrlParams() as { secret: string }; |
|
const isGuest = useMemo(() => !isLoggedIn(), []); |
|
const topicRef = useRef<HTMLDivElement>(null); |
|
|
|
// Details of the currently loaded topic |
|
const [topicId, setTopicId] = useState(''); |
|
const [resourceId, setResourceId] = useState(''); |
|
const [resourceType, setResourceType] = useState<ResourceType>('roadmap'); |
|
|
|
// Close the topic detail when user clicks outside the topic detail |
|
useOutsideClick(topicRef, () => { |
|
setIsActive(false); |
|
}); |
|
|
|
useKeydown('Escape', () => { |
|
setIsActive(false); |
|
}); |
|
|
|
// Toggle topic is available even if the component UI is not active |
|
// This is used on the best practice screen where we have the checkboxes |
|
// to mark the topic as done/undone. |
|
useToggleTopic(({ topicId, resourceType, resourceId }) => { |
|
if (isGuest) { |
|
showLoginPopup(); |
|
return; |
|
} |
|
|
|
pageProgressMessage.set('Updating'); |
|
|
|
// Toggle the topic status |
|
isTopicDone({ topicId, resourceId, resourceType }) |
|
.then((oldIsDone) => |
|
updateResourceProgressApi( |
|
{ |
|
topicId, |
|
resourceId, |
|
resourceType, |
|
}, |
|
oldIsDone ? 'pending' : 'done', |
|
), |
|
) |
|
.then(({ done = [] }) => { |
|
renderTopicProgress( |
|
topicId, |
|
done.includes(topicId) ? 'done' : 'pending', |
|
); |
|
refreshProgressCounters(); |
|
}) |
|
.catch((err) => { |
|
toast.error(err.message); |
|
console.error(err); |
|
}) |
|
.finally(() => { |
|
pageProgressMessage.set(''); |
|
}); |
|
}); |
|
|
|
// Load the topic detail when the topic detail is active |
|
useLoadTopic(({ topicId, resourceType, resourceId, isCustomResource }) => { |
|
setError(''); |
|
setIsLoading(true); |
|
setIsActive(true); |
|
sponsorHidden.set(true); |
|
|
|
setTopicId(topicId); |
|
setResourceType(resourceType); |
|
setResourceId(resourceId); |
|
|
|
const topicPartial = topicId.replaceAll(':', '/'); |
|
let topicUrl = |
|
resourceType === 'roadmap' |
|
? `/${resourceId}/${topicPartial}` |
|
: `/best-practices/${resourceId}/${topicPartial}`; |
|
|
|
if (isCustomResource) { |
|
topicUrl = `${ |
|
import.meta.env.PUBLIC_API_URL |
|
}/v1-get-node-content/${resourceId}/${topicId}${ |
|
secret ? `?secret=${secret}` : '' |
|
}`; |
|
} |
|
|
|
httpGet<string | RoadmapContentDocument>( |
|
topicUrl, |
|
{}, |
|
{ |
|
...(!isCustomResource && { |
|
headers: { |
|
Accept: 'text/html', |
|
}, |
|
}), |
|
}, |
|
) |
|
.then(({ response }) => { |
|
if (!response) { |
|
setError('Topic not found.'); |
|
setIsLoading(false); |
|
return; |
|
} |
|
let topicHtml = ''; |
|
if (!isCustomResource) { |
|
topicHtml = response as string; |
|
const topicDom = new DOMParser().parseFromString( |
|
topicHtml, |
|
'text/html', |
|
); |
|
|
|
const links = topicDom.querySelectorAll('a'); |
|
const urlElem: HTMLElement = |
|
topicDom.querySelector('[data-github-url]')!; |
|
const contributionUrl = urlElem?.dataset?.githubUrl || ''; |
|
|
|
const titleElem: HTMLElement = topicDom.querySelector('h1')!; |
|
|
|
setContributionUrl(contributionUrl); |
|
setHasEnoughLinks(links.length >= 3); |
|
setTopicHtmlTitle(titleElem?.textContent || ''); |
|
} else { |
|
setLinks((response as RoadmapContentDocument)?.links || []); |
|
setTopicTitle((response as RoadmapContentDocument)?.title || ''); |
|
|
|
const sanitizedMarkdown = sanitizeMarkdown( |
|
(response as RoadmapContentDocument).description || '', |
|
); |
|
topicHtml = markdownToHtml(sanitizedMarkdown, false); |
|
} |
|
|
|
setIsLoading(false); |
|
setTopicHtml(topicHtml); |
|
}) |
|
.catch((err) => { |
|
setError('Something went wrong. Please try again later.'); |
|
setIsLoading(false); |
|
}); |
|
}); |
|
|
|
useEffect(() => { |
|
if (isActive) topicRef?.current?.focus(); |
|
}, [isActive]); |
|
|
|
if (!isActive) { |
|
return null; |
|
} |
|
|
|
const hasContent = topicHtml?.length > 0 || links?.length > 0 || topicTitle; |
|
const resourceTitleForSearch = resourceTitle?.toLowerCase()?.replace(/\s+?roadmap/ig, ''); |
|
const googleSearchUrl = `https://www.google.com/search?q=${topicHtmlTitle?.toLowerCase()} guide for ${resourceTitleForSearch}`; |
|
const youtubeSearchUrl = `https://www.youtube.com/results?search_query=${topicHtmlTitle?.toLowerCase()} for ${resourceTitleForSearch}`; |
|
|
|
return ( |
|
<div className={'relative z-50'}> |
|
<div |
|
ref={topicRef} |
|
tabIndex={0} |
|
className="fixed right-0 top-0 z-40 h-screen w-full overflow-y-auto bg-white p-4 focus:outline-0 sm:max-w-[600px] sm:p-6" |
|
> |
|
{isLoading && ( |
|
<div className="flex w-full justify-center"> |
|
<Spinner |
|
outerFill="#d1d5db" |
|
className="h-6 w-6 sm:h-12 sm:w-12" |
|
innerFill="#2563eb" |
|
/> |
|
</div> |
|
)} |
|
|
|
{!isContributing && !isLoading && !error && ( |
|
<> |
|
{/* Actions for the topic */} |
|
<div className="mb-2"> |
|
{!isEmbed && ( |
|
<TopicProgressButton |
|
topicId={topicId} |
|
resourceId={resourceId} |
|
resourceType={resourceType} |
|
onClose={() => { |
|
setIsActive(false); |
|
}} |
|
/> |
|
)} |
|
|
|
<button |
|
type="button" |
|
id="close-topic" |
|
className="absolute right-2.5 top-2.5 inline-flex items-center rounded-lg bg-transparent p-1.5 text-sm text-gray-400 hover:bg-gray-200 hover:text-gray-900" |
|
onClick={() => { |
|
setIsActive(false); |
|
}} |
|
> |
|
<X className="h-5 w-5" /> |
|
</button> |
|
</div> |
|
|
|
{/* Topic Content */} |
|
{hasContent ? ( |
|
<div className="prose prose-quoteless prose-h1:mb-2.5 prose-h1:mt-7 prose-h2:mb-3 prose-h2:mt-0 prose-h3:mb-[5px] prose-h3:mt-[10px] prose-p:mb-2 prose-p:mt-0 prose-blockquote:font-normal prose-blockquote:not-italic prose-blockquote:text-gray-700 prose-li:m-0 prose-li:mb-0.5"> |
|
{topicTitle && <h1>{topicTitle}</h1>} |
|
<div |
|
id="topic-content" |
|
dangerouslySetInnerHTML={{ __html: topicHtml }} |
|
/> |
|
</div> |
|
) : ( |
|
<div className="flex h-[calc(100%-38px)] flex-col items-center justify-center"> |
|
<FileText className="h-16 w-16 text-gray-300" /> |
|
<p className="mt-2 text-lg font-medium text-gray-500"> |
|
Empty Content |
|
</p> |
|
</div> |
|
)} |
|
|
|
{links.length > 0 && ( |
|
<ul className="mt-6 space-y-1"> |
|
{links.map((link) => { |
|
return ( |
|
<li> |
|
<a |
|
href={link.url} |
|
target="_blank" |
|
className="font-medium underline" |
|
> |
|
<span |
|
className={cn( |
|
'mr-2 inline-block rounded px-1.5 py-1 text-xs uppercase no-underline', |
|
linkTypes[link.type], |
|
)} |
|
> |
|
{link.type.charAt(0).toUpperCase() + |
|
link.type.slice(1)} |
|
</span> |
|
{link.title} |
|
</a> |
|
</li> |
|
); |
|
})} |
|
</ul> |
|
)} |
|
|
|
{/* Contribution */} |
|
{canSubmitContribution && !hasEnoughLinks && contributionUrl && ( |
|
<div className="mt-8 mb-12 flex-1 border-t text-gray-400 text-sm"> |
|
<div className='mt-3 mb-4'> |
|
<p className=''> |
|
Can't find what you're looking for? Try these pre-filled search queries: |
|
</p> |
|
<div className="mt-3 flex gap-2 text-gray-700"> |
|
<a |
|
href={googleSearchUrl} |
|
target="_blank" |
|
className="text-xs flex items-center gap-2 rounded-md border border-gray-300 px-3 py-1.5 pl-2 hover:border-gray-700 hover:bg-gray-100" |
|
> |
|
<GoogleIcon className={'h-4 w-4'}/> |
|
Google |
|
</a> |
|
<a |
|
href={youtubeSearchUrl} |
|
target="_blank" |
|
className="text-xs flex items-center gap-2 rounded-md border border-gray-300 px-3 py-1.5 pl-2 hover:border-gray-700 hover:bg-gray-100" |
|
> |
|
<YouTubeIcon className={'h-4 w-4 text-red-500'}/> |
|
YouTube |
|
</a> |
|
</div> |
|
</div> |
|
|
|
<p className="mb-2 mt-2 leading-relaxed"> |
|
Help us improve this introduction and submit a link to a good |
|
article, podcast, video, or any other self-vetted resource that helped you |
|
understand this topic better. |
|
</p> |
|
<a |
|
href={contributionUrl} |
|
target={'_blank'} |
|
className="flex w-full items-center justify-center rounded-md bg-gray-800 p-2 text-sm text-white transition-colors hover:bg-black hover:text-white disabled:bg-green-200 disabled:text-black" |
|
> |
|
<GitHubIcon className="mr-2 inline-block h-4 w-4 text-white"/> |
|
Edit this Content |
|
</a> |
|
</div> |
|
)} |
|
</> |
|
)} |
|
|
|
{/* Error */} |
|
{!isContributing && !isLoading && error && ( |
|
<> |
|
<button |
|
type="button" |
|
id="close-topic" |
|
className="absolute right-2.5 top-2.5 inline-flex items-center rounded-lg bg-transparent p-1.5 text-sm text-gray-400 hover:bg-gray-200 hover:text-gray-900" |
|
onClick={() => { |
|
setIsActive(false); |
|
setIsContributing(false); |
|
}} |
|
> |
|
<X className="h-5 w-5"/> |
|
</button> |
|
<div className="flex h-full flex-col items-center justify-center"> |
|
<Ban className="h-16 w-16 text-red-500"/> |
|
<p className="mt-2 text-lg font-medium text-red-500">{error}</p> |
|
</div> |
|
</> |
|
)} |
|
</div> |
|
<div className="fixed inset-0 z-30 bg-gray-900 bg-opacity-50 dark:bg-opacity-80"></div> |
|
</div> |
|
); |
|
}
|
|
|