Skip to content

Commit b487fac

Browse files
committed
Improve comments
1 parent 9a01a8e commit b487fac

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

app/actions/menu-collapse/route.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ export async function action({ request, context }: Route.ActionArgs) {
1616
let parsedOpen = open === "true";
1717

1818
let menuCollapse = menuCollapseContext(context);
19+
// This action is responsible for setting the menu collapse state.
20+
// Middleware is responsible for writing it to the cookie.
1921
menuCollapse.set(category, parsedOpen);
2022

2123
return parsedOpen;

app/actions/menu-collapse/server.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ let cookie = createCookie("menu-collapse", {
1111
sameSite: "lax",
1212
});
1313

14+
// Default behavior: missing categories are treated as "open" (true)
1415
type MenuCollapseState = Record<string, boolean>;
1516

1617
let menuCollapseStateContext = unstable_createContext<MenuCollapseState>({});

app/components/docs-menu/menu.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ function MenuCategoryDetails({
126126
function useMenuCollapse(category?: string) {
127127
const menuCollapseState = useDocsLayoutRouteLoaderData()?.menuCollapseState;
128128
const [isOpen, setIsOpen] = React.useState(
129-
() => menuCollapseState?.[category ?? ""] ?? true,
129+
menuCollapseState?.[category ?? ""] ?? true,
130130
);
131131
const submit = useSubmit();
132132

@@ -149,7 +149,7 @@ function useMenuCollapse(category?: string) {
149149
[category, submit],
150150
);
151151

152-
// Auto open the details element, necessary when navigating from the index page or a document request on a page in a collapsed menu
152+
// Auto-expand when navigating to a page within this category
153153
let { isActive } = useNavigation(category);
154154
React.useEffect(() => {
155155
if (isActive) {

0 commit comments

Comments
 (0)