Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Add generic sort menu component shown in both main screen and folder screens (#1593)

Leendert de Borst10315e917d9a
diff --git a/apps/mobile-app/app/(tabs)/items/folder/[id].tsx b/apps/mobile-app/app/(tabs)/items/folder/[id].tsx
index 412ed30dc..b32b048d4 100644
--- a/apps/mobile-app/app/(tabs)/items/folder/[id].tsx
+++ b/apps/mobile-app/app/(tabs)/items/folder/[id].tsx
@@ -9,12 +9,14 @@ import { useSafeAreaInsets } from 'react-native-safe-area-context';
import Toast from 'react-native-toast-message';
import type { Folder } from '@/utils/db/repositories/FolderRepository';
+import type { CredentialSortOrder } from '@/utils/db/repositories/SettingsRepository';
import type { Item, ItemType } from '@/utils/dist/core/models/vault';
import { getFieldValue, FieldKey, ItemTypes } from '@/utils/dist/core/models/vault';
import emitter from '@/utils/EventEmitter';
import { VaultAuthenticationError } from '@/utils/types/errors/VaultAuthenticationError';
import { useColors } from '@/hooks/useColorScheme';
+import { useItemSort, useSortedItems } from '@/hooks/useItemSort';
import { useMinDurationLoading } from '@/hooks/useMinDurationLoading';
import { useVaultMutate } from '@/hooks/useVaultMutate';
import { useVaultSync } from '@/hooks/useVaultSync';
@@ -22,6 +24,7 @@ import { useVaultSync } from '@/hooks/useVaultSync';
import { DeleteFolderModal } from '@/components/folders/DeleteFolderModal';
import { FolderModal } from '@/components/folders/FolderModal';
import { ItemCard } from '@/components/items/ItemCard';
+import { SortMenu } from '@/components/items/SortMenu';
import { ThemedContainer } from '@/components/themed/ThemedContainer';
import { ThemedText } from '@/components/themed/ThemedText';
import { ThemedView } from '@/components/themed/ThemedView';
@@ -88,6 +91,9 @@ export default function FolderViewScreen(): React.ReactNode {
const [filterType, setFilterType] = useState<FilterType>('all');
const [showFilterMenu, setShowFilterMenu] = useState(false);
+ // Sort state
+ const { sortOrder, setSortOrder, showSortMenu, setShowSortMenu, toggleSortMenu } = useItemSort();
+
// Folder modals
const [showEditFolderModal, setShowEditFolderModal] = useState(false);
const [showDeleteFolderModal, setShowDeleteFolderModal] = useState(false);
@@ -165,6 +171,11 @@ export default function FolderViewScreen(): React.ReactNode {
});
}, [itemsList, searchQuery, filterType]);
+ /**
+ * Sort the filtered items based on the current sort order.
+ */
+ const sortedItems = useSortedItems(filteredItems, sortOrder);
+
/**
* Load items in this folder and folder details.
*/
@@ -174,9 +185,10 @@ export default function FolderViewScreen(): React.ReactNode {
}
try {
- const [items, folders] = await Promise.all([
+ const [items, folders, savedSortOrder] = await Promise.all([
dbContext.sqliteClient!.items.getAll(),
- dbContext.sqliteClient!.folders.getAll()
+ dbContext.sqliteClient!.folders.getAll(),
+ dbContext.sqliteClient!.settings.getCredentialsSortOrder()
]);
// Filter to only items in this folder
const folderItems = items.filter((item: Item) => item.FolderId === folderId);
@@ -185,6 +197,7 @@ export default function FolderViewScreen(): React.ReactNode {
// Find this folder
const currentFolder = folders.find((f: Folder) => f.Id === folderId);
setFolder(currentFolder || null);
+ setSortOrder(savedSortOrder);
setIsLoadingItems(false);
} catch (err) {
console.error('Error loading folder items:', err);
@@ -195,7 +208,7 @@ export default function FolderViewScreen(): React.ReactNode {
});
setIsLoadingItems(false);
}
- }, [dbContext.sqliteClient, folderId, setIsLoadingItems, t]);
+ }, [dbContext.sqliteClient, folderId, setIsLoadingItems, setSortOrder, t]);
useEffect(() => {
// Add listener for item changes
@@ -445,13 +458,23 @@ export default function FolderViewScreen(): React.ReactNode {
color: colors.textMuted,
fontSize: 20,
},
+ // Header row styles
+ headerRow: {
+ alignItems: 'center',
+ flexDirection: 'row',
+ justifyContent: 'space-between',
+ marginBottom: 16,
+ },
// Filter button styles
filterButton: {
alignItems: 'center',
flexDirection: 'row',
- marginBottom: 16,
+ flex: 1,
gap: 8,
},
+ sortButton: {
+ padding: 8,
+ },
filterButtonText: {
color: colors.text,
fontSize: 22,
@@ -673,28 +696,42 @@ export default function FolderViewScreen(): React.ReactNode {
};
/**
- * Render the list header with filter and search.
+ * Render the list header with filter, sort button, and search.
*/
const renderListHeader = (): React.ReactNode => {
return (
<ThemedView>
- {/* Filter button */}
- <TouchableOpacity
- style={styles.filterButton}
- onPress={() => setShowFilterMenu(!showFilterMenu)}
- >
- <ThemedText style={styles.filterButtonText}>
- {getFilterTitle()}
- </ThemedText>
- <ThemedText style={styles.filterCount}>
- ({filteredItems.length})
- </ThemedText>
- <MaterialIcons
- name={showFilterMenu ? "keyboard-arrow-up" : "keyboard-arrow-down"}
- size={24}
- color={colors.text}
- />
- </TouchableOpacity>
+ {/* Header row with filter dropdown and sort button */}
+ <View style={styles.headerRow}>
+ {/* Filter button */}
+ <TouchableOpacity
+ style={styles.filterButton}
+ onPress={() => setShowFilterMenu(!showFilterMenu)}
+ >
+ <ThemedText style={styles.filterButtonText}>
+ {getFilterTitle()}
+ </ThemedText>
+ <ThemedText style={styles.filterCount}>
+ ({filteredItems.length})
+ </ThemedText>
+ <MaterialIcons
+ name={showFilterMenu ? "keyboard-arrow-up" : "keyboard-arrow-down"}
+ size={24}
+ color={colors.text}
+ />
+ </TouchableOpacity>
+ {/* Sort button */}
+ <TouchableOpacity
+ style={styles.sortButton}
+ onPress={toggleSortMenu}
+ >
+ <MaterialIcons
+ name="sort"
+ size={24}
+ color={colors.textMuted}
+ />
+ </TouchableOpacity>
+ </View>
{/* Search input */}
<ThemedView style={styles.searchContainer}>
@@ -762,7 +799,7 @@ export default function FolderViewScreen(): React.ReactNode {
{/* Item list */}
<FlatList
ref={flatListRef}
- data={isLoadingItems ? Array(4).fill(null) : filteredItems}
+ data={isLoadingItems ? Array(4).fill(null) : sortedItems}
keyExtractor={(itm, index) => itm?.Id ?? `skeleton-${index}`}
keyboardShouldPersistTaps='handled'
contentContainerStyle={styles.contentContainer}
@@ -794,6 +831,21 @@ export default function FolderViewScreen(): React.ReactNode {
{/* Filter menu overlay */}
{renderFilterOverlay()}
+ {/* Sort menu overlay */}
+ <SortMenu
+ visible={showSortMenu}
+ sortOrder={sortOrder}
+ onSelect={async (order: CredentialSortOrder) => {
+ setSortOrder(order);
+ // Save to settings and trigger vault sync
+ await executeVaultMutation(async () => {
+ await dbContext.sqliteClient?.settings.setCredentialsSortOrder(order);
+ });
+ }}
+ onClose={() => setShowSortMenu(false)}
+ topOffset={Platform.OS === 'ios' ? paddingTop + 104 : paddingTop + 44}
+ />
+
{/* Folder modals */}
<FolderModal
isOpen={showEditFolderModal}
diff --git a/apps/mobile-app/app/(tabs)/items/index.tsx b/apps/mobile-app/app/(tabs)/items/index.tsx
index 8c6936165..410190854 100644
--- a/apps/mobile-app/app/(tabs)/items/index.tsx
+++ b/apps/mobile-app/app/(tabs)/items/index.tsx
@@ -25,6 +25,7 @@ import { ConfirmDialog } from '@/components/common/ConfirmDialog';
import { FolderModal } from '@/components/folders/FolderModal';
import { FolderPill, type FolderWithCount } from '@/components/folders/FolderPill';
import { ItemCard } from '@/components/items/ItemCard';
+import { SortMenu } from '@/components/items/SortMenu';
import { ThemedContainer } from '@/components/themed/ThemedContainer';
import { ThemedText } from '@/components/themed/ThemedText';
import { ThemedView } from '@/components/themed/ThemedView';
@@ -66,15 +67,6 @@ const ITEM_TYPE_OPTIONS: ItemTypeOption[] = [
{ type: ItemTypes.Note, titleKey: 'itemTypes.note.title', iconName: 'description' },
];
-/**
- * Sort order options with their translation keys.
- */
-const SORT_OPTIONS: { value: CredentialSortOrder; labelKey: string }[] = [
- { value: 'OldestFirst', labelKey: 'items.sort.oldestFirst' },
- { value: 'NewestFirst', labelKey: 'items.sort.newestFirst' },
- { value: 'Alphabetical', labelKey: 'items.sort.alphabetical' },
-];
-
/**
* Items screen - main vault items list.
*/
@@ -580,32 +572,6 @@ export default function ItemsScreen(): React.ReactNode {
top: 0,
zIndex: 1000,
},
- // Sort menu styles
- sortMenuOverlay: {
- backgroundColor: colors.accentBackground,
- borderColor: colors.accentBorder,
- borderRadius: 8,
- borderWidth: 1,
- elevation: 8,
- overflow: 'hidden',
- position: 'absolute',
- right: 14,
- shadowColor: colors.black,
- shadowOffset: { width: 0, height: 2 },
- shadowOpacity: 0.25,
- shadowRadius: 4,
- top: Platform.OS === 'ios' ? insets.top + 112 : 8,
- width: 200,
- zIndex: 1001,
- },
- sortMenuBackdrop: {
- bottom: 0,
- left: 0,
- position: 'absolute',
- right: 0,
- top: 0,
- zIndex: 1000,
- },
filterMenuItem: {
paddingHorizontal: 16,
paddingVertical: 12,
@@ -1182,51 +1148,18 @@ export default function ItemsScreen(): React.ReactNode {
{renderFilterOverlay()}
{/* Sort menu overlay */}
- {showSortMenu && (
- <>
- <TouchableOpacity
- style={styles.sortMenuBackdrop}
- activeOpacity={1}
- onPress={() => setShowSortMenu(false)}
- />
- <ThemedView style={styles.sortMenuOverlay}>
- {SORT_OPTIONS.map((option) => (
- <TouchableOpacity
- key={option.value}
- style={[
- styles.filterMenuItem,
- styles.filterMenuItemWithIcon
- ]}
- onPress={async () => {
- setSortOrder(option.value);
- setShowSortMenu(false);
- // Save to settings and trigger vault sync
- await executeVaultMutation(async () => {
- await dbContext.sqliteClient?.settings.setCredentialsSortOrder(option.value);
- });
- }}
- >
- {sortOrder === option.value ? (
- <MaterialIcons
- name="check"
- size={18}
- color={colors.primary}
- style={styles.filterMenuItemIcon}
- />
- ) : (
- <View style={styles.filterMenuItemIcon} />
- )}
- <ThemedText style={[
- styles.filterMenuItemText,
- sortOrder === option.value && styles.filterMenuItemTextActive
- ]}>
- {t(option.labelKey)}
- </ThemedText>
- </TouchableOpacity>
- ))}
- </ThemedView>
- </>
- )}
+ <SortMenu
+ visible={showSortMenu}
+ sortOrder={sortOrder}
+ onSelect={async (order: CredentialSortOrder) => {
+ setSortOrder(order);
+ // Save to settings and trigger vault sync
+ await executeVaultMutation(async () => {
+ await dbContext.sqliteClient?.settings.setCredentialsSortOrder(order);
+ });
+ }}
+ onClose={() => setShowSortMenu(false)}
+ />
{/* Create folder modal */}
<FolderModal
diff --git a/apps/mobile-app/components/items/SortMenu.tsx b/apps/mobile-app/components/items/SortMenu.tsx
new file mode 100644
index 000000000..1331e3c85
--- /dev/null
+++ b/apps/mobile-app/components/items/SortMenu.tsx
@@ -0,0 +1,186 @@
+import MaterialIcons from '@expo/vector-icons/MaterialIcons';
+import { useTranslation } from 'react-i18next';
+import { StyleSheet, TouchableOpacity, View, Platform } from 'react-native';
+import { useSafeAreaInsets } from 'react-native-safe-area-context';
+
+import type { CredentialSortOrder } from '@/utils/db/repositories/SettingsRepository';
+
+import { useColors } from '@/hooks/useColorScheme';
+import { SORT_OPTIONS } from '@/hooks/useItemSort';
+
+import { ThemedText } from '@/components/themed/ThemedText';
+import { ThemedView } from '@/components/themed/ThemedView';
+
+interface SortMenuProps {
+ /**
+ * Whether the menu is visible.
+ */
+ visible: boolean;
+ /**
+ * Current sort order.
+ */
+ sortOrder: CredentialSortOrder;
+ /**
+ * Callback when a sort option is selected.
+ */
+ onSelect: (order: CredentialSortOrder) => void;
+ /**
+ * Callback when the menu should close.
+ */
+ onClose: () => void;
+ /**
+ * Optional top offset for the menu position.
+ * If not provided, uses default position based on platform.
+ */
+ topOffset?: number;
+}
+
+/**
+ * Reusable sort menu overlay component.
+ * Displays a dropdown menu with sort options (Oldest First, Newest First, Alphabetical).
+ */
+export function SortMenu({
+ visible,
+ sortOrder,
+ onSelect,
+ onClose,
+ topOffset,
+}: SortMenuProps): React.ReactNode {
+ const { t } = useTranslation();
+ const colors = useColors();
+ const insets = useSafeAreaInsets();
+
+ if (!visible) {
+ return null;
+ }
+
+ // Calculate default top offset based on platform
+ const defaultTopOffset = Platform.OS === 'ios' ? insets.top + 112 : 8;
+ const menuTop = topOffset ?? defaultTopOffset;
+
+ const styles = StyleSheet.create({
+ backdrop: {
+ bottom: 0,
+ left: 0,
+ position: 'absolute',
+ right: 0,
+ top: 0,
+ zIndex: 1000,
+ },
+ menuOverlay: {
+ backgroundColor: colors.accentBackground,
+ borderColor: colors.accentBorder,
+ borderRadius: 8,
+ borderWidth: 1,
+ elevation: 8,
+ overflow: 'hidden',
+ position: 'absolute',
+ right: 14,
+ shadowColor: colors.black,
+ shadowOffset: { width: 0, height: 2 },
+ shadowOpacity: 0.25,
+ shadowRadius: 4,
+ top: menuTop,
+ width: 200,
+ zIndex: 1001,
+ },
+ menuItem: {
+ alignItems: 'center',
+ flexDirection: 'row',
+ gap: 8,
+ paddingHorizontal: 16,
+ paddingVertical: 12,
+ },
+ menuItemIcon: {
+ width: 18,
+ },
+ menuItemText: {
+ color: colors.text,
+ fontSize: 14,
+ },
+ menuItemTextActive: {
+ color: colors.primary,
+ fontWeight: '600',
+ },
+ });
+
+ return (
+ <>
+ {/* Backdrop to close menu when tapping outside */}
+ <TouchableOpacity
+ style={styles.backdrop}
+ activeOpacity={1}
+ onPress={onClose}
+ />
+ {/* Menu content */}
+ <ThemedView style={styles.menuOverlay}>
+ {SORT_OPTIONS.map((option) => (
+ <TouchableOpacity
+ key={option.value}
+ style={styles.menuItem}
+ onPress={() => {
+ onSelect(option.value);
+ onClose();
+ }}
+ >
+ {sortOrder === option.value ? (
+ <MaterialIcons
+ name="check"
+ size={18}
+ color={colors.primary}
+ style={styles.menuItemIcon}
+ />
+ ) : (
+ <View style={styles.menuItemIcon} />
+ )}
+ <ThemedText style={[
+ styles.menuItemText,
+ sortOrder === option.value && styles.menuItemTextActive
+ ]}>
+ {t(option.labelKey)}
+ </ThemedText>
+ </TouchableOpacity>
+ ))}
+ </ThemedView>
+ </>
+ );
+}
+
+interface SortButtonProps {
+ /**
+ * Callback when button is pressed.
+ */
+ onPress: () => void;
+ /**
+ * Optional style variant for different contexts.
+ */
+ variant?: 'header' | 'inline';
+}
+
+/**
+ * Reusable sort button component.
+ * Can be used in headers or inline with other controls.
+ */
+export function SortButton({ onPress, variant = 'inline' }: SortButtonProps): React.ReactNode {
+ const colors = useColors();
+
+ const styles = StyleSheet.create({
+ button: {
+ padding: 8,
+ marginRight: variant === 'header' ? 8 : 0,
+ },
+ });
+
+ return (
+ <TouchableOpacity
+ style={styles.button}
+ onPress={onPress}
+ >
+ <MaterialIcons
+ name="sort"
+ size={24}
+ color={variant === 'header' ? colors.text : colors.textMuted}
+ />
+ </TouchableOpacity>
+ );
+}
diff --git a/apps/mobile-app/hooks/useItemSort.ts b/apps/mobile-app/hooks/useItemSort.ts
new file mode 100644
index 000000000..d45afcc02
--- /dev/null
+++ b/apps/mobile-app/hooks/useItemSort.ts
@@ -0,0 +1,123 @@
+import { useState, useMemo, useCallback } from 'react';
+
+import type { CredentialSortOrder } from '@/utils/db/repositories/SettingsRepository';
+import type { Item } from '@/utils/dist/core/models/vault';
+
+/**
+ * Sort order options with their translation keys.
+ */
+export const SORT_OPTIONS: { value: CredentialSortOrder; labelKey: string }[] = [
+ { value: 'OldestFirst', labelKey: 'items.sort.oldestFirst' },
+ { value: 'NewestFirst', labelKey: 'items.sort.newestFirst' },
+ { value: 'Alphabetical', labelKey: 'items.sort.alphabetical' },
+];
+
+/**
+ * Return type for the useItemSort hook.
+ */
+export interface UseItemSortReturn {
+ /**
+ * Current sort order.
+ */
+ sortOrder: CredentialSortOrder;
+ /**
+ * Set the sort order.
+ */
+ setSortOrder: (order: CredentialSortOrder) => void;
+ /**
+ * Whether the sort menu is visible.
+ */
+ showSortMenu: boolean;
+ /**
+ * Set the sort menu visibility.
+ */
+ setShowSortMenu: (show: boolean) => void;
+ /**
+ * Toggle the sort menu visibility.
+ */
+ toggleSortMenu: () => void;
+ /**
+ * Sort items based on current sort order.
+ */
+ sortItems: (items: Item[]) => Item[];
+}
+
+/**
+ * Hook to manage item sorting state and logic.
+ * Can be used by both the main items screen and folder view.
+ *
+ * @param initialSortOrder - Optional initial sort order (default: 'OldestFirst')
+ * @returns Sort state and functions
+ */
+export function useItemSort(initialSortOrder: CredentialSortOrder = 'OldestFirst'): UseItemSortReturn {
+ const [sortOrder, setSortOrder] = useState<CredentialSortOrder>(initialSortOrder);
+ const [showSortMenu, setShowSortMenu] = useState(false);
+
+ /**
+ * Toggle sort menu visibility.
+ */
+ const toggleSortMenu = useCallback(() => {
+ setShowSortMenu(prev => !prev);
+ }, []);
+
+ /**
+ * Sort items based on current sort order.
+ * Returns a new sorted array without mutating the original.
+ */
+ const sortItems = useCallback((items: Item[]): Item[] => {
+ const itemsCopy = [...items];
+ switch (sortOrder) {
+ case 'NewestFirst':
+ return itemsCopy.sort((a, b) =>
+ new Date(b.CreatedAt || 0).getTime() - new Date(a.CreatedAt || 0).getTime()
+ );
+ case 'Alphabetical':
+ return itemsCopy.sort((a, b) =>
+ (a.Name || '').localeCompare(b.Name || '')
+ );
+ case 'OldestFirst':
+ default:
+ return itemsCopy.sort((a, b) =>
+ new Date(a.CreatedAt || 0).getTime() - new Date(b.CreatedAt || 0).getTime()
+ );
+ }
+ }, [sortOrder]);
+
+ return {
+ sortOrder,
+ setSortOrder,
+ showSortMenu,
+ setShowSortMenu,
+ toggleSortMenu,
+ sortItems,
+ };
+}
+
+/**
+ * Hook to create memoized sorted items from filtered items.
+ * This is a convenience hook that combines useItemSort's sortItems with useMemo.
+ *
+ * @param filteredItems - The items to sort
+ * @param sortOrder - The sort order to apply
+ * @returns Memoized sorted items array
+ */
+export function useSortedItems(filteredItems: Item[], sortOrder: CredentialSortOrder): Item[] {
+ return useMemo(() => {
+ const itemsCopy = [...filteredItems];
+ switch (sortOrder) {
+ case 'NewestFirst':
+ return itemsCopy.sort((a, b) =>
+ new Date(b.CreatedAt || 0).getTime() - new Date(a.CreatedAt || 0).getTime()
+ );
+ case 'Alphabetical':
+ return itemsCopy.sort((a, b) =>
+ (a.Name || '').localeCompare(b.Name || '')
+ );
+ case 'OldestFirst':
+ default:
+ return itemsCopy.sort((a, b) =>
+ new Date(a.CreatedAt || 0).getTime() - new Date(b.CreatedAt || 0).getTime()
+ );
+ }
+ }, [filteredItems, sortOrder]);
+}