feat: add sidebar layout settings with drag-and-drop functionality and import/export options

This commit is contained in:
2025-07-10 16:56:00 +00:00
committed by GitHub
parent 5653460e06
commit 59aae6ea31
3 changed files with 422 additions and 0 deletions

View File

@@ -0,0 +1,238 @@
'use client';
import { useState } from 'react';
import { Button } from '@/components/ui/button';
import { Switch } from '@/components/ui/switch';
import { Card, CardContent, CardHeader, CardTitle } from '@/components/ui/card';
import { Label } from '@/components/ui/label';
import { Input } from '@/components/ui/input';
import { useSidebarLayout, SidebarItem } from '@/hooks/use-sidebar-layout';
import { GripVertical, Eye, EyeOff, Download, Upload, RotateCcw } from 'lucide-react';
interface DraggableSidebarItemProps {
item: SidebarItem;
index: number;
onToggleVisibility: (itemId: string) => void;
onDragStart: (e: React.DragEvent, index: number) => void;
onDragOver: (e: React.DragEvent) => void;
onDrop: (e: React.DragEvent, dropIndex: number) => void;
}
function DraggableSidebarItem({
item,
index,
onToggleVisibility,
onDragStart,
onDragOver,
onDrop,
}: DraggableSidebarItemProps) {
return (
<div
draggable
onDragStart={(e) => onDragStart(e, index)}
onDragOver={onDragOver}
onDrop={(e) => onDrop(e, index)}
className="flex items-center gap-3 p-3 border rounded-lg hover:bg-accent/50 cursor-move"
>
<GripVertical className="h-4 w-4 text-muted-foreground" />
<div className="flex-1">
<span className={`${item.visible ? '' : 'text-muted-foreground line-through'}`}>
{item.label}
</span>
</div>
<Button
variant="ghost"
size="sm"
onClick={() => onToggleVisibility(item.id)}
className="h-8 w-8 p-0"
>
{item.visible ? (
<Eye className="h-4 w-4" />
) : (
<EyeOff className="h-4 w-4" />
)}
</Button>
</div>
);
}
export function SidebarLayoutSettings() {
const {
settings,
updateItemOrder,
toggleItemVisibility,
updateShortcuts,
updateShowIcons,
exportSettings,
importSettings,
resetToDefaults,
} = useSidebarLayout();
const [draggedIndex, setDraggedIndex] = useState<number | null>(null);
const [importing, setImporting] = useState(false);
const handleDragStart = (e: React.DragEvent, index: number) => {
setDraggedIndex(index);
e.dataTransfer.effectAllowed = 'move';
};
const handleDragOver = (e: React.DragEvent) => {
e.preventDefault();
e.dataTransfer.dropEffect = 'move';
};
const handleDrop = (e: React.DragEvent, dropIndex: number) => {
e.preventDefault();
if (draggedIndex === null || draggedIndex === dropIndex) {
setDraggedIndex(null);
return;
}
const newItems = [...settings.items];
const draggedItem = newItems[draggedIndex];
// Remove the dragged item
newItems.splice(draggedIndex, 1);
// Insert it at the new position
newItems.splice(dropIndex, 0, draggedItem);
updateItemOrder(newItems);
setDraggedIndex(null);
};
const handleFileImport = async (e: React.ChangeEvent<HTMLInputElement>) => {
const file = e.target.files?.[0];
if (!file) return;
setImporting(true);
try {
await importSettings(file);
// Reset the file input
e.target.value = '';
} catch (error) {
console.error('Failed to import settings:', error);
alert('Failed to import settings. Please check the file format.');
} finally {
setImporting(false);
}
};
return (
<div className="space-y-6">
{/* General Settings */}
<Card>
<CardHeader>
<CardTitle>Sidebar Display</CardTitle>
</CardHeader>
<CardContent className="space-y-4">
<div className="flex items-center justify-between">
<Label htmlFor="show-icons">Show Icons</Label>
<Switch
id="show-icons"
checked={settings.showIcons}
onCheckedChange={updateShowIcons}
/>
</div>
<div className="space-y-2">
<Label>Sidebar Shortcuts</Label>
<div className="flex gap-2">
<Button
variant={settings.shortcuts === 'albums' ? 'default' : 'outline'}
size="sm"
onClick={() => updateShortcuts('albums')}
>
Albums Only
</Button>
<Button
variant={settings.shortcuts === 'playlists' ? 'default' : 'outline'}
size="sm"
onClick={() => updateShortcuts('playlists')}
>
Playlists Only
</Button>
<Button
variant={settings.shortcuts === 'both' ? 'default' : 'outline'}
size="sm"
onClick={() => updateShortcuts('both')}
>
Both
</Button>
</div>
</div>
</CardContent>
</Card>
{/* Item Order and Visibility */}
<Card>
<CardHeader>
<CardTitle>Navigation Items</CardTitle>
<p className="text-sm text-muted-foreground">
Drag items to reorder them, click the eye icon to show/hide items
</p>
</CardHeader>
<CardContent>
<div className="space-y-2">
{settings.items.map((item, index) => (
<DraggableSidebarItem
key={item.id}
item={item}
index={index}
onToggleVisibility={toggleItemVisibility}
onDragStart={handleDragStart}
onDragOver={handleDragOver}
onDrop={handleDrop}
/>
))}
</div>
</CardContent>
</Card>
{/* Import/Export Settings */}
<Card>
<CardHeader>
<CardTitle>Settings Management</CardTitle>
</CardHeader>
<CardContent className="space-y-4">
<div className="flex gap-2">
<Button onClick={exportSettings} variant="outline" className="flex-1">
<Download className="h-4 w-4 mr-2" />
Export Settings
</Button>
<div className="flex-1">
<Input
type="file"
accept=".json"
onChange={handleFileImport}
disabled={importing}
className="hidden"
id="import-settings"
/>
<Button
variant="outline"
className="w-full"
disabled={importing}
onClick={() => document.getElementById('import-settings')?.click()}
>
<Upload className="h-4 w-4 mr-2" />
{importing ? 'Importing...' : 'Import Settings'}
</Button>
</div>
</div>
<Button
onClick={resetToDefaults}
variant="destructive"
className="w-full"
>
<RotateCcw className="h-4 w-4 mr-2" />
Reset to Defaults
</Button>
</CardContent>
</Card>
</div>
);
}

View File

@@ -12,6 +12,7 @@ import { ChevronLeft, ChevronRight } from "lucide-react";
import { useNavidrome } from "./NavidromeContext";
import { useRecentlyPlayedAlbums } from "@/hooks/use-recently-played-albums";
import { useSidebarShortcuts } from "@/hooks/use-sidebar-shortcuts";
import { useSidebarLayout, SidebarItemType } from "@/hooks/use-sidebar-layout";
import {
ContextMenu,
ContextMenuContent,

183
hooks/use-sidebar-layout.ts Normal file
View File

@@ -0,0 +1,183 @@
'use client';
import { useState, useEffect } from 'react';
export type SidebarItemType =
| 'search'
| 'home'
| 'queue'
| 'radio'
| 'artists'
| 'albums'
| 'playlists'
| 'favorites'
| 'browse'
| 'songs'
| 'history'
| 'settings';
export interface SidebarItem {
id: SidebarItemType;
label: string;
visible: boolean;
icon: string; // We'll use this for icon identification
}
export interface SidebarLayoutSettings {
items: SidebarItem[];
shortcuts: 'albums' | 'playlists' | 'both';
showIcons: boolean;
}
const defaultSidebarItems: SidebarItem[] = [
{ id: 'search', label: 'Search', visible: true, icon: 'search' },
{ id: 'home', label: 'Home', visible: true, icon: 'home' },
{ id: 'queue', label: 'Queue', visible: true, icon: 'queue' },
{ id: 'radio', label: 'Radio', visible: true, icon: 'radio' },
{ id: 'artists', label: 'Artists', visible: true, icon: 'artists' },
{ id: 'albums', label: 'Albums', visible: true, icon: 'albums' },
{ id: 'playlists', label: 'Playlists', visible: true, icon: 'playlists' },
{ id: 'favorites', label: 'Favorites', visible: true, icon: 'favorites' },
{ id: 'browse', label: 'Browse', visible: true, icon: 'browse' },
{ id: 'songs', label: 'Songs', visible: true, icon: 'songs' },
{ id: 'history', label: 'History', visible: true, icon: 'history' },
{ id: 'settings', label: 'Settings', visible: true, icon: 'settings' },
];
const defaultSettings: SidebarLayoutSettings = {
items: defaultSidebarItems,
shortcuts: 'both',
showIcons: true,
};
export function useSidebarLayout() {
const [settings, setSettings] = useState<SidebarLayoutSettings>(defaultSettings);
// Load settings from localStorage on mount
useEffect(() => {
const saved = localStorage.getItem('sidebar-layout-settings');
if (saved) {
try {
const parsed = JSON.parse(saved);
// Merge with defaults to ensure all items are present
const mergedItems = defaultSidebarItems.map(defaultItem => {
const savedItem = parsed.items?.find((item: SidebarItem) => item.id === defaultItem.id);
return savedItem ? { ...defaultItem, ...savedItem } : defaultItem;
});
setSettings({
items: mergedItems,
shortcuts: parsed.shortcuts || defaultSettings.shortcuts,
showIcons: parsed.showIcons !== undefined ? parsed.showIcons : defaultSettings.showIcons,
});
} catch (error) {
console.error('Failed to parse sidebar layout settings:', error);
}
}
}, []);
// Save settings to localStorage whenever they change
useEffect(() => {
localStorage.setItem('sidebar-layout-settings', JSON.stringify(settings));
}, [settings]);
const updateItemOrder = (newItems: SidebarItem[]) => {
setSettings(prev => ({ ...prev, items: newItems }));
};
const toggleItemVisibility = (itemId: SidebarItemType) => {
setSettings(prev => ({
...prev,
items: prev.items.map(item =>
item.id === itemId ? { ...item, visible: !item.visible } : item
),
}));
};
const updateShortcuts = (shortcuts: 'albums' | 'playlists' | 'both') => {
setSettings(prev => ({ ...prev, shortcuts }));
};
const updateShowIcons = (showIcons: boolean) => {
setSettings(prev => ({ ...prev, showIcons }));
};
const exportSettings = () => {
const allSettings = {
sidebarLayout: settings,
sidebarVisible: localStorage.getItem('sidebar-visible'),
theme: localStorage.getItem('theme'),
// Add other settings as needed
};
const blob = new Blob([JSON.stringify(allSettings, null, 2)], {
type: 'application/json'
});
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = `stillnavidrome-settings-${new Date().toISOString().split('T')[0]}.json`;
document.body.appendChild(a);
a.click();
document.body.removeChild(a);
URL.revokeObjectURL(url);
};
const importSettings = (file: File) => {
return new Promise<void>((resolve, reject) => {
const reader = new FileReader();
reader.onload = (e) => {
try {
const imported = JSON.parse(e.target?.result as string);
if (imported.sidebarLayout) {
const mergedItems = defaultSidebarItems.map(defaultItem => {
const importedItem = imported.sidebarLayout.items?.find(
(item: SidebarItem) => item.id === defaultItem.id
);
return importedItem ? { ...defaultItem, ...importedItem } : defaultItem;
});
setSettings({
items: mergedItems,
shortcuts: imported.sidebarLayout.shortcuts || defaultSettings.shortcuts,
showIcons: imported.sidebarLayout.showIcons !== undefined
? imported.sidebarLayout.showIcons
: defaultSettings.showIcons,
});
}
if (imported.sidebarVisible !== undefined) {
localStorage.setItem('sidebar-visible', imported.sidebarVisible);
}
if (imported.theme) {
localStorage.setItem('theme', imported.theme);
}
resolve();
} catch (error) {
reject(error);
}
};
reader.onerror = () => reject(new Error('Failed to read file'));
reader.readAsText(file);
});
};
const resetToDefaults = () => {
setSettings(defaultSettings);
};
return {
settings,
updateItemOrder,
toggleItemVisibility,
updateShortcuts,
updateShowIcons,
exportSettings,
importSettings,
resetToDefaults,
};
}