Files
outline/app/hooks/useActiveSidebarContext.ts
Tom Moor ef6e51401b perf: Reduce main-thread cost of opening a document from the sidebar (#14033)
* perf: Read active models lazily in ActionContextProvider

The root provider read the active document and models during render, so
every navigation rebuilt the context and re-rendered all consumers. These
values are now getters, and overrides are merged without evaluating them.

* perf: Skip urlId scan in Store.get for UUIDs

When an id was not loaded, get() searched every item by urlId, so each
sidebar row observed the whole store. A UUID cannot end with a urlId, so
the search is skipped for UUIDs.

* perf: Stop sidebar rows re-rendering on navigation

- Track expanded nodes in an observable map, as ObservableSet.has tracks
  the whole set.
- Do not rebuild the document tree rows when the active document changes.
- Auto-expand the active path in a reaction instead of reading the active
  document during render.
- Compute active state per row, and keep row props stable.

* perf: Add useLocationSelector for persistent components

useLocation re-renders on every navigation. The new hook re-renders only
when the selected value changes, and is used where components stay mounted
across navigation. AuthenticatedLayout now keeps its portal element in
state, as it no longer re-renders after mount.

* chore: Send Document-Policy js-profiling header in development

* docs: Add render performance guidance to AGENTS.md

* fix: Check document or collection star exclusively for active state

* fix: Read location from each action context provider's own history

Nested providers inherited the root location getter, so menus inside a
split view pane read the browser route instead of the pane's route.

* fix: Expand starred collection when the active document changes
2026-10-11 15:17:01 -04:00

34 lines
1.3 KiB
TypeScript

import type { SidebarContextType } from "~/components/Sidebar/components/SidebarContext";
import { useSplitView } from "~/components/SplitView/context";
import { getFocusedSplitPane, getSplitPath } from "~/utils/splitView";
import { useLocationSelector } from "./useLocationSelector";
/**
* Hook to retrieve the sidebar context that the sidebar should treat as
* active. When a secondary split view pane has focus, this resolves to that
* pane's context so that sidebar auto-expansion and active state follow the
* focused pane rather than the primary browser location.
*
* The focused pane is observable, so the calling component must be wrapped in
* `observer` to update when focus changes.
*
* @returns the active sidebar context.
*/
export function useActiveSidebarContext(): SidebarContextType {
const focusedPane = getFocusedSplitPane();
const { isSplitView } = useSplitView();
const isSecondaryFocused = !isSplitView && focusedPane === "secondary";
// Select only the sidebar context, so that callers do not re-render on
// every navigation.
return useLocationSelector<
{ sidebarContext?: SidebarContextType },
SidebarContextType
>((location) => {
if (isSecondaryFocused && getSplitPath(location.search)) {
return location.state?.sidebarContext ?? "collections";
}
return location.state?.sidebarContext;
});
}