docs: Oryx favicons #2443
Open
docs: Oryx favicons #2443
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tobi-or-not-tobi
requested review from
andriitserkovnyi,
tolerants and
lenadoc
as code owners
tolerants
requested changes
Jan 11, 2024
| initialize(): void { | ||
| super.initialize(); | ||
| this.metaService?.add( | ||
| // array with custom element definitions (ElementDefinition) |
There was a problem hiding this comment.
Maybe let's add a real example?
| template: concept-topic-template | ||
| --- | ||
|
|
||
| Favicons, short for "favorite icons", are small, iconic images that represent a website or web application. They are typically displayed in the browser's address bar, tabs, and bookmarks. Creating a favicon involves designing an image that effectively conveys the identity of the web application in a small, recognizable format. Most brands use their logo or a variation of the logo in the favicon. The challenging part is often the limited available size. |
There was a problem hiding this comment.
I'd say there is near zero sense to explain what is favicon in frontend framework documentation :) So I'd shorten this section.
| </svg> | ||
| ``` | ||
|
|
||
| The logo is referenced from a file. While favicons can be rendered inline in the meta data, as a base64 SVG, it is only recommended for a simple vector shape. Most logos will generate a large string in base64 and increases every (SSR rendered) page significantly. In case of a dark mode variation, it will be even worse. Moreover, a base64 based favicon cannot be cached and reused. |
There was a problem hiding this comment.
In case of a dark mode variation, it will be even worse.
Maybe explanation why it will be even worse would be good.
|
|
||
| Favicons, short for "favorite icons", are small, iconic images that represent a website or web application. They are typically displayed in the browser's address bar, tabs, and bookmarks. Creating a favicon involves designing an image that effectively conveys the identity of the web application in a small, recognizable format. Most brands use their logo or a variation of the logo in the favicon. The challenging part is often the limited available size. | ||
|
|
||
| ## Technical format |
There was a problem hiding this comment.
Maybe Icon/Image format?
|
|
||
| ## Meta tags | ||
|
|
||
| Favicons can be added to a web page in different ways. Oryx prefers to add them in the header of the html. While dark mode is supported inline in the SVG, somehow browsers won't automatically rerender the favicon when the device color mode is changing. Therefore, the favicon is added twice in the html. This will cause a correct rerendering of the light vs dark mode favicon. |
There was a problem hiding this comment.
Suggested change
| Favicons can be added to a web page in different ways. Oryx prefers to add them in the header of the html. While dark mode is supported inline in the SVG, somehow browsers won't automatically rerender the favicon when the device color mode is changing. Therefore, the favicon is added twice in the html. This will cause a correct rerendering of the light vs dark mode favicon. | |
| Favicons can be added to a web page in different ways. Oryx prefers to add them in the head of the html document. While dark mode is supported inline in the SVG, somehow browsers won't automatically rerender the favicon when the device color mode is changing. Therefore, the favicon is added twice in the html. This will cause a correct rerendering of the light vs dark mode favicon. |
Comment on lines
+42
to
+45
| ```html | ||
| <link rel="icon" href="/public/logo.svg"> | ||
| <link rel="icon" href="/public/logo.svg" media="(prefers-color-scheme: dark)"> | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| ```html | |
| <link rel="icon" href="/public/logo.svg"> | |
| <link rel="icon" href="/public/logo.svg" media="(prefers-color-scheme: dark)"> | |
| ``` | |
| ```html | |
| <head> | |
| ... | |
| <link rel="icon" href="/public/logo.svg"> | |
| <link rel="icon" href="/public/logo.svg" media="(prefers-color-scheme: dark)"> | |
| ... | |
| </head> |
| </svg> | ||
| ``` | ||
|
|
||
| The logo is referenced from a file. While favicons can be rendered inline in the meta data, as a base64 SVG, it is only recommended for a simple vector shape. Most logos will generate a large string in base64 and increases every (SSR rendered) page significantly. In case of a dark mode variation, it will be even worse. Moreover, a base64 based favicon cannot be cached and reused. |
There was a problem hiding this comment.
What do you about adding an example of logo in base64 format? So we have an example for each case.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Small documentation for favicon to explain how they're created and added.
Checklist