Templatable document title #28979
Templatable document title #28979
Conversation
| 4. `title_template`: A template string that can be used to configure the title of the application when not viewing a room. | ||
| 5. `title_template_in_room`: A template string that can be used to configure the title of the application when viewing a room | ||
|
|
||
| #### `title_template` vars |
There was a problem hiding this comment.
There is an issue here that this (by omission) assures these values to be stable. Should we add a disclaimer that these parameters may change at any time?
There was a problem hiding this comment.
Because our config flags are to be considered stable and changes should include backwards compatibility, its one of the reason config options tend to need product approval as its something we're committing to supporting for a good long time given we're not semver compliant it is much harder to spot "breaking" configuration changes
Like we still support camelCase & snake_case even though we switched to the latter multiple years ago. Like we still support default_hs_url even though we switched to well-knowns many years ago.
There was a problem hiding this comment.
Cool. I'll put this under product review then. My understanding is the feature itself was greenlit, though I think we should be aware of the configuration implications.
There was a problem hiding this comment.
aware of the configuration implications.
Maintenance implications*
It may want to be an Element Module to avoid that, or Product should derive the exact functions it should support so it can live & be supported mainline
|
|
||
| const title = `${SdkConfig.get().brand} ${subtitle}`; | ||
| const title = Object.entries(params).reduce( |
There was a problem hiding this comment.
I feel like an app this size must be using templating elsewhere but couldn't find any examples or libraries I was particularly keen on, but pointers in this direction would be appreciated.
| @@ -50,6 +50,8 @@ export interface IConfigOptions { | |||
| welcome_background_url?: string | string[]; // chosen at random if array | |||
| auth_header_logo_url?: string; | |||
| auth_footer_links?: { text: string; url: string }[]; | |||
| title_template?: string; | |||
There was a problem hiding this comment.
Branding seems to consist of mostly urls, but it felt like a reasonable place to put this. Shout if this should be somewhere else.
|
Requires input from @daniellekirkwood to proceed so pausing for the moment. |
|
If this does go ahead we'd also need to consider i18n, as currently stands it does not support i18n |
This adds the ability to set a title template via the
brandingconfiguration, allowing vendors to customize the document title depending on their needs.Checklist
public/exportedsymbols have accurate TSDoc documentation.