Skip to content

Commit 4fb9dfc

Browse files
refactor(mobile): centralize platform header rendering (pingdotgg#12388)
1 parent 7230f6b commit 4fb9dfc

16 files changed

Lines changed: 1042 additions & 382 deletions
Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
import { useCallback, useEffect, useRef, useState } from "react";
2+
import { BackHandler, Keyboard, Pressable, TextInput, View } from "react-native";
3+
import { useSafeAreaInsets } from "react-native-safe-area-context";
4+
import { NativeStackScreenOptions } from "../native/StackHeader";
5+
import { AndroidWorkspaceSidebarButton } from "../features/layout/workspace-sidebar-toolbar";
6+
import { useAppearancePreferences } from "../features/settings/appearance/AppearancePreferencesProvider";
7+
import { AndroidScreenHeader } from "./AndroidScreenHeader";
8+
import { ScreenHeaderButton } from "./ScreenHeaderButton.android";
9+
import { SymbolView } from "./AppSymbol";
10+
import { ControlPillMenu } from "./ControlPill";
11+
import { MaterialSearchField } from "./MaterialSearchField";
12+
import { androidHeaderMenuActions, findHeaderMenuAction } from "./headerMenu.android";
13+
import type { ScreenHeaderProps } from "./ScreenHeader.types";
14+
15+
export function ScreenHeader(props: ScreenHeaderProps) {
16+
const { search } = props;
17+
const insets = useSafeAreaInsets();
18+
const { themeVariables } = useAppearancePreferences();
19+
const inputRef = useRef<TextInput>(null);
20+
const [searchOpen, setSearchOpen] = useState(false);
21+
const searching = search !== undefined && (searchOpen || search.value.length > 0);
22+
const onSearchChange = search?.onChangeText;
23+
const closeSearch = useCallback(() => {
24+
onSearchChange?.("");
25+
setSearchOpen(false);
26+
Keyboard.dismiss();
27+
}, [onSearchChange]);
28+
useEffect(() => {
29+
if (!searching || search?.mode === "inline") return;
30+
const subscription = BackHandler.addEventListener("hardwareBackPress", () => {
31+
closeSearch();
32+
return true;
33+
});
34+
return () => subscription.remove();
35+
}, [closeSearch, searching, search?.mode]);
36+
const menuView = props.menus?.map((menu) => (
37+
<ControlPillMenu
38+
key={menu.title}
39+
actions={androidHeaderMenuActions(menu.items)}
40+
isAnchoredToRight
41+
title={menu.status ?? menu.title}
42+
onPressAction={({ nativeEvent }) => {
43+
const action = findHeaderMenuAction(menu.items, nativeEvent.event);
44+
if (action && !action.disabled) action.onPress();
45+
}}
46+
>
47+
{search?.mode === "inline" ? (
48+
<Pressable
49+
accessibilityLabel={menu.title}
50+
accessibilityRole="button"
51+
className="size-11 items-center justify-center rounded-full bg-subtle"
52+
>
53+
<SymbolView
54+
name={menu.icon}
55+
size={16}
56+
tintColorClassName="accent-icon"
57+
type="monochrome"
58+
/>
59+
</Pressable>
60+
) : (
61+
<ScreenHeaderButton accessibilityLabel={menu.title} icon={menu.icon} />
62+
)}
63+
</ControlPillMenu>
64+
));
65+
const options = (
66+
<NativeStackScreenOptions
67+
options={{
68+
...props.options,
69+
...(props.matchSearchSurface
70+
? { contentStyle: { backgroundColor: themeVariables["--color-header"] } }
71+
: undefined),
72+
headerShown: false,
73+
title: props.title,
74+
}}
75+
optionsVersion={props.optionsVersion}
76+
/>
77+
);
78+
if (search?.mode === "inline") {
79+
return (
80+
<>
81+
{options}
82+
<View
83+
className="border-b border-header-border bg-header px-3 pb-2.5"
84+
style={{ paddingTop: Math.max(insets.top, 12), borderBottomWidth: 0 }}
85+
>
86+
<View className="min-h-12 flex-row items-center gap-2">
87+
{props.onBack ? (
88+
<Pressable
89+
accessibilityLabel="Navigate up"
90+
accessibilityRole="button"
91+
hitSlop={8}
92+
onPress={props.onBack}
93+
className="size-11 items-center justify-center"
94+
>
95+
<SymbolView
96+
name="chevron.left"
97+
size={24}
98+
tintColorClassName="accent-foreground"
99+
type="monochrome"
100+
/>
101+
</Pressable>
102+
) : null}
103+
<View className="min-h-11 flex-1 flex-row items-center gap-2.5 rounded-2xl bg-input px-3.5">
104+
<SymbolView
105+
name="magnifyingglass"
106+
size={17}
107+
tintColorClassName="accent-icon"
108+
type="monochrome"
109+
/>
110+
<TextInput
111+
accessibilityLabel={search.placeholder}
112+
autoCapitalize="none"
113+
onChangeText={search.onChangeText}
114+
value={search.value}
115+
placeholder={search.placeholder}
116+
placeholderTextColorClassName="accent-placeholder"
117+
className="flex-1 py-2 text-base font-sans text-foreground"
118+
/>
119+
</View>
120+
{menuView}
121+
</View>
122+
</View>
123+
</>
124+
);
125+
}
126+
const header = (
127+
<AndroidScreenHeader
128+
title={props.title}
129+
subtitle={props.subtitle}
130+
onBack={props.onBack}
131+
leading={props.sidebar !== false ? <AndroidWorkspaceSidebarButton /> : undefined}
132+
hideBottomBorder={props.hideBottomBorder}
133+
actions={
134+
search
135+
? [
136+
{
137+
accessibilityLabel: search.placeholder,
138+
icon: "magnifyingglass",
139+
onPress: () => setSearchOpen(true),
140+
},
141+
...(search.onRefresh
142+
? [
143+
{
144+
accessibilityLabel: search.refreshAccessibilityLabel ?? "Refresh",
145+
icon: "arrow.clockwise" as const,
146+
onPress: search.onRefresh,
147+
},
148+
]
149+
: []),
150+
...(props.actions ?? []),
151+
]
152+
: props.actions
153+
}
154+
trailing={
155+
<>
156+
{menuView}
157+
{props.trailing}
158+
</>
159+
}
160+
/>
161+
);
162+
return (
163+
<>
164+
{options}
165+
{search ? (
166+
<View>
167+
<View
168+
pointerEvents={searching ? "none" : "auto"}
169+
accessibilityElementsHidden={searching}
170+
importantForAccessibility={searching ? "no-hide-descendants" : "auto"}
171+
style={{ opacity: searching ? 0 : 1 }}
172+
>
173+
{header}
174+
</View>
175+
{searching ? (
176+
<View
177+
className="absolute inset-0 bg-header px-2 pb-2"
178+
style={{ paddingTop: Math.max(insets.top, 12) }}
179+
>
180+
<View className="min-h-14 flex-1 flex-row items-center gap-1">
181+
<ScreenHeaderButton
182+
accessibilityLabel={search.closeAccessibilityLabel ?? "Close search"}
183+
icon="arrow.left"
184+
onPress={closeSearch}
185+
/>
186+
<MaterialSearchField
187+
inputRef={inputRef}
188+
accessibilityLabel={search.placeholder}
189+
clearAccessibilityLabel={search.clearAccessibilityLabel ?? "Clear search"}
190+
placeholder={search.placeholder}
191+
value={search.value}
192+
onChangeText={search.onChangeText}
193+
/>
194+
</View>
195+
</View>
196+
) : null}
197+
</View>
198+
) : (
199+
header
200+
)}
201+
</>
202+
);
203+
}
Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
import type { HeaderBarButtonMailSearchToolbarItem } from "react-native-screens";
2+
import { useId } from "react";
3+
import { createNativeHeaderMenu } from "./nativeHeaderMenu.ios";
4+
import { ScreenHeaderButton } from "./ScreenHeaderButton";
5+
import { NativeHeaderToolbar, NativeStackScreenOptions } from "../native/StackHeader";
6+
import { useAdaptiveWorkspaceLayout } from "../features/layout/AdaptiveWorkspaceLayout";
7+
import {
8+
createNativeMailSearchToolbarItem,
9+
NATIVE_MAIL_SEARCH_TOOLBAR_SUPPORTED,
10+
} from "../features/layout/native-mail-search-toolbar";
11+
import { useAppearancePreferences } from "../features/settings/appearance/AppearancePreferencesProvider";
12+
import type { ScreenHeaderMenuItem, ScreenHeaderProps } from "./ScreenHeader.types";
13+
import type { AppSymbolName } from "./AppSymbol";
14+
15+
function iosIcon(icon: AppSymbolName) {
16+
return typeof icon === "string" ? icon : icon.ios;
17+
}
18+
19+
type MailMenu = NonNullable<HeaderBarButtonMailSearchToolbarItem["filterMenu"]>;
20+
function mailMenuItems(items: ReadonlyArray<ScreenHeaderMenuItem>): MailMenu["items"] {
21+
return items.map((item) =>
22+
"items" in item
23+
? { type: "submenu", title: item.title ?? "", items: mailMenuItems(item.items) }
24+
: {
25+
type: "action",
26+
title: item.title,
27+
state: item.selected ? "on" : "off",
28+
disabled: item.disabled,
29+
onPress: item.onPress,
30+
},
31+
);
32+
}
33+
34+
export function ScreenHeader(props: ScreenHeaderProps) {
35+
const headerId = useId();
36+
const { layout, panes, togglePrimarySidebar } = useAdaptiveWorkspaceLayout();
37+
const { themeVariables } = useAppearancePreferences();
38+
const { search, menus } = props;
39+
const menu = menus?.[0];
40+
const compactSearch =
41+
search !== undefined &&
42+
(search.compactToolbar ?? !layout.usesSplitView) &&
43+
NATIVE_MAIL_SEARCH_TOOLBAR_SUPPORTED;
44+
const visibleMenus = compactSearch ? (menus?.slice(1) ?? []) : (menus ?? []);
45+
const refresh = search?.refreshInToolbar ? search.onRefresh : undefined;
46+
return (
47+
<>
48+
<NativeStackScreenOptions
49+
optionsVersion={[
50+
props.optionsVersion,
51+
compactSearch ? menu : undefined,
52+
compactSearch ? refresh : undefined,
53+
]}
54+
options={{
55+
headerShown: true,
56+
title: props.title,
57+
unstable_headerSubtitle: props.subtitle || undefined,
58+
...(props.matchSearchSurface
59+
? { contentStyle: { backgroundColor: themeVariables["--color-sheet-solid"] } }
60+
: undefined),
61+
...(search
62+
? {
63+
unstable_headerToolbarItems: compactSearch
64+
? () => [
65+
createNativeMailSearchToolbarItem({
66+
showsSearchDismissButton: true,
67+
placeholder: search.compactPlaceholder ?? search.placeholder,
68+
onSearchTextChange: search.onChangeText,
69+
searchTextChangeId: `${headerId}-search-text`,
70+
...(refresh
71+
? {
72+
composeButtonId: `${headerId}-refresh`,
73+
composeSystemImageName: "arrow.clockwise",
74+
onComposePress: refresh,
75+
}
76+
: undefined),
77+
...(menu
78+
? {
79+
filterButtonId: `${headerId}-filter`,
80+
filterSystemImageName: iosIcon(menu.icon),
81+
filterMenu: { title: menu.title, items: mailMenuItems(menu.items) },
82+
}
83+
: undefined),
84+
}),
85+
]
86+
: undefined,
87+
headerSearchBarOptions: compactSearch
88+
? undefined
89+
: {
90+
allowToolbarIntegration: true,
91+
...(NATIVE_MAIL_SEARCH_TOOLBAR_SUPPORTED && search.mode === "inline"
92+
? { placement: "integratedButton" as const }
93+
: undefined),
94+
autoCapitalize: "none",
95+
hideNavigationBar: false,
96+
...(search.mode === "inline" ? { obscureBackground: false } : undefined),
97+
placeholder: search.placeholder,
98+
onChangeText: (event) => search.onChangeText(event.nativeEvent.text),
99+
onCancelButtonPress: () => search.onChangeText(""),
100+
},
101+
}
102+
: undefined),
103+
...props.options,
104+
}}
105+
/>
106+
{props.sidebar !== false && layout.usesSplitView ? (
107+
<NativeHeaderToolbar placement="left">
108+
{props.backInSplitView && (props.backInSplitView.onPress || props.onBack) ? (
109+
<ScreenHeaderButton
110+
{...props.backInSplitView}
111+
onPress={props.backInSplitView.onPress ?? props.onBack}
112+
/>
113+
) : null}
114+
<ScreenHeaderButton
115+
accessibilityLabel={
116+
panes.primarySidebarVisible ? `Maximize ${props.title.toLowerCase()}` : "Show threads"
117+
}
118+
icon={
119+
panes.primarySidebarVisible ? "arrow.up.left.and.arrow.down.right" : "sidebar.left"
120+
}
121+
onPress={togglePrimarySidebar}
122+
separateBackground={
123+
props.backInSplitView ? props.backInSplitView.separateBackground : true
124+
}
125+
/>
126+
</NativeHeaderToolbar>
127+
) : null}
128+
{(props.actions?.length ||
129+
(!compactSearch && refresh) ||
130+
visibleMenus.length ||
131+
props.trailing) &&
132+
props.options?.unstable_headerRightItems === undefined ? (
133+
<NativeHeaderToolbar placement="right">
134+
{props.actions?.map((action) => (
135+
<ScreenHeaderButton
136+
key={action.accessibilityLabel}
137+
{...action}
138+
icon={iosIcon(action.icon)}
139+
separateBackground
140+
/>
141+
))}
142+
{refresh && !compactSearch ? (
143+
<ScreenHeaderButton
144+
accessibilityLabel={search?.refreshAccessibilityLabel}
145+
icon="arrow.clockwise"
146+
onPress={refresh}
147+
separateBackground
148+
/>
149+
) : null}
150+
{visibleMenus.map(createNativeHeaderMenu)}
151+
{props.trailing}
152+
</NativeHeaderToolbar>
153+
) : null}
154+
</>
155+
);
156+
}
157+
158+
export type {
159+
ScreenHeaderAction,
160+
ScreenHeaderMenu,
161+
ScreenHeaderMenuItem,
162+
ScreenHeaderProps,
163+
ScreenHeaderSearch,
164+
} from "./ScreenHeader.types";

0 commit comments

Comments
 (0)