mirrors
/
navidrome
mirror of https://github.com/navidrome/navidrome.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
navidrome/ui/src/themes/README.md

1.1 KiB
Raw Blame History

Creating New Themes

Themes in Navidrome are simple Material-UI themes. They are basic JS objects, that allow you to override almost every visual aspect of Navidrome's UI.

Steps to create a new theme:

  1. Create a new JS file in this folder that exports an object containing your theme. Create the theme based on the ReactAdmin/Material UI documentation below. See the existing themes for examples.
  2. Add a themeName property to your theme. This will be displayed in the theme selector
  3. Add your new theme to the ui/src/themes/index.js file
  4. Start the application, your new theme should now appear as an option in the theme selector

Before submitting a pull request to include your theme in Navidrome, please test your theme thoroughly and make sure it is formated with the Prettier rules found in the project (ui/src/.prettierrc.js)

Resources for Material-UI theming