Skip to content
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

Jump to bottom

Announce collapsible sections in the docs menu #180

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Announce collapsible sections in the docs menu #180

Show file tree
Hide file tree
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
13 changes: 9 additions & 4 deletions frontend/src/components/TreeView/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
import clsx from "clsx";
import { ReactNode } from "react";
import { AriaAttributes, ReactNode } from "react";

interface TreeViewProps {
interface TreeViewProps extends Pick<AriaAttributes, "aria-labelledby"> {
children: ReactNode;
className?: string;
id?: string;
}

export function TreeView({ children, className }: TreeViewProps) {
return <ul className={clsx("flex flex-col", className)}>{children}</ul>;
export function TreeView({ children, className, id, ...rest }: TreeViewProps) {
return (
<ul className={clsx("flex flex-col", className)} id={id} {...rest}>
{children}
</ul>
);
}

interface TreeViewItemProps {
Expand Down
9 changes: 7 additions & 2 deletions frontend/src/routes/Provider/components/DocsMenu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { TreeView, TreeViewItem } from "@/components/TreeView";
import { chevron } from "@/icons/chevron";
import { useSuspenseQuery } from "@tanstack/react-query";
import clsx from "clsx";
import { useState, useTransition } from "react";
import { useId, useState, useTransition } from "react";
import { To, useHref, useLinkClickHandler } from "react-router-dom";

import { NestedItem, transformStructure } from "../docsSidebar";
Expand Down Expand Up @@ -55,12 +55,17 @@ function DocsTreeViewItem({
const { lang } = useProviderParams();
const [open, setOpen] = useState(isOpenByDefault);
let button;
const listId = useId();
const buttonId = useId();

if (item.items) {
button = (
<button
className="flex gap-2 px-4 py-2 text-left text-inherit hover:bg-gray-100 dark:hover:bg-blue-900"
onClick={() => setOpen(!open)}
aria-expanded={open}
aria-controls={open ? listId : undefined}
id={buttonId}
>
<Icon
path={chevron}
Expand All @@ -86,7 +91,7 @@ function DocsTreeViewItem({
<TreeViewItem nested={nested} className={nested ? "ml-2" : ""}>
{button}
{open && item.items && (
<TreeView className="ml-4">
<TreeView className="ml-4" id={listId} aria-labelledby={buttonId}>
{item.items.map((subitem) => (
<DocsTreeViewItem
key={subitem.name}
Expand Down
Loading