Skip to content

feat: add indentDepth prop to TOCInline component #201

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add indentDepth prop to TOCInline component #201

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cd208c
feat: add indentDepth prop to TOCInline component
tomelliot Apr 10, 2025
ecebc68
fix: adjust TOC indentation logic based on heading depth
tomelliot Apr 10, 2025
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
11 changes: 10 additions & 1 deletion packages/pliny/src/ui/TOCInline.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { Toc, TocItem } from '../mdx-plugins/remark-toc-headings'

export interface TOCInlineProps {
toc: Toc
indentDepth?: number
fromHeading?: number
toHeading?: number
asDisclosure?: boolean
Expand Down Expand Up @@ -52,6 +53,7 @@ const createNestedList = (items: TocItem[]): NestedTocItem[] => {
* If you are using tailwind css and want to revert to the default HTML list style, set `ulClassName="[&_ul]:list-[revert]"`
* @param {TOCInlineProps} {
* toc,
* indentDepth = 3,
* fromHeading = 1,
* toHeading = 6,
* asDisclosure = false,
Expand All @@ -64,6 +66,7 @@ const createNestedList = (items: TocItem[]): NestedTocItem[] => {
*/
const TOCInline = ({
toc,
indentDepth = 3,
fromHeading = 1,
toHeading = 6,
asDisclosure = false,
Expand All @@ -89,7 +92,13 @@ const TOCInline = ({
return (
<ul className={ulClassName}>
{items.map((item, index) => (
<li key={index} className={liClassName}>
<li
key={index}
className={
liClassName +
`${item.depth >= indentDepth && item.depth > fromHeading + 1 ? ' ml-6' : ''}`
}
>
<a href={item.url}>{item.value}</a>
{createList(item.children)}
</li>
Expand Down