🎧 Your Personal Streaming Service
Go airsonicmadsonicmedia-servermusicmusic-servernavidromeopensubsonicraspberry-piself-hostedstreamerstreaming-apistreaming-audiosubsonicsubsonic-server
Help dialog with available hotkeys
Deluan847531391dab
diff --git a/ui/src/album/AlbumList.js b/ui/src/album/AlbumList.jsindex dd90fce88..10ed0860c 100644--- a/ui/src/album/AlbumList.js+++ b/ui/src/album/AlbumList.js@@ -17,7 +17,7 @@ import { List, QuickFilter, Title, useAlbumsPerPage } from '../common'import AlbumListActions from './AlbumListActions'import AlbumListView from './AlbumListView'import AlbumGridView from './AlbumGridView'-import AddToPlaylistDialog from '../dialogs/AddToPlaylistDialog'+import { AddToPlaylistDialog } from '../dialogs'import albumLists, { defaultAlbumList } from './albumLists'const AlbumFilter = (props) => {diff --git a/ui/src/album/AlbumSongs.js b/ui/src/album/AlbumSongs.jsindex bb34f6585..8bcac53ae 100644--- a/ui/src/album/AlbumSongs.js+++ b/ui/src/album/AlbumSongs.js@@ -20,7 +20,7 @@ import {SongDetails,SongTitleField,} from '../common'-import AddToPlaylistDialog from '../dialogs/AddToPlaylistDialog'+import { AddToPlaylistDialog } from '../dialogs'const useStyles = makeStyles((theme) => ({diff --git a/ui/src/artist/ArtistList.js b/ui/src/artist/ArtistList.jsindex 20600a79a..1e59bc452 100644--- a/ui/src/artist/ArtistList.js+++ b/ui/src/artist/ArtistList.js@@ -10,7 +10,7 @@ import {import { useMediaQuery, withWidth } from '@material-ui/core'import StarIcon from '@material-ui/icons/Star'import StarBorderIcon from '@material-ui/icons/StarBorder'-import AddToPlaylistDialog from '../dialogs/AddToPlaylistDialog'+import { AddToPlaylistDialog } from '../dialogs'import {ArtistContextMenu,List,diff --git a/ui/src/layout/AboutDialog.js b/ui/src/dialogs/AboutDialog.jssimilarity index 74%rename from ui/src/layout/AboutDialog.jsrename to ui/src/dialogs/AboutDialog.jsindex 00e59cafa..fa2be42c8 100644--- a/ui/src/layout/AboutDialog.js+++ b/ui/src/dialogs/AboutDialog.js@@ -1,13 +1,8 @@import React from 'react'import PropTypes from 'prop-types'-import { withStyles } from '@material-ui/core/styles'import Link from '@material-ui/core/Link'import Dialog from '@material-ui/core/Dialog'-import MuiDialogTitle from '@material-ui/core/DialogTitle'-import MuiDialogContent from '@material-ui/core/DialogContent'import IconButton from '@material-ui/core/IconButton'-import CloseIcon from '@material-ui/icons/Close'-import Typography from '@material-ui/core/Typography'import TableContainer from '@material-ui/core/TableContainer'import Table from '@material-ui/core/Table'import TableBody from '@material-ui/core/TableBody'@@ -18,19 +13,8 @@ import FavoriteBorderIcon from '@material-ui/icons/FavoriteBorder'import inflection from 'inflection'import { useTranslate } from 'react-admin'import config from '../config'--const styles = (theme) => ({- root: {- margin: 0,- padding: theme.spacing(2),- },- closeButton: {- position: 'absolute',- right: theme.spacing(1),- top: theme.spacing(1),- color: theme.palette.grey[500],- },-})+import { DialogTitle } from './DialogTitle'+import { DialogContent } from './DialogContent'const links = {homepage: 'navidrome.org',@@ -41,30 +25,6 @@ const links = {featureRequests: 'github.com/deluan/navidrome/issues',}-const DialogTitle = withStyles(styles)((props) => {- const { children, classes, onClose, ...other } = props- return (- <MuiDialogTitle disableTypography className={classes.root} {...other}>- <Typography variant="h5">{children}</Typography>- {onClose ? (- <IconButton- aria-label="close"- className={classes.closeButton}- onClick={onClose}- >- <CloseIcon />- </IconButton>- ) : null}- </MuiDialogTitle>- )-})--const DialogContent = withStyles((theme) => ({- root: {- padding: theme.spacing(2),- },-}))(MuiDialogContent)-const AboutDialog = ({ open, onClose }) => {const translate = useTranslate()return (@@ -79,7 +39,7 @@ const AboutDialog = ({ open, onClose }) => {</DialogTitle><DialogContent dividers><TableContainer component={Paper}>- <Table aria-label="song details" size="small">+ <Table aria-label={translate('menu.about')} size="small"><TableBody><TableRow><TableCell align="right" component="th" scope="row">@@ -143,4 +103,4 @@ AboutDialog.propTypes = {onClose: PropTypes.func.isRequired,}-export default AboutDialog+export { AboutDialog }diff --git a/ui/src/dialogs/AddToPlaylistDialog.js b/ui/src/dialogs/AddToPlaylistDialog.jsindex de0d9a44f..00dbec9b6 100644--- a/ui/src/dialogs/AddToPlaylistDialog.js+++ b/ui/src/dialogs/AddToPlaylistDialog.js@@ -14,9 +14,9 @@ import {DialogTitle,} from '@material-ui/core'import { closeAddToPlaylist } from '../actions'-import SelectPlaylistInput from './SelectPlaylistInput'+import { SelectPlaylistInput } from './SelectPlaylistInput'-const AddToPlaylistDialog = () => {+export const AddToPlaylistDialog = () => {const { open, selectedIds, onSuccess } = useSelector((state) => state.addToPlaylistDialog)@@ -96,5 +96,3 @@ const AddToPlaylistDialog = () => {</Dialog>)}--export default AddToPlaylistDialogdiff --git a/ui/src/dialogs/DialogContent.js b/ui/src/dialogs/DialogContent.jsnew file mode 100644index 000000000..cc6506114--- /dev/null+++ b/ui/src/dialogs/DialogContent.js@@ -0,0 +1,8 @@+import { withStyles } from '@material-ui/core/styles'+import MuiDialogContent from '@material-ui/core/DialogContent'++export const DialogContent = withStyles((theme) => ({+ root: {+ padding: theme.spacing(2),+ },+}))(MuiDialogContent)diff --git a/ui/src/dialogs/DialogTitle.js b/ui/src/dialogs/DialogTitle.jsnew file mode 100644index 000000000..959031e7c--- /dev/null+++ b/ui/src/dialogs/DialogTitle.js@@ -0,0 +1,35 @@+import { withStyles } from '@material-ui/core/styles'+import MuiDialogTitle from '@material-ui/core/DialogTitle'+import Typography from '@material-ui/core/Typography'+import IconButton from '@material-ui/core/IconButton'+import CloseIcon from '@material-ui/icons/Close'+import React from 'react'++const styles = (theme) => ({+ root: {+ margin: 0,+ padding: theme.spacing(2),+ },+ closeButton: {+ position: 'absolute',+ right: theme.spacing(1),+ top: theme.spacing(1),+ color: theme.palette.grey[500],+ },+})++export const DialogTitle = withStyles(styles)((props) => {+ const { children, classes, onClose, ...other } = props+ return (+ <MuiDialogTitle disableTypography className={classes.root} {...other}>+ <Typography variant="h5">{children}</Typography>+ <IconButton+ aria-label="close"+ className={classes.closeButton}+ onClick={onClose}+ >+ <CloseIcon />+ </IconButton>+ </MuiDialogTitle>+ )+})diff --git a/ui/src/dialogs/HelpDialog.js b/ui/src/dialogs/HelpDialog.jsnew file mode 100644index 000000000..0e7621fe6--- /dev/null+++ b/ui/src/dialogs/HelpDialog.js@@ -0,0 +1,78 @@+import React, { useCallback, useState } from 'react'+import ReactDOM from 'react-dom'+import { Dialog } from '@material-ui/core'+import { getApplicationKeyMap, GlobalHotKeys } from 'react-hotkeys'+import TableContainer from '@material-ui/core/TableContainer'+import Paper from '@material-ui/core/Paper'+import Table from '@material-ui/core/Table'+import TableBody from '@material-ui/core/TableBody'+import TableRow from '@material-ui/core/TableRow'+import TableCell from '@material-ui/core/TableCell'+import { useTranslate } from 'react-admin'+import inflection from 'inflection'+import { keyMap } from '../hotkeys'+import { DialogTitle } from './DialogTitle'+import { DialogContent } from './DialogContent'++const HelpTable = (props) => {+ const keyMap = getApplicationKeyMap()+ const translate = useTranslate()+ return ReactDOM.createPortal(+ <Dialog {...props}>+ <DialogTitle onClose={props.onClose}>+ {translate('help.title')}+ </DialogTitle>+ <DialogContent dividers>+ <TableContainer component={Paper}>+ <Table size="small">+ <TableBody>+ {Object.keys(keyMap).map((key) => {+ const { sequences, name } = keyMap[key]+ const description = translate(`help.hotkeys.${name}`, {+ _: inflection.humanize(name),+ })+ return (+ <TableRow key={key}>+ <TableCell align="right" component="th" scope="row">+ {description}+ </TableCell>+ <TableCell align="left">+ {sequences.map(({ sequence }) => (+ <span key={sequence}>{sequence}</span>+ ))}+ </TableCell>+ </TableRow>+ )+ })}+ </TableBody>+ </Table>+ </TableContainer>+ </DialogContent>+ </Dialog>,+ document.body+ )+}++export const HelpDialog = (props) => {+ const [open, setOpen] = useState(false)++ const handleClickClose = (e) => {+ setOpen(false)+ e.stopPropagation()+ }++ const handlers = {+ SHOW_HELP: useCallback(() => setOpen(true), [setOpen]),+ }++ return (+ <>+ <GlobalHotKeys keyMap={keyMap} handlers={handlers} allowChanges />+ <HelpTable+ open={open}+ onClose={handleClickClose}+ onBackdropClick={handleClickClose}+ />+ </>+ )+}diff --git a/ui/src/dialogs/SelectPlaylistInput.js b/ui/src/dialogs/SelectPlaylistInput.jsindex 2e4e53129..97569484c 100644--- a/ui/src/dialogs/SelectPlaylistInput.js+++ b/ui/src/dialogs/SelectPlaylistInput.js@@ -6,11 +6,11 @@ import Autocomplete, {} from '@material-ui/lab/Autocomplete'import { useGetList, useTranslate } from 'react-admin'import PropTypes from 'prop-types'-import { isWritable } from '../common/Writable'+import { isWritable } from '../common'const filter = createFilterOptions()-const SelectPlaylistInput = ({ onChange }) => {+export const SelectPlaylistInput = ({ onChange }) => {const translate = useTranslate()const { ids, data } = useGetList('playlist',@@ -94,5 +94,3 @@ const SelectPlaylistInput = ({ onChange }) => {SelectPlaylistInput.propTypes = {onChange: PropTypes.func.isRequired,}--export default SelectPlaylistInputdiff --git a/ui/src/dialogs/index.js b/ui/src/dialogs/index.jsnew file mode 100644index 000000000..79c431304--- /dev/null+++ b/ui/src/dialogs/index.js@@ -0,0 +1,4 @@+export * from './AboutDialog'+export * from './AddToPlaylistDialog'+export * from './SelectPlaylistInput'+export * from './HelpDialog'diff --git a/ui/src/hotkeys.js b/ui/src/hotkeys.jsindex 5086afa51..8ad02e065 100644--- a/ui/src/hotkeys.js+++ b/ui/src/hotkeys.js@@ -1,12 +1,12 @@const keyMap = {- TOGGLE_MENU: { name: 'Toggle Menu Side Bar', sequence: 'm', group: 'Global' },-- TOGGLE_PLAY: { name: 'Play / Pause', sequence: 'p', group: 'Player' },- PREV_SONG: { name: 'Previous Songs', sequence: 'left', group: 'Player' },- NEXT_SONG: { name: 'Next Song', sequence: 'right', group: 'Player' },- VOL_UP: { name: 'Volume Up', sequence: '=', group: 'Player' },- VOL_DOWN: { name: 'Volume Down', sequence: '-', group: 'Player' },- TOGGLE_STAR: { name: 'Toggle Star', sequence: 's', group: 'Player' },+ SHOW_HELP: { name: 'show_help', sequence: 'shift+?', group: 'Global' },+ TOGGLE_MENU: { name: 'toggle_menu', sequence: 'm', group: 'Global' },+ TOGGLE_PLAY: { name: 'toggle_play', sequence: 'p', group: 'Player' },+ PREV_SONG: { name: 'prev_song', sequence: 'left', group: 'Player' },+ NEXT_SONG: { name: 'next_song', sequence: 'right', group: 'Player' },+ VOL_UP: { name: 'vol_up', sequence: '=', group: 'Player' },+ VOL_DOWN: { name: 'vol_down', sequence: '-', group: 'Player' },+ TOGGLE_STAR: { name: 'toggle_star', sequence: 's', group: 'Player' },}export { keyMap }diff --git a/ui/src/i18n/en.json b/ui/src/i18n/en.jsonindex aefac515b..b01377d3c 100644--- a/ui/src/i18n/en.json+++ b/ui/src/i18n/en.json@@ -324,5 +324,18 @@"fullScan": "Full Scan","serverUptime": "Server Uptime","serverDown": "OFFLINE"+ },+ "help": {+ "title": "Navidrome Hotkeys",+ "hotkeys": {+ "show_help": "Show This Help",+ "toggle_menu": "Toggle Menu Side Bar",+ "toggle_play": "Play / Pause",+ "prev_song": "Previous Song",+ "next_song": "Next Song",+ "vol_up": "Volume Up",+ "vol_down": "Volume Down",+ "toggle_star": "Toggle Current Song's Star"+ }}}diff --git a/ui/src/layout/AppBar.js b/ui/src/layout/AppBar.jsindex 353fbd528..ccbc94025 100644--- a/ui/src/layout/AppBar.js+++ b/ui/src/layout/AppBar.js@@ -10,7 +10,7 @@ import { useSelector } from 'react-redux'import { makeStyles, MenuItem, ListItemIcon, Divider } from '@material-ui/core'import ViewListIcon from '@material-ui/icons/ViewList'import InfoIcon from '@material-ui/icons/Info'-import AboutDialog from './AboutDialog'+import { AboutDialog } from '../dialogs'import PersonalMenu from './PersonalMenu'import ActivityPanel from './ActivityPanel'import UserMenu from './UserMenu'diff --git a/ui/src/layout/Menu.js b/ui/src/layout/Menu.jsindex 2ef57cff8..9aae9c05d 100644--- a/ui/src/layout/Menu.js+++ b/ui/src/layout/Menu.js@@ -9,6 +9,7 @@ import AlbumIcon from '@material-ui/icons/Album'import SubMenu from './SubMenu'import inflection from 'inflection'import albumLists from '../album/albumLists'+import { HelpDialog } from '../dialogs'const translatedResourceName = (resource, translate) =>translate(`resources.${resource.name}.name`, {@@ -108,6 +109,7 @@ const Menu = ({ onMenuClick, dense, logout }) => {</SubMenu>{resources.filter(subItems(undefined)).map(renderResourceMenuItemLink)}{isXsmall && logout}+ <HelpDialog /></div>)}diff --git a/ui/src/playlist/PlaylistSongs.js b/ui/src/playlist/PlaylistSongs.jsindex 2be7f823b..9bf302cd0 100644--- a/ui/src/playlist/PlaylistSongs.js+++ b/ui/src/playlist/PlaylistSongs.js@@ -21,7 +21,7 @@ import {SongDatagrid,SongTitleField,} from '../common'-import AddToPlaylistDialog from '../dialogs/AddToPlaylistDialog'+import { AddToPlaylistDialog } from '../dialogs'import { AlbumLinkField } from '../song/AlbumLinkField'import { playTracks } from '../actions'import PlaylistSongBulkActions from './PlaylistSongBulkActions'diff --git a/ui/src/song/SongList.js b/ui/src/song/SongList.jsindex f4c8b32a3..59dec1f04 100644--- a/ui/src/song/SongList.js+++ b/ui/src/song/SongList.js@@ -23,7 +23,7 @@ import { setTrack } from '../actions'import { SongBulkActions } from '../common'import { SongListActions } from './SongListActions'import { AlbumLinkField } from './AlbumLinkField'-import AddToPlaylistDialog from '../dialogs/AddToPlaylistDialog'+import { AddToPlaylistDialog } from '../dialogs'import { makeStyles } from '@material-ui/core/styles'import StarBorderIcon from '@material-ui/icons/StarBorder'