Skip to content

feat: Improve the blog sidebar by adding a highlighter to active section #1706

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

Closed
chauhan-varun wants to merge 1 commit into from
Closed

feat: Improve the blog sidebar by adding a highlighter to active section #1706

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
182 changes: 117 additions & 65 deletions components/StyledMarkdown.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,17 +564,53 @@
markdown: string;
depth?: number;
}) {
// Add state to track the active section
const [activeSection, setActiveSection] = useState<string | null>(null);

// Set up intersection observer to track which section is in view
useEffect(() => {
const headings = document.querySelectorAll('h1, h2, h3, h4');

const observer = new IntersectionObserver(
(entries) => {
entries.forEach((entry) => {
if (entry.isIntersecting) {
setActiveSection(entry.target.id);
}
});
},
{
rootMargin: '-100px 0px -80% 0px',
threshold: 0

Check failure on line 584 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `,`

Check failure on line 584 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `,`
}

Check failure on line 585 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `,`

Check failure on line 585 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `,`
);

headings.forEach((heading) => {
observer.observe(heading);
});

return () => {
headings.forEach((heading) => {
observer.unobserve(heading);
});
};
}, []);

return (
<Markdown
options={{
overrides: {
h1: {
component: ({ children }) => {
const slug = slugifyMarkdownHeadline(children);
const isActive = activeSection === slug;
return (
<a
href={`#${slug}`}
className='flex cursor-pointer mb-3 max-sm:text-sm text-slate-600 dark:text-slate-300 leading-6 font-medium'
className={`flex cursor-pointer mb-3 max-sm:text-sm leading-6 font-medium ${isActive

Check failure on line 610 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `⏎····················`

Check failure on line 610 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `⏎····················`
? 'text-blue-600 dark:text-blue-400 font-semibold bg-blue-50 dark:bg-slate-700 px-2 py-1 -ml-2 rounded'

Check failure on line 611 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `··`

Check failure on line 611 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `··`
: 'text-slate-600 dark:text-slate-300'

Check failure on line 612 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `··`

Check failure on line 612 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Insert `··`
}`}

Check failure on line 613 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Expected indentation of 18 spaces but found 20

Check failure on line 613 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Delete `··`

Check failure on line 613 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Expected indentation of 18 spaces but found 20

Check failure on line 613 in components/StyledMarkdown.tsx

View workflow job for this annotation

GitHub Actions / Code Quality Checks 

Delete `··`
>
{children}
</a>
Expand All @@ -586,91 +622,107 @@
h2:
depth === 0
? {
component: ({ children }) => {
const slug = slugifyMarkdownHeadline(children);
const isActive = activeSection === slug;
return (
<a
href={`#${slug}`}
className={`block cursor-pointer mb-3 leading-5 font-medium ml-4 ${isActive
? 'text-blue-600 dark:text-blue-400 font-semibold bg-blue-50 dark:bg-slate-700 px-2 py-1 -ml-2 rounded'
: 'text-slate-600 dark:text-slate-300'
}`}
>
{children}
</a>
);
},
}
: depth >= 2
? {
component: ({ children }) => {
const slug = slugifyMarkdownHeadline(children);
const [isChrome, setIsChrome] = useState(false);
const isActive = activeSection === slug;

useEffect(() => {
const chromeCheck =
/Chrome/.test(navigator.userAgent) &&
/Google Inc/.test(navigator.vendor);
setIsChrome(chromeCheck);
}, []);

return (
// chromeClass
<a
href={`#${slug}`}
className='block cursor-pointer mb-3 text-slate-600 dark:text-slate-300 leading-5 font-medium ml-4'
className={`block cursor-pointer mb-3 max-sm:text-sm leading-4 max-sm:-ml-[6px] font-medium ${isActive
? 'text-blue-600 dark:text-blue-400 font-semibold bg-blue-50 dark:bg-slate-700 px-2 py-1 rounded'
: 'text-slate-600 dark:text-slate-300'
} ${isChrome ? '-ml-[4.8px]' : '-ml-[6.5px]'}`}
>
<span className={`mr-1 text-[0.7em] ${isActive ? 'text-blue-600 dark:text-blue-400' : 'text-blue-400'}`}>
&#9679;
</span>
{children}
</a>
);
},
}
: depth >= 2
? {
component: ({ children }) => {
const slug = slugifyMarkdownHeadline(children);
const [isChrome, setIsChrome] = useState(false);

useEffect(() => {
const chromeCheck =
/Chrome/.test(navigator.userAgent) &&
/Google Inc/.test(navigator.vendor);
setIsChrome(chromeCheck);
}, []);

return (
// chromeClass
<a
href={`#${slug}`}
className={`block cursor-pointer mb-3 max-sm:text-sm text-slate-600 dark:text-slate-300 leading-4 ] max-sm:-ml-[6px] font-medium ${isChrome ? '-ml-[4.8px]' : '-ml-[6.5px]'}`}
>
<span className='mr-1 text-blue-400 text-[0.7em]'>
&#9679;
</span>
{children}
</a>
);
},
}
: { component: () => null },
h3:
depth >= 3
? {
component: ({ children }) => {
const slug = slugifyMarkdownHeadline(children);
return (
<a
href={`#${slug}`}
className='flex flex-row items-center cursor-pointer mb-3 max-sm:text-sm text-slate-600 dark:text-slate-300 leading-4 ml-[-0.25rem]'
>
<span className='text-blue-400/40 font-extrabold text-[0.8em] max-sm:text-[1.2em] ml-1'>
&mdash;&mdash;
</span>
<span className='mr-1 text-blue-400/90 text-[0.7em] flex justify-center items-center'>
&#9679;
</span>
component: ({ children }) => {
const slug = slugifyMarkdownHeadline(children);
const isActive = activeSection === slug;
return (
<a
href={`#${slug}`}
className={`flex flex-row items-center cursor-pointer mb-3 max-sm:text-sm leading-4 ml-[-0.25rem] ${isActive
? 'text-blue-600 dark:text-blue-400 font-semibold bg-blue-50 dark:bg-slate-700 px-2 py-1 rounded'
: 'text-slate-600 dark:text-slate-300'
}`}
>
<span className='text-blue-400/40 font-extrabold text-[0.8em] max-sm:text-[1.2em] ml-1'>
&mdash;&mdash;
</span>
<span className={`mr-1 text-[0.7em] flex justify-center items-center ${isActive ? 'text-blue-600 dark:text-blue-400' : 'text-blue-400/90'}`}>
&#9679;
</span>

{children}
</a>
);
},
}
{children}
</a>
);
},
}
: { component: () => null },
h4:
depth >= 4
? {
component: ({ children }) => {
const slug = slugifyMarkdownHeadline(children);
return (
<a
href={`#${slug}`}
className='flex flex-row items-center cursor-pointer mb-3 max-sm:text-sm text-slate-600 dark:text-slate-300 leading-4 ml-[-0.25rem] '
>
<span className='text-blue-400/40 font-extrabold text-[0.8em] ml-1 max-sm:text-[1.2em]'>
&mdash;&mdash;&mdash;&mdash;
</span>
<span className='mr-1 text-blue-400/90 text-[0.7em] flex justify-center items-center'>
&#9679;
</span>
component: ({ children }) => {
const slug = slugifyMarkdownHeadline(children);
const isActive = activeSection === slug;
return (
<a
href={`#${slug}`}
className={`flex flex-row items-center cursor-pointer mb-3 max-sm:text-sm leading-4 ml-[-0.25rem] ${isActive
? 'text-blue-600 dark:text-blue-400 font-semibold bg-blue-50 dark:bg-slate-700 px-2 py-1 rounded'
: 'text-slate-600 dark:text-slate-300'
}`}
>
<span className='text-blue-400/40 font-extrabold text-[0.8em] ml-1 max-sm:text-[1.2em]'>
&mdash;&mdash;&mdash;&mdash;
</span>
<span className={`mr-1 text-[0.7em] flex justify-center items-center ${isActive ? 'text-blue-600 dark:text-blue-400' : 'text-blue-400/90'}`}>
&#9679;
</span>

{children}
</a>
);
},
} /* eslint-enable */
{children}
</a>
);
},
} /* eslint-enable */
: { component: () => null },
...hiddenElements(
'strong',
Expand Down
Loading