Commit 2a254ef1 authored by Robert Knight's avatar Robert Knight

Improve type of `branding` config setting

parent 28f6e4d3
...@@ -84,6 +84,18 @@ ...@@ -84,6 +84,18 @@
* @prop {import('./rpc').FocusUserInfo} [user] * @prop {import('./rpc').FocusUserInfo} [user]
*/ */
/**
* List of theme elements which can be customized.
*
* @typedef {'accentColor'|
* 'annotationFontFamily' |
* 'appBackgroundColor'|
* 'ctaBackgroundColor'|
* 'ctaTextColor'|
* 'selectionFontFamily'
* } ThemeProperty
*/
/** /**
* Configuration provided by the annotator ("host frame") as * Configuration provided by the annotator ("host frame") as
* `ConfigFromAnnotator` OR by an ancestor ("embedder frame") as * `ConfigFromAnnotator` OR by an ancestor ("embedder frame") as
...@@ -101,7 +113,7 @@ ...@@ -101,7 +113,7 @@
* @prop {string} [appType] - Method used to load the client * @prop {string} [appType] - Method used to load the client
* @prop {boolean} [openSidebar] - Whether to open the sidebar on the initial load * @prop {boolean} [openSidebar] - Whether to open the sidebar on the initial load
* @prop {boolean} [showHighlights] - Whether to show highlights * @prop {boolean} [showHighlights] - Whether to show highlights
* @prop {object} [branding] - * @prop {Record<ThemeProperty, string>} [branding] -
* Theme properties (fonts, colors etc.) * Theme properties (fonts, colors etc.)
* @prop {boolean} [enableExperimentalNewNoteButton] - * @prop {boolean} [enableExperimentalNewNoteButton] -
* Whether to show the "New note" button on the "Page Notes" tab * Whether to show the "New note" button on the "Page Notes" tab
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment