Skip to content

[docs] Fix invalid <dl> and <dt> nesting #3102

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

Merged
merged 6 commits into from
Nov 17, 2025
+40 −40
Merged

[docs] Fix invalid <dl> and <dt> nesting #3102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7270d11
Fix invalid dl and dt nesting
mj12albert Oct 30, 2025
ce1f228
Merge branch 'master' into docs/fix-dl-invalid-html
mj12albert Nov 17, 2025
f92d25f
Merge branch 'master' into docs/fix-dl-invalid-html
michaldudak Nov 17, 2025
a3e89f6
Merge remote-tracking branch 'upstream/master' into docs/fix-dl-inval…
mj12albert Nov 17, 2025
ce83bca
Convert to a prop
mj12albert Nov 17, 2025
84f838f
Fix TS
mj12albert Nov 17, 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
57 changes: 31 additions & 26 deletions docs/src/components/DescriptionList.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,34 +15,14 @@
}
}

.DescriptionListSeparator {
position: relative;
display: flex;
align-items: center;

&::before {
content: '';
box-shadow: inset 0 1px 0 0 var(--color-gray-200);
position: absolute;
top: 0;
inset-inline: 0.75rem 1rem;
height: 1px;
}

@media (--xs) {
&::before {
height: 0;
}
}
}

.DescriptionTerm {
@apply text-md;
@apply font-semibold;
letter-spacing: -0.00625em;
color: var(--color-foreground);
white-space: nowrap;
word-break: keep-all;
position: relative;
display: flex;
align-items: center;
margin-bottom: --spacing(1);
Expand All @@ -53,6 +33,23 @@
color: revert-layer;
margin-bottom: 0;
}

&.separator {
&::before {
content: '';
box-shadow: inset 0 1px 0 0 var(--color-gray-200);
position: absolute;
top: 0;
inset-inline: 0.75rem 1rem;
height: 1px;
}

@media (--xs) {
&::before {
height: 0;
}
}
}
}

.DescriptionDetails {
Expand All @@ -71,14 +68,22 @@
align-items: start;
padding-inline: 0.75rem;

@media (--xs) {
min-height: 2.5rem;
padding: 0.625rem 0.75rem;
}

[data-rehype-pretty-code-figure] {
margin: 0;
max-width: 100%;
}

.separator & {
padding-top: --spacing(2);
}

@media (--xs) {
min-height: 2.5rem;

&,
.separator & {
padding: 0.625rem 0.75rem;
}
}
}
}
7 changes: 5 additions & 2 deletions docs/src/components/DescriptionList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ export function Root(props: React.ComponentProps<'dl'>) {
return <dl {...props} className={clsx('DescriptionList', props.className)} />;
}

export function Term(props: React.ComponentProps<'dt'>) {
export function Term({
separator = false,
...props
}: React.ComponentProps<'dt'> & { separator?: boolean }) {
return (
<dt {...props} className={clsx('DescriptionTerm', props.className)}>
<dt {...props} className={clsx('DescriptionTerm', separator && 'separator', props.className)}>
<Inner>{props.children}</Inner>
</dt>
);
Expand Down
16 changes: 4 additions & 12 deletions docs/src/components/ReferenceTable/PropsReferenceAccordion.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,9 +236,7 @@ export async function PropsReferenceAccordion({

{PropDescription != null && (
<DescriptionList.Item>
<DescriptionList.Separator className="max-xs:pt-2">
<DescriptionList.Term>Description</DescriptionList.Term>
</DescriptionList.Separator>
<DescriptionList.Term separator>Description</DescriptionList.Term>
{/* one-off override of the default mt/mb on CodeBlock.Root */}
<DescriptionList.Details className="[&_[role='figure']]:mt-1 [&_[role='figure']]:mb-1">
<PropDescription />
Expand All @@ -247,19 +245,15 @@ export async function PropsReferenceAccordion({
)}

<DescriptionList.Item>
<DescriptionList.Separator className="max-xs:pt-2">
<DescriptionList.Term>Type</DescriptionList.Term>
</DescriptionList.Separator>
<DescriptionList.Term separator>Type</DescriptionList.Term>
<DescriptionList.Details>
<PropDetailedType />
</DescriptionList.Details>
</DescriptionList.Item>

{prop.default !== undefined && (
<DescriptionList.Item>
<DescriptionList.Separator className="max-xs:pt-2">
<DescriptionList.Term>Default</DescriptionList.Term>
</DescriptionList.Separator>
<DescriptionList.Term separator>Default</DescriptionList.Term>
<DescriptionList.Details>
<PropDefault />
</DescriptionList.Details>
Expand All @@ -268,9 +262,7 @@ export async function PropsReferenceAccordion({

{ExampleSnippet != null && (
<DescriptionList.Item>
<DescriptionList.Separator className="max-xs:pt-2">
<DescriptionList.Term>Example</DescriptionList.Term>
</DescriptionList.Separator>
<DescriptionList.Term separator>Example</DescriptionList.Term>
<DescriptionList.Details className="*:my-0">
<ExampleSnippet />
</DescriptionList.Details>
Expand Down
Loading