Skip to content

feat: ability to customize categories #1328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MrgSub merged 16 commits into from
Jun 18, 2025
Merged

feat: ability to customize categories #1328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
286ffbd
update locale
retrogtx Jun 17, 2025
18eeedc
introduce a new route
retrogtx Jun 17, 2025
e4fd349
Add categories settings and navigation in mail app
retrogtx Jun 17, 2025
d5054cb
add settings page for categories
retrogtx Jun 17, 2025
c971bce
remove slop comments
retrogtx Jun 17, 2025
4a9b9a7
Removed the in-file defaultCategories array and imported defaultMailC…
retrogtx Jun 17, 2025
987175f
If the value is empty or parses to NaN, the previous valid order is k…
retrogtx Jun 17, 2025
71806cf
Replaced the single-variable tuple assignment with explicit destructu…
retrogtx Jun 17, 2025
e54e6f2
Implement category order validation and sorting in settings page, uni…
retrogtx Jun 17, 2025
2496fa8
some prompts for the LLM incase the user wants to update the search q…
retrogtx Jun 18, 2025
43d28b2
new ui, add natural language query
retrogtx Jun 18, 2025
1d7ab5b
expose defaultMailCategories via tRPC and remove client-side duplicates
retrogtx Jun 18, 2025
e5815a8
Update example text
retrogtx Jun 18, 2025
5c6e293
Update Outlook search category mappings
retrogtx Jun 18, 2025
c5ddf1c
sync hotkeys everywhere
retrogtx Jun 18, 2025
9cd4a75
Merge branch 'staging' into customize-categories
retrogtx Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
248 changes: 248 additions & 0 deletions apps/mail/app/(routes)/settings/categories/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
import { useSettings } from '@/hooks/use-settings';
import { useMutation, useQueryClient, useQuery } from '@tanstack/react-query';
import { SettingsCard } from '@/components/settings/settings-card';
import { Button } from '@/components/ui/button';
import { Input } from '@/components/ui/input';
import { Switch } from '@/components/ui/switch';
import { Label } from '@/components/ui/label';
import { useState, useEffect } from 'react';
import { useTRPC } from '@/providers/query-provider';
import { toast } from 'sonner';
import type { CategorySetting } from '@/hooks/use-categories';
import { Popover, PopoverTrigger, PopoverContent } from '@/components/ui/popover';
import { Sparkles } from '@/components/icons/icons';
import { Loader } from 'lucide-react';
import { Badge } from '@/components/ui/badge';

export default function CategoriesSettingsPage() {
const { data } = useSettings();
const trpc = useTRPC();
const queryClient = useQueryClient();
const { mutateAsync: saveUserSettings, isPending } = useMutation(
trpc.settings.save.mutationOptions(),
);

const { mutateAsync: generateSearchQuery, isPending: isGeneratingQuery } = useMutation(
trpc.ai.generateSearchQuery.mutationOptions(),
);

const { data: defaultMailCategories = [] } = useQuery(
trpc.categories.defaults.queryOptions(void 0, { staleTime: Infinity }),
);

const [categories, setCategories] = useState<CategorySetting[]>([]);
const [activeAiCat, setActiveAiCat] = useState<string | null>(null);
const [promptValues, setPromptValues] = useState<Record<string, string>>({});

useEffect(() => {
if (!defaultMailCategories.length) return;

const stored = data?.settings?.categories ?? [];

const merged = defaultMailCategories.map((def) => {
const override = stored.find((c: { id: string }) => c.id === def.id);
return override ? { ...def, ...override } : def;
});

setCategories(merged.sort((a, b) => a.order - b.order));
}, [data, defaultMailCategories]);

const handleFieldChange = (id: string, field: keyof CategorySetting, value: any) => {
setCategories((prev) =>
prev.map((cat) => (cat.id === id ? { ...cat, [field]: value } : cat)),
);
};

const handleSave = async () => {
if (categories.filter((c) => c.isDefault).length !== 1) {
toast.error('Please mark exactly one category as default');
return;
}

const orderValues = categories.map((c) => c.order);
const hasDuplicateOrders = new Set(orderValues).size !== orderValues.length;
if (hasDuplicateOrders) {
toast.error('Each category must have a unique order number');
return;
}

const sortedCategories = [...categories].sort((a, b) => a.order - b.order);

try {
await saveUserSettings({ categories: sortedCategories });
queryClient.setQueryData(trpc.settings.get.queryKey(), (updater: any) => {
if (!updater) return;
return {
settings: { ...updater.settings, categories: sortedCategories },
};
});
setCategories(sortedCategories);
toast.success('Categories saved');
} catch (e) {
console.error(e);
toast.error('Failed to save');
}
};

if (!categories.length) {
return <div className="text-muted-foreground p-6">Loading...</div>;
}

return (
<div className="grid gap-6 max-w-[900px] mx-auto">
<SettingsCard
title="Mail Categories"
description="Customise how Zero shows the category tabs in your inbox."
footer={
<div className="px-6">
<Button type="button" disabled={isPending} onClick={handleSave}>
{isPending ? 'Saving…' : 'Save Changes'}
</Button>
</div>
}
>
<div className="space-y-4 px-6">
{categories.map((cat) => (
<div key={cat.id} className="rounded-lg border border-border bg-card p-4 shadow-sm">
<div className="flex items-center justify-between mb-2">
<div className="flex items-center gap-2">
<Badge variant="outline" className="text-xs font-normal bg-background">
{cat.id}
</Badge>
{cat.isDefault && (
<Badge className="bg-blue-500/10 text-blue-500 border-blue-200 text-xs">
Default
</Badge>
)}
</div>
<div className="flex items-center gap-2">
<Switch
id={`default-${cat.id}`}
checked={!!cat.isDefault}
onCheckedChange={(val) => {
const newCats = categories.map((c) => ({
...c,
isDefault: c.id === cat.id ? val : false,
}));
setCategories(newCats);
}}
/>
<Label htmlFor={`default-${cat.id}`} className="text-xs font-normal cursor-pointer">
Set as Default
</Label>
</div>
</div>

<div className="grid grid-cols-12 gap-4 items-start">
<div className="col-span-12 sm:col-span-5">
<Label className="text-xs mb-1.5 block">Display Name</Label>
<Input
className="h-8 text-sm"
value={cat.name}
onChange={(e) => handleFieldChange(cat.id, 'name', e.target.value)}
/>
</div>

<div className="col-span-12 sm:col-span-5">
<Label className="text-xs mb-1.5 block">Search Query</Label>
<div className="relative">
<Input
className="pr-8 h-8 text-sm font-mono"
value={cat.searchValue}
onChange={(e) => handleFieldChange(cat.id, 'searchValue', e.target.value)}
/>

<Popover
open={activeAiCat === cat.id}
onOpenChange={(open) => {
if (open) {
setActiveAiCat(cat.id);
} else {
setActiveAiCat(null);
}
}}
>
<PopoverTrigger asChild>
<button
type="button"
className="absolute right-2 top-1/2 -translate-y-1/2 bg-background hover:bg-secondary rounded-full p-1"
aria-label="Generate search query with AI"
>
{isGeneratingQuery && activeAiCat === cat.id ? (
<Loader className="h-3 w-3 animate-spin" />
) : (
<Sparkles className="h-3 w-3 fill-[#8B5CF6]" />
)}
</button>
</PopoverTrigger>
<PopoverContent className="w-80 p-3 space-y-3" sideOffset={4} align="end">
<div className="space-y-1">
<Label className="text-xs">Natural Language Query</Label>
<Input
className="h-8 text-sm"
placeholder="Describe the emails to include…"
value={promptValues[cat.id] ?? ''}
onChange={(e) =>
setPromptValues((prev) => ({ ...prev, [cat.id]: e.target.value }))
}
/>
</div>
<div className="text-xs text-muted-foreground">
Example: "emails that mention quarterly reports"
</div>
<Button
size="sm"
className="w-full"
disabled={!(promptValues[cat.id]?.trim()) || isGeneratingQuery}
onClick={async () => {
const prompt = promptValues[cat.id]?.trim();
if (!prompt) return;
try {
const res = await generateSearchQuery({ query: prompt });
handleFieldChange(cat.id, 'searchValue', res.query);
toast.success('Search query generated');
setActiveAiCat(null);
} catch (err) {
console.error(err);
toast.error('Failed to generate query');
}
}}
>
{isGeneratingQuery && activeAiCat === cat.id ? (
<Loader className="h-3 w-3 animate-spin mr-1" />
) : (
<Sparkles className="h-3 w-3 fill-white mr-1" />
)}
Generate Query
</Button>
</PopoverContent>
</Popover>
</div>
</div>

<div className="col-span-12 sm:col-span-2">
<Label className="text-xs mb-1.5 block">Order</Label>
<Input
type="number"
className="h-8 text-sm"
value={cat.order}
min={0}
onChange={(e) => {
const val = e.target.value;
const parsed = val === '' ? undefined : Number(val);
handleFieldChange(
cat.id,
'order',
parsed === undefined || Number.isNaN(parsed) ? cat.order : parsed,
);
}}
/>
</div>
</div>
</div>
))}
</div>
</SettingsCard>
</div>
);
}
33 changes: 28 additions & 5 deletions apps/mail/app/(routes)/settings/shortcuts/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { Button } from '@/components/ui/button';
import { useSession } from '@/lib/auth-client';
import { useTranslations } from 'use-intl';
import { toast } from 'sonner';
import { useCategorySettings } from '@/hooks/use-categories';

export default function ShortcutsPage() {
const t = useTranslations();
Expand All @@ -18,6 +19,7 @@ export default function ShortcutsPage() {
// TODO: Implement shortcuts syncing and caching
// updateShortcut,
} = useShortcutCache(session?.user?.id);
const categorySettings = useCategorySettings();

return (
<div className="grid gap-6">
Expand Down Expand Up @@ -57,11 +59,32 @@ export default function ShortcutsPage() {
{scope.split('-').join(' ')}
</h3>
<div className="grid grid-cols-1 gap-2 md:grid-cols-2">
{scopedShortcuts.map((shortcut, index) => (
<Shortcut key={`${scope}-${index}`} keys={shortcut.keys} action={shortcut.action}>
{t(`pages.settings.shortcuts.actions.${shortcut.action}` as MessageKey)}
</Shortcut>
))}
{scopedShortcuts.map((shortcut, index) => {
const categoryActionIndex: Record<string, number> = {
showImportant: 0,
showAllMail: 1,
showPersonal: 2,
showUpdates: 3,
showPromotions: 4,
showUnread: 5,
};

let label: string;

if (shortcut.action in categoryActionIndex && categorySettings.length) {
const idx = categoryActionIndex[shortcut.action];
const cat = categorySettings[idx];
label = cat ? `Show ${cat.name}` : t(`pages.settings.shortcuts.actions.${shortcut.action}` as MessageKey);
} else {
label = t(`pages.settings.shortcuts.actions.${shortcut.action}` as MessageKey);
}

return (
<Shortcut key={`${scope}-${index}`} keys={shortcut.keys} action={shortcut.action}>
{label}
</Shortcut>
);
})}
</div>
</div>
))}
Expand Down
1 change: 1 addition & 0 deletions apps/mail/app/routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export default [
route('/danger-zone', '(routes)/settings/danger-zone/page.tsx'),
route('/general', '(routes)/settings/general/page.tsx'),
route('/labels', '(routes)/settings/labels/page.tsx'),
route('/categories', '(routes)/settings/categories/page.tsx'),
route('/notifications', '(routes)/settings/notifications/page.tsx'),
route('/privacy', '(routes)/settings/privacy/page.tsx'),
route('/security', '(routes)/settings/security/page.tsx'),
Expand Down
Loading