support multiple viewmodes for UI options and menus

This commit is contained in:
spacebares 2023-06-27 17:27:49 -04:00
parent 160e9ba336
commit fff14f7dc6
13 changed files with 93 additions and 65 deletions

View File

@ -67,6 +67,12 @@ class DateTimeStyleEnum(str, Enum):
short = "short" short = "short"
class ViewModeEnum(str, Enum):
user = "user"
advanced = "advanced"
admin = "admin"
class UIConfig(FrigateBaseModel): class UIConfig(FrigateBaseModel):
live_mode: LiveModeEnum = Field( live_mode: LiveModeEnum = Field(
default=LiveModeEnum.mse, title="Default Live Mode." default=LiveModeEnum.mse, title="Default Live Mode."
@ -85,9 +91,9 @@ class UIConfig(FrigateBaseModel):
strftime_fmt: Optional[str] = Field( strftime_fmt: Optional[str] = Field(
default=None, title="Override date and time format using strftime syntax." default=None, title="Override date and time format using strftime syntax."
) )
show_advanced_options: bool = Field( viewmode: ViewModeEnum = Field(
default=True, default=ViewModeEnum.admin,
title="Default setting to show Advanced Options, such as Config, Camera Rec/Motion/Snap buttons, go2rtc dashboard and more.", title="Default setting to display or hide certain options and menus in Frigate.",
) )

View File

@ -8,15 +8,16 @@ import DarkModeIcon from './icons/DarkMode';
import SettingsIcon from './icons/Settings'; import SettingsIcon from './icons/Settings';
import FrigateRestartIcon from './icons/FrigateRestart'; import FrigateRestartIcon from './icons/FrigateRestart';
import Prompt from './components/Prompt'; import Prompt from './components/Prompt';
import { useDarkMode, useAdvOptions } from './context'; import { useDarkMode, useViewMode } from './context';
import { useCallback, useRef, useState } from 'preact/hooks'; import { useCallback, useRef, useState } from 'preact/hooks';
import { useRestart } from './api/ws'; import { useRestart } from './api/ws';
import { ViewModeTypes } from './components/ViewOptionEnum'
export default function AppBar() { export default function AppBar() {
const [showMoreMenu, setShowMoreMenu] = useState(false); const [showMoreMenu, setShowMoreMenu] = useState(false);
const [showDialog, setShowDialog] = useState(false); const [showDialog, setShowDialog] = useState(false);
const [showDialogWait, setShowDialogWait] = useState(false); const [showDialogWait, setShowDialogWait] = useState(false);
const { showAdvOptions, setShowAdvOptions } = useAdvOptions(); const { viewMode, setViewMode } = useViewMode();
const { setDarkMode } = useDarkMode(); const { setDarkMode } = useDarkMode();
const { send: sendRestart } = useRestart(); const { send: sendRestart } = useRestart();
@ -28,10 +29,13 @@ export default function AppBar() {
[setDarkMode, setShowMoreMenu] [setDarkMode, setShowMoreMenu]
); );
const handleToggleAdvOptions = useCallback(() => { const handleSetViewMode = useCallback(
setShowAdvOptions(showAdvOptions === 1 ? 0 : 1); (value) => {
setViewMode(value);
setShowMoreMenu(false); setShowMoreMenu(false);
},[showAdvOptions, setShowAdvOptions, setShowMoreMenu]); },
[setViewMode, setShowMoreMenu]
);
const moreRef = useRef(null); const moreRef = useRef(null);
@ -68,7 +72,15 @@ export default function AppBar() {
<MenuItem icon={LightModeIcon} label="Light" value="light" onSelect={handleSelectDarkMode} /> <MenuItem icon={LightModeIcon} label="Light" value="light" onSelect={handleSelectDarkMode} />
<MenuItem icon={DarkModeIcon} label="Dark" value="dark" onSelect={handleSelectDarkMode} /> <MenuItem icon={DarkModeIcon} label="Dark" value="dark" onSelect={handleSelectDarkMode} />
<MenuSeparator /> <MenuSeparator />
<MenuItem icon={SettingsIcon} label={showAdvOptions ? 'Hide Adv. Options' : 'Show Adv. Options'} onSelect={handleToggleAdvOptions} /> <MenuItem icon={SettingsIcon} label="View:">
<select
className="flex flex-grow p-0 py-7 px-8"
value={viewMode}
onChange={(e) => handleSetViewMode(e.target.value)}
>
{ Object.keys(ViewModeTypes).filter((v) => !isNaN(Number(v))).map(key => <option key={key} value={key}>{ViewModeTypes[key]}</option>) }
</select>
</MenuItem>
<MenuSeparator /> <MenuSeparator />
<MenuItem icon={FrigateRestartIcon} label="Restart Frigate" onSelect={handleRestart} /> <MenuItem icon={FrigateRestartIcon} label="Restart Frigate" onSelect={handleRestart} />
</Menu> </Menu>

View File

@ -4,13 +4,12 @@ import { Match } from 'preact-router/match';
import { memo } from 'preact/compat'; import { memo } from 'preact/compat';
import { ENV } from './env'; import { ENV } from './env';
import { useMemo } from 'preact/hooks' import { useMemo } from 'preact/hooks'
import { useAdvOptions } from './context'; import ViewOption from './components/ViewOption'
import useSWR from 'swr'; import useSWR from 'swr';
import NavigationDrawer, { Destination, Separator } from './components/NavigationDrawer'; import NavigationDrawer, { Destination, Separator } from './components/NavigationDrawer';
export default function Sidebar() { export default function Sidebar() {
const { data: config } = useSWR('config'); const { data: config } = useSWR('config');
const { showAdvOptions } = useAdvOptions();
const sortedCameras = useMemo(() => { const sortedCameras = useMemo(() => {
if (!config) { if (!config) {
@ -48,11 +47,17 @@ export default function Sidebar() {
<Destination href="/events" text="Events" /> <Destination href="/events" text="Events" />
<Destination href="/exports" text="Exports" /> <Destination href="/exports" text="Exports" />
<Separator /> <Separator />
<ViewOption requiredmode="advanced">
<Destination href="/storage" text="Storage" /> <Destination href="/storage" text="Storage" />
<Destination href="/system" text="System" /> <Destination href="/system" text="System" />
{ showAdvOptions ? <Destination href="/config" text="Config" /> : null} </ViewOption>
<ViewOption requiredmode="admin">
<Destination href="/config" text="Config" />
</ViewOption>
<ViewOption requiredmode="advanced">
<Destination href="/logs" text="Logs" /> <Destination href="/logs" text="Logs" />
<Separator /> <Separator />
</ViewOption>
<div className="flex flex-grow" /> <div className="flex flex-grow" />
{ENV !== 'production' ? ( {ENV !== 'production' ? (
<Fragment> <Fragment>

View File

@ -6,7 +6,7 @@ import AppBar from './AppBar';
import Cameras from './routes/Cameras'; import Cameras from './routes/Cameras';
import { Router } from 'preact-router'; import { Router } from 'preact-router';
import Sidebar from './Sidebar'; import Sidebar from './Sidebar';
import { DarkModeProvider, DrawerProvider, AdvOptionsProvider } from './context'; import { DarkModeProvider, DrawerProvider, ViewModeProvider } from './context';
import useSWR from 'swr'; import useSWR from 'swr';
export default function App() { export default function App() {
@ -16,7 +16,7 @@ export default function App() {
return ( return (
<DarkModeProvider> <DarkModeProvider>
<DrawerProvider> <DrawerProvider>
<AdvOptionsProvider> <ViewModeProvider>
<div data-testid="app" className="w-full"> <div data-testid="app" className="w-full">
{!config ? ( {!config ? (
<div className="flex flex-grow-1 min-h-screen justify-center items-center"> <div className="flex flex-grow-1 min-h-screen justify-center items-center">
@ -48,7 +48,7 @@ export default function App() {
</div> </div>
)} )}
</div> </div>
</AdvOptionsProvider> </ViewModeProvider>
</DrawerProvider> </DrawerProvider>
</DarkModeProvider> </DarkModeProvider>
); );

View File

@ -2,8 +2,7 @@ import { h } from 'preact';
import Button from './Button'; import Button from './Button';
import MenuIcon from '../icons/Menu'; import MenuIcon from '../icons/Menu';
import MoreIcon from '../icons/More'; import MoreIcon from '../icons/More';
import { About } from '../icons/About'; import { useDrawer } from '../context';
import { useDrawer, useAdvOptions } from '../context';
import { useLayoutEffect, useCallback, useState } from 'preact/hooks'; import { useLayoutEffect, useCallback, useState } from 'preact/hooks';
// We would typically preserve these in component state // We would typically preserve these in component state
@ -14,7 +13,6 @@ export default function AppBar({ title: Title, overflowRef, onOverflowClick }) {
const [show, setShow] = useState(true); const [show, setShow] = useState(true);
const [atZero, setAtZero] = useState(window.scrollY === 0); const [atZero, setAtZero] = useState(window.scrollY === 0);
const { setShowDrawer } = useDrawer(); const { setShowDrawer } = useDrawer();
const { showAdvOptions } = useAdvOptions();
const scrollListener = useCallback(() => { const scrollListener = useCallback(() => {
const scrollY = window.scrollY; const scrollY = window.scrollY;
@ -52,19 +50,6 @@ export default function AppBar({ title: Title, overflowRef, onOverflowClick }) {
</div> </div>
<Title /> <Title />
<div className="flex-grow-1 flex justify-end w-full"> <div className="flex-grow-1 flex justify-end w-full">
{ !showAdvOptions ?
<Button
className="rounded-full"
type="text"
color="gray"
aria-label="Advanced Options are hidden via the nearby menu."
>
<About className="w-6" />
</Button>
: null
}
</div>
<div className="flex-grow-1 flex">
{overflowRef && onOverflowClick ? ( {overflowRef && onOverflowClick ? (
<div className="w-auto" ref={overflowRef}> <div className="w-auto" ref={overflowRef}>
<Button <Button

View File

@ -16,7 +16,7 @@ export default function Menu({ className, children, onDismiss, relativeTo, width
) : null; ) : null;
} }
export function MenuItem({ focus, icon: Icon, label, href, onSelect, value, ...attrs }) { export function MenuItem({ children, focus, icon: Icon, label, href, onSelect, value, ...attrs }) {
const handleClick = useCallback(() => { const handleClick = useCallback(() => {
onSelect && onSelect(value, label); onSelect && onSelect(value, label);
}, [onSelect, value, label]); }, [onSelect, value, label]);
@ -39,6 +39,7 @@ export function MenuItem({ focus, icon: Icon, label, href, onSelect, value, ...a
</div> </div>
) : null} ) : null}
<div className="whitespace-nowrap">{label}</div> <div className="whitespace-nowrap">{label}</div>
{children}
</Element> </Element>
); );
} }

View File

@ -0,0 +1,12 @@
import { h } from 'preact';
import { useViewMode } from '../context';
import { ViewModeTypes } from './ViewOptionEnum';
export default function ViewOption({children, requiredmode }) {
const { viewMode } = useViewMode();
return viewMode >= ViewModeTypes[requiredmode] ? (
<>{children}</>
) : null;
}

View File

@ -0,0 +1,5 @@
export enum ViewModeTypes {
"user",
"advanced",
"admin",
}

View File

@ -1,28 +1,29 @@
import { h, createContext } from 'preact'; import { h, createContext } from 'preact';
import { get as getData, set as setData } from 'idb-keyval'; import { get as getData, set as setData } from 'idb-keyval';
import { useCallback, useContext, useEffect, useLayoutEffect, useState } from 'preact/hooks'; import { useCallback, useContext, useEffect, useLayoutEffect, useState } from 'preact/hooks';
import { ViewModeTypes } from '../components/ViewOptionEnum';
import useSWR from 'swr'; import useSWR from 'swr';
const AdvOptions = createContext(null); const ViewMode = createContext(null);
export function AdvOptionsProvider({ children }) { export function ViewModeProvider({ children }) {
const [showAdvOptions, setShowAdvOptions] = usePersistence('show-advanced-options', null); const [viewMode, setViewMode] = usePersistence('view-mode', null);
const { data: config } = useSWR('config'); const { data: config } = useSWR('config');
useEffect(() => { useEffect(() => {
async function load() { async function load() {
const configValue = config.ui.show_advanced_options == true? 1 : 0; //fixes a load error const configValue = ViewModeTypes[config.ui.viewmode]; //fixes a load error
setShowAdvOptions(showAdvOptions || configValue); setViewMode(viewMode || configValue);
} }
load(); load();
}, [setShowAdvOptions, config]); }, [setViewMode, config]);
return <AdvOptions.Provider value={{ showAdvOptions, setShowAdvOptions }}>{children}</AdvOptions.Provider>; return <ViewMode.Provider value={{ viewMode, setViewMode }}>{children}</ViewMode.Provider>;
} }
export function useAdvOptions() { export function useViewMode() {
return useContext(AdvOptions); return useContext(ViewMode);
} }
const DarkMode = createContext(null); const DarkMode = createContext(null);

View File

@ -9,7 +9,7 @@ import Link from '../components/Link';
import SettingsIcon from '../icons/Settings'; import SettingsIcon from '../icons/Settings';
import Switch from '../components/Switch'; import Switch from '../components/Switch';
import ButtonsTabbed from '../components/ButtonsTabbed'; import ButtonsTabbed from '../components/ButtonsTabbed';
import { usePersistence, useAdvOptions } from '../context'; import { usePersistence } from '../context';
import { useCallback, useMemo, useState } from 'preact/hooks'; import { useCallback, useMemo, useState } from 'preact/hooks';
import { useApiHost } from '../api'; import { useApiHost } from '../api';
import useSWR from 'swr'; import useSWR from 'swr';
@ -17,6 +17,7 @@ import WebRtcPlayer from '../components/WebRtcPlayer';
import '../components/MsePlayer'; import '../components/MsePlayer';
import CameraControlPanel from '../components/CameraControlPanel'; import CameraControlPanel from '../components/CameraControlPanel';
import { baseUrl } from '../api/baseUrl'; import { baseUrl } from '../api/baseUrl';
import ViewOption from '../components/ViewOption'
const emptyObject = Object.freeze({}); const emptyObject = Object.freeze({});
@ -25,7 +26,6 @@ export default function Camera({ camera }) {
const apiHost = useApiHost(); const apiHost = useApiHost();
const [showSettings, setShowSettings] = useState(false); const [showSettings, setShowSettings] = useState(false);
const [viewMode, setViewMode] = useState('live'); const [viewMode, setViewMode] = useState('live');
const { showAdvOptions } = useAdvOptions();
const cameraConfig = config?.cameras[camera]; const cameraConfig = config?.cameras[camera];
const restreamEnabled = const restreamEnabled =
@ -109,7 +109,9 @@ export default function Camera({ camera }) {
label="Regions" label="Regions"
labelPosition="after" labelPosition="after"
/> />
{showAdvOptions ? <Link href={`/cameras/${camera}/editor`}>Mask & Zone creator</Link> : null} <ViewOption requiredmode="admin">
<Link href={`/cameras/${camera}/editor`}>Mask & Zone creator</Link>
</ViewOption>
</div> </div>
) : null; ) : null;

View File

@ -7,7 +7,8 @@ import MotionIcon from '../icons/Motion';
import SnapshotIcon from '../icons/Snapshot'; import SnapshotIcon from '../icons/Snapshot';
import { useDetectState, useRecordingsState, useSnapshotsState } from '../api/ws'; import { useDetectState, useRecordingsState, useSnapshotsState } from '../api/ws';
import { useMemo } from 'preact/hooks'; import { useMemo } from 'preact/hooks';
import { useAdvOptions } from '../context'; import { useViewMode } from '../context'
import { ViewModeTypes } from '../components/ViewOptionEnum';
import useSWR from 'swr'; import useSWR from 'swr';
export default function Cameras() { export default function Cameras() {
@ -87,9 +88,9 @@ function Camera({ name, config }) {
[config, detectValue, sendDetect, recordValue, sendRecordings, snapshotValue, sendSnapshots] [config, detectValue, sendDetect, recordValue, sendRecordings, snapshotValue, sendSnapshots]
); );
const { showAdvOptions } = useAdvOptions(); const { viewMode } = useViewMode();
return ( return (
<Card buttons={buttons} href={href} header={cleanName} icons={showAdvOptions ? icons : []} media={<CameraImage camera={name} stretch />} /> <Card buttons={buttons} href={href} header={cleanName} icons={viewMode >= ViewModeTypes["admin"] ? icons : []} media={<CameraImage camera={name} stretch />} />
); );
} }

View File

@ -29,7 +29,7 @@ import { formatUnixTimestampToDateTime, getDurationFromTimestamps } from '../uti
import TimeAgo from '../components/TimeAgo'; import TimeAgo from '../components/TimeAgo';
import Timepicker from '../components/TimePicker'; import Timepicker from '../components/TimePicker';
import TimelineSummary from '../components/TimelineSummary'; import TimelineSummary from '../components/TimelineSummary';
import { useAdvOptions } from '../context'; import ViewOption from '../components/ViewOption';
const API_LIMIT = 25; const API_LIMIT = 25;
@ -46,7 +46,6 @@ const monthsAgo = (num) => {
}; };
export default function Events({ path, ...props }) { export default function Events({ path, ...props }) {
const { showAdvOptions } = useAdvOptions();
const apiHost = useApiHost(); const apiHost = useApiHost();
const [searchParams, setSearchParams] = useState({ const [searchParams, setSearchParams] = useState({
before: null, before: null,
@ -662,12 +661,13 @@ export default function Events({ path, ...props }) {
)} )}
</div> </div>
<div class="flex flex-col"> <div class="flex flex-col">
<ViewOption requiredmode="admin">
<Delete <Delete
className="h-6 w-6 cursor-pointer" className="h-6 w-6 cursor-pointer"
stroke={showAdvOptions ? "#f87171" : "lightgrey"} stroke="#f87171"
onClick={showAdvOptions ? (e) => onDelete(e, event.id, event.retain_indefinitely) : null} onClick={(e) => onDelete(e, event.id, event.retain_indefinitely)}
aria-label="Advanced Options are hidden via the nearby menu."
/> />
</ViewOption>
<Download <Download
className="h-6 w-6 mt-auto" className="h-6 w-6 mt-auto"

View File

@ -12,14 +12,13 @@ import Dialog from '../components/Dialog';
import TimeAgo from '../components/TimeAgo'; import TimeAgo from '../components/TimeAgo';
import copy from 'copy-to-clipboard'; import copy from 'copy-to-clipboard';
import { About } from '../icons/About'; import { About } from '../icons/About';
import { useAdvOptions } from '../context'; import ViewOption from '../components/ViewOption';
const emptyObject = Object.freeze({}); const emptyObject = Object.freeze({});
export default function System() { export default function System() {
const [state, setState] = useState({ showFfprobe: false, ffprobe: '' }); const [state, setState] = useState({ showFfprobe: false, ffprobe: '' });
const { data: config } = useSWR('config'); const { data: config } = useSWR('config');
const { showAdvOptions } = useAdvOptions();
const { const {
value: { payload: stats }, value: { payload: stats },
@ -100,7 +99,7 @@ export default function System() {
{config && ( {config && (
<span class="p-1"> <span class="p-1">
go2rtc {go2rtc && `${go2rtc.version} `} go2rtc {go2rtc && `${go2rtc.version} `}
{showAdvOptions ? <ViewOption requiredmode="admin">
<Link <Link
className="text-blue-500 hover:underline" className="text-blue-500 hover:underline"
target="_blank" target="_blank"
@ -109,8 +108,7 @@ export default function System() {
> >
dashboard dashboard
</Link> </Link>
: null </ViewOption>
}
</span> </span>
)} )}
</div> </div>