Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sidebar theme docs #1718

Merged
merged 2 commits into from
Oct 25, 2023
Merged

Update sidebar theme docs #1718

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0193a8
Document unselectedBackground
victorlin Oct 23, 2023
e354e37
Update descriptions
victorlin Oct 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions docs/customise-client/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,22 +54,25 @@ For instance, here is the customisation used by nextstrain.org:
"sidebarBoxShadow": "rgba(0, 0, 0, 0.2)",
"font-family": "Lato, Helvetica Neue, Helvetica, sans-serif",
"selectedColor": "#5097BA",
"unselectedColor": "#333"
"unselectedColor": "#333",
"unselectedBackground": "#888"
}
}

+--------------------------+------------------------------+----------------------------------------------------+
| Properties | CSS string of | Description |
+==========================+==============================+====================================================+
| color | color | Text color |
+--------------------------+------------------------------+----------------------------------------------------+
| selectedColor | color | Text color of selected text / button text |
+--------------------------+------------------------------+----------------------------------------------------+
| unselectedColor | color | Text color of unselected text / button text |
+--------------------------+------------------------------+----------------------------------------------------+
| font-family | font | Inner shadow of the sidebar on the right hand side |
| color | color | Text color of all other text |
+--------------------------+------------------------------+----------------------------------------------------+
| unselectedBackground | color | Background color of unselected toggle |
+--------------------------+------------------------------+----------------------------------------------------+
| font-family | font | Font used throughout the sidebar |
+--------------------------+------------------------------+----------------------------------------------------+
| background | color | Background color |
| background | color | Background color of the entire sidebar |
+--------------------------+------------------------------+----------------------------------------------------+

Components
Expand Down