navidrome/ui/src/layout/SubMenu.jsx
Deluan Quintão deaa5e6c02
feat(ui): playlist favourites (heart, list filter, sidebar favourites-only toggle) (#5805)
* feat(playlists): register starred REST filter on playlist repository

* feat(ui): add persisted sidebarPlaylistsOnlyFavourites setting

* feat(ui): playlist favourites heart column and list filter

* feat(ui): favourite heart on playlist details header

* feat(ui): sidebar favourites-only playlist toggle with live refresh

* fix(playlists): qualify id in REST filter to avoid ambiguous column

The annotation join in selectPlaylist made a bare id filter ambiguous, so
GET /api/playlist?id=X (react-admin getMany, used by the sidebar refetch and
useResourceRefresh) failed with 'ambiguous column name: id'. Register
idFilter("playlist") like the album/artist/mediafile repos.

* fix(ui): refresh favourites sidebar on local star toggle

The SSE broker skips the client that originated a star, so the acting client
never got the refreshResource echo and its favourites-only sidebar went stale.
Key the sidebar query on a fingerprint of locally-known starred playlists so a
star/unstar on this client refetches; SSE still covers other clients.

* style(ui): prettier-format PlaylistsSubMenu test

* feat(ui): refine playlist favourites layout

- Move the favourite heart column to just before the edit button
- Space the Playlists sidebar header text from its action icons
- Use a list icon instead of a cog for the playlist-management action

* feat(ui): make the playlist Favourite column toggleable

Move the heart into the toggleable fields map so users can show/hide it
from the column selector like the other optional columns, keeping it last
so it stays just before the edit button.

* refactor(ui): memoize sidebar star fingerprint and gate it on favourites-only

- Derive starFingerprint via useMemo on the playlist data reference instead
  of recomputing sort/join inside useSelector on every app-wide dispatch.
- Only include the fingerprint in the query payload when favourites-only is
  on, so a star toggle no longer refetches the sidebar when it shows all
  playlists.

* fix(ui): don't refetch favourites sidebar on SSE events when showing all

When favourites-only is off the sidebar shows every playlist, so a star
event from another client changes nothing visible. Gate the SSE-driven
refresh counter (and its payload key) on onlyFavourites so the sidebar no
longer redraws on unrelated playlist star events.

* fix(ui): address automated review feedback on playlist favourites

- Ignore a persisted favourites-only preference when EnableFavourites is off,
  so disabling the feature later can't strand a filtered sidebar (Codex P2).
- Make PlaylistLove's datagrid header props explicit (source/sortable via
  defaultProps, className forwarded) instead of relying on prop pass-through.
- Add aria-label to the SubMenu secondary action button.
- Cover the PlaylistLove list column with tests (Codex P1).
2026-07-18 14:45:47 -04:00

160 lines
3.9 KiB
JavaScript

import React, { Fragment } from 'react'
import { useDispatch } from 'react-redux'
import ExpandMore from '@material-ui/icons/ExpandMore'
import ArrowRightOutlined from '@material-ui/icons/ArrowRightOutlined'
import List from '@material-ui/core/List'
import MenuItem from '@material-ui/core/MenuItem'
import ListItemIcon from '@material-ui/core/ListItemIcon'
import Typography from '@material-ui/core/Typography'
import Collapse from '@material-ui/core/Collapse'
import Tooltip from '@material-ui/core/Tooltip'
import { makeStyles } from '@material-ui/core/styles'
import { setSidebarVisibility, useTranslate } from 'react-admin'
import { IconButton, useMediaQuery } from '@material-ui/core'
const useStyles = makeStyles(
(theme) => ({
icon: { minWidth: theme.spacing(5) },
sidebarIsOpen: {
'& a': {
transition: 'padding-left 195ms cubic-bezier(0.4, 0, 0.6, 1) 0ms',
paddingLeft: theme.spacing(4),
},
},
sidebarIsClosed: {
'& a': {
transition: 'padding-left 195ms cubic-bezier(0.4, 0, 0.6, 1) 0ms',
paddingLeft: theme.spacing(2),
},
},
actionIcon: {
opacity: 0,
},
menuHeader: {
width: '100%',
},
headerText: {
flexGrow: 1,
},
headerWrapper: {
display: 'flex',
'&:hover $actionIcon': {
opacity: 1,
},
},
}),
{
name: 'NDSubMenu',
},
)
const SubMenu = ({
handleToggle,
sidebarIsOpen,
isOpen,
name,
icon,
children,
dense,
onAction,
actionIcon,
onSecondaryAction,
secondaryActionIcon,
secondaryActionTitle,
secondaryActionActive,
}) => {
const translate = useTranslate()
const classes = useStyles()
const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('sm'))
const isSmall = useMediaQuery((theme) => theme.breakpoints.down('sm'))
const dispatch = useDispatch()
const handleOnClick = (e) => {
e.stopPropagation()
onAction(e)
if (isSmall) {
dispatch(setSidebarVisibility(false))
}
}
const handleSecondaryClick = (e) => {
e.stopPropagation()
onSecondaryAction(e)
}
const header = (
<div className={classes.headerWrapper}>
<MenuItem
dense={dense}
button
className={classes.menuHeader}
onClick={handleToggle}
>
<ListItemIcon className={classes.icon}>
{isOpen ? <ExpandMore /> : icon}
</ListItemIcon>
<Typography
variant="inherit"
color="textSecondary"
className={classes.headerText}
>
{translate(name)}
</Typography>
{onSecondaryAction && sidebarIsOpen && (
<IconButton
size={'small'}
title={secondaryActionTitle}
aria-label={secondaryActionTitle}
className={
isDesktop && !secondaryActionActive ? classes.actionIcon : null
}
onClick={handleSecondaryClick}
>
{secondaryActionIcon}
</IconButton>
)}
{onAction && sidebarIsOpen && (
<IconButton
size={'small'}
className={isDesktop ? classes.actionIcon : null}
onClick={handleOnClick}
>
{actionIcon}
</IconButton>
)}
</MenuItem>
</div>
)
return (
<Fragment>
{sidebarIsOpen || isOpen ? (
header
) : (
<Tooltip title={translate(name)} placement="right">
{header}
</Tooltip>
)}
<Collapse in={isOpen} timeout="auto" unmountOnExit>
<List
dense={dense}
component="div"
disablePadding
className={
sidebarIsOpen ? classes.sidebarIsOpen : classes.sidebarIsClosed
}
>
{children}
</List>
</Collapse>
</Fragment>
)
}
SubMenu.defaultProps = {
action: null,
actionIcon: <ArrowRightOutlined fontSize={'small'} />,
}
export default SubMenu