feat(settings): add search bar to settings sidebar (#1660)

<!-- Please read
https://github.com/SableClient/Sable/blob/dev/CONTRIBUTING.md before
submitting your pull request -->

### Description

<!-- Please include a summary of the change. Please also include
relevant motivation and context. List any dependencies that are required
for this change. -->

Fixes #

#### Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update

### Checklist:

- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings

### AI disclosure:

- [ ] Partially AI assisted (clarify which code was AI assisted and
briefly explain what it does).
- [ ] Fully AI generated (explain what all the generated code does in
moderate detail).
<!-- Write any explanation required here, but do not generate the
explanation using AI!! You must prove you understand what the code in
this PR does. -->
This commit is contained in:
7w1 authored and GitHub committed 2026-08-08 01:36:03 +00:00
commit d065216bc2
6 files changed
+136 -28

No files matched your search

+5
View File
@@ -0,0 +1,5 @@
---
sable: minor
---
Add a search bar to the settings sidebar.
+35 -25
View File
@@ -28,6 +28,8 @@ export type SettingsShellProps<Id extends string> = {
renderHeader?: (closeButton: ReactNode) => ReactNode;
/** Render custom footer below the menu (inside the PageNav column). */
footer?: ReactNode;
searchBar?: ReactNode;
searchResults?: ReactNode;
/** Optional wrapper rendered around the entire component (e.g. SwipeableOverlayWrapper). */
wrapper?: (children: ReactNode) => ReactNode;
/** Wrap the section viewport content (e.g. SettingsLinkProvider). Receives the viewport element. */
@@ -66,6 +68,8 @@ export function SettingsShell<Id extends string>({
requestClose,
renderHeader,
footer,
searchBar,
searchResults,
wrapper,
renderSection,
showCloseInHeader,
@@ -104,35 +108,41 @@ export function SettingsShell<Id extends string>({
)}
</PageNavHeader>
<Box grow="Yes" direction="Column">
{searchBar && (
<Box style={{ padding: config.space.S200 }} shrink="No">
{searchBar}
</Box>
)}
<PageNavContent>
<div style={{ flexGrow: 1 }}>
{visibleIds.map((id) => {
const section = sections[id];
const isActive = active === id;
const IconComponent =
isActive && section.activeIcon ? section.activeIcon : section.icon;
{searchResults ??
visibleIds.map((id) => {
const section = sections[id];
const isActive = active === id;
const IconComponent =
isActive && section.activeIcon ? section.activeIcon : section.icon;
return (
<MenuItem
key={id}
variant="Background"
radii="400"
aria-pressed={isActive}
before={settingsNavIcon(IconComponent, isActive)}
onClick={() => onSelect(id)}
>
<Text
style={{
fontWeight: isActive ? config.fontWeight.W600 : undefined,
}}
size={menuItemTextSize}
truncate
return (
<MenuItem
key={id}
variant="Background"
radii="400"
aria-pressed={isActive}
before={settingsNavIcon(IconComponent, isActive)}
onClick={() => onSelect(id)}
>
{section.label}
</Text>
</MenuItem>
);
})}
<Text
style={{
fontWeight: isActive ? config.fontWeight.W600 : undefined,
}}
size={menuItemTextSize}
truncate
>
{section.label}
</Text>
</MenuItem>
);
})}
</div>
</PageNavContent>
{footer}
+57 -2
View File
@@ -1,7 +1,7 @@
import { useMemo, useState } from 'react';
import type { ComponentType, ReactNode } from 'react';
import { DesktopIcon, PersonSimpleCircleIcon, type IconProps } from '@phosphor-icons/react';
import { Avatar, Box, Button, config, Text } from 'folds';
import { Avatar, Box, Button, config, Input, MenuItem, Text } from 'folds';
import { ScreenSize, useScreenSizeContext } from '$hooks/useScreenSize';
import { useUserProfile } from '$hooks/useUserProfile';
import { useMatrixClient } from '$hooks/useMatrixClient';
@@ -20,9 +20,11 @@ import {
GearSix,
Info,
Keyboard,
MagnifyingGlass,
menuIcon,
SignOut,
Palette,
sizedIcon,
Smiley,
Terminal,
User,
@@ -41,6 +43,7 @@ import { KeyboardShortcuts } from './keyboard-shortcuts';
import { Notifications } from './notifications';
import { PerMessageProfilePage } from './Persona/ProfilesPage';
import { settingsSections, type SettingsSectionId } from './routes';
import { searchSettings, type SettingsSearchEntry } from './settingsSearch';
import { useSettingsFocus } from './useSettingsFocus';
import { SettingsLinkProvider } from './SettingsLinkContext';
import { useSettingsLinkBaseUrl } from './useSettingsLinkBaseUrl';
@@ -146,6 +149,7 @@ const settingsSectionComponents = {
type ControlledSettingsProps = {
activeSection?: SettingsSectionId | null;
onSelectSection?: (section: SettingsSectionId) => void;
onSelectSetting?: (section: SettingsSectionId, focus: string) => void;
onBack?: () => void;
requestClose: () => void;
initialPage?: SettingsPages;
@@ -165,6 +169,7 @@ function SettingsSectionProvider({ children, section, baseUrl }: SectionWrapperP
export function Settings({
activeSection,
onSelectSection,
onSelectSetting,
onBack,
requestClose,
initialPage,
@@ -273,6 +278,16 @@ export function Settings({
[showPersona, isDesktop]
);
const [searchQuery, setSearchQuery] = useState('');
const searchResults = useMemo(() => searchSettings(searchQuery), [searchQuery]);
const isSearching = searchQuery.trim().length > 0;
const menuItemTextSize = screenSize === ScreenSize.Mobile ? 'T400' : 'T300';
const handleSearchResultSelect = (entry: SettingsSearchEntry) => {
setSearchQuery('');
onSelectSetting?.(entry.section, entry.focusId);
};
const renderHeader = useMemo(
() =>
(closeButton: ReactNode): ReactNode => (
@@ -305,8 +320,48 @@ export function Settings({
requestClose={handleRequestClose}
renderHeader={renderHeader}
showCloseInHeader={visibleSection === null}
menuItemTextSize={screenSize === ScreenSize.Mobile ? 'T400' : 'T300'}
menuItemTextSize={menuItemTextSize}
closeButtonAriaLabel="Close settings"
searchBar={
<Input
variant="SurfaceVariant"
size="400"
placeholder="Search settings"
maxLength={50}
value={searchQuery}
onChange={(e) => setSearchQuery((e.target as HTMLInputElement).value)}
before={sizedIcon(MagnifyingGlass, '50')}
style={{ width: '100%' }}
/>
}
searchResults={
isSearching ? (
searchResults.length > 0 ? (
searchResults.map((entry) => (
<MenuItem
key={`${entry.section}-${entry.focusId}`}
variant="Background"
radii="400"
before={sizedIcon(MagnifyingGlass, '50')}
onClick={() => handleSearchResultSelect(entry)}
>
<Box direction="Column">
<Text size={menuItemTextSize} truncate>
{entry.label}
</Text>
<Text size="T200" truncate>
{entry.sectionLabel}
</Text>
</Box>
</MenuItem>
))
) : (
<Box style={{ padding: config.space.S300 }} alignItems="Center" justifyContent="Center">
<Text size="T300">No results found</Text>
</Box>
)
) : undefined
}
renderSection={(viewport) =>
visibleSection ? (
<SettingsSectionProvider section={visibleSection} baseUrl={settingsLinkBaseUrl}>
@@ -133,11 +133,19 @@ export function SettingsRoute({ routeSection }: SettingsRouteProps) {
});
};
const handleSelectSetting = (nextSection: SettingsSectionId, focus: string) => {
navigate(getSettingsPath(nextSection, focus), {
replace: shallowBackgroundState,
state: location.state,
});
};
return (
<Settings
activeSection={activeSection}
onBack={requestBack}
onSelectSection={handleSelectSection}
onSelectSetting={handleSelectSetting}
requestClose={requestClose}
/>
);
+1 -1
View File
@@ -416,7 +416,7 @@ export const buildSettingsLink = (
focus?: string
): string => withOriginBaseUrl(baseUrl, withSettingsLinkAction(getSettingsPath(section, focus)));
const humanizeSettingsLinkPart = (value: string): string =>
export const humanizeSettingsLinkPart = (value: string): string =>
value
.split(/[^a-zA-Z0-9]+/)
.filter(Boolean)
@@ -0,0 +1,30 @@
import { settingsSections, type SettingsSectionId } from './routes';
import { humanizeSettingsLinkPart, settingsLinkFocusIdsBySection } from './settingsLink';
export type SettingsSearchEntry = {
section: SettingsSectionId;
focusId: string;
label: string;
sectionLabel: string;
};
const settingsSectionLabel = Object.fromEntries(
settingsSections.map((section) => [section.id, section.label])
) as Record<SettingsSectionId, string>;
const searchIndex: SettingsSearchEntry[] = settingsSections.flatMap((section) =>
settingsLinkFocusIdsBySection[section.id].map((focusId) => ({
section: section.id,
focusId,
label: humanizeSettingsLinkPart(focusId),
sectionLabel: settingsSectionLabel[section.id],
}))
);
export const searchSettings = (query: string): SettingsSearchEntry[] => {
const q = query.trim().toLowerCase();
if (!q) return [];
return searchIndex.filter(
(entry) => entry.label.toLowerCase().includes(q) || entry.sectionLabel.toLowerCase().includes(q)
);
};