Always use svg series icon #5214
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| import { ShadowlessLitElement } from "components/meta/shadowless_lit_element"; | ||
| import { html, svg, TemplateResult } from "lit"; | ||
| import { customElement, property } from "lit/decorators.js"; | ||
|
|
||
| export type SeriesProgressStatus = "not-yet-begun" | "started" | "completed" | "wrong"; | ||
| export type SeriesDeadlineStatus = "met" | "missed" | null; | ||
| export type SeasonTheme = "christmas" | "december" | "valentine" | "mario-day" | "pi-day" | null; | ||
|
|
||
| /** | ||
| * @element d-series-icon | ||
| * | ||
| * this icon visualizes the status of a series for a give user | ||
| * | ||
| * @cssprop --icon-color - the color of the icon | ||
| * @cssprop --icon-background-color - the background color of the icon | ||
| * @cssprop --deadline-icon-color - the color of the deadline icon | ||
| * @cssprop --deadline-icon-background-color - the background color of the deadline icon | ||
| * | ||
| * @attr {string} deadline - The status of the deadline, if any | ||
| * @attr {string} season - The season theme to apply, if any | ||
| * @attr {string} progress - the progress of the user in the series | ||
| * @attr {number} size - the size of the icon in pixels | ||
| * @attr {string} status - the status of the series, displayed as a tooltip | ||
| */ | ||
| @customElement("d-series-icon") | ||
| export class SeriesIcon extends ShadowlessLitElement { | ||
jorg-vr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| @property({ type: String }) | ||
| progress: SeriesProgressStatus = "not-yet-begun"; | ||
| @property({ type: String }) | ||
| deadline: SeriesDeadlineStatus = null; | ||
| @property({ type: String }) | ||
| season: SeasonTheme = null; | ||
| @property({ type: Number }) | ||
| size = 40; | ||
| @property({ type: String }) | ||
| status = ""; | ||
|
|
||
| static PROGRESS_ICONS: Record<SeriesProgressStatus, string> = { | ||
| "not-yet-begun": "mdi-school", | ||
| "started": "mdi-thumb-up", | ||
| "completed": "mdi-check-bold", | ||
| "wrong": "mdi-close", | ||
| }; | ||
|
|
||
| static DEADLINE_ICONS: Record<SeriesDeadlineStatus, string> = { | ||
| "met": "mdi-alarm-check", | ||
| "missed": "mdi-alarm-off", | ||
| }; | ||
|
|
||
| get progress_icon(): string { | ||
| return SeriesIcon.PROGRESS_ICONS[this.progress]; | ||
| } | ||
|
|
||
| get deadline_icon(): string { | ||
| return SeriesIcon.DEADLINE_ICONS[this.deadline]; | ||
| } | ||
|
|
||
| get deadline_class(): string { | ||
| return this.deadline ? `deadline-${this.deadline}` : ""; | ||
| } | ||
|
|
||
| protected render(): TemplateResult { | ||
| return html` | ||
| <svg viewBox="0 0 40 40" | ||
| style="width: ${this.size}px; height: ${this.size}px; " | ||
| class="series-icon ${this.season} ${this.progress} ${this.deadline_class}" | ||
| title="${this.status}" | ||
| data-bs-toggle="tooltip" | ||
| data-bs-placement="top" | ||
| > | ||
| ${ this.progress === "completed" && this.deadline !== "missed" ? svg` | ||
| <defs> | ||
| <linearGradient id="rainbow" gradientTransform="rotate(135, 0.5, 0.5)" > | ||
| <stop stop-color="var(--red)" offset="1%" /> | ||
| <stop stop-color="var(--orange)" offset="25%" /> | ||
| <stop stop-color="var(--yellow)" offset="40%" /> | ||
| <stop stop-color="var(--green)" offset="60%" /> | ||
| <stop stop-color="var(--blue)" offset="75%" /> | ||
| <stop stop-color="var(--purple)" offset="99%" /> | ||
| </linearGradient> | ||
| </defs> | ||
| ` : ""} | ||
|
|
||
| <g class="icon-base" > | ||
| <circle cx="50%" cy="50%" r= "50%" fill="var(--icon-color)" class="outer-circle"></circle> | ||
| <circle cx="50%" cy="50%" r= "42%" fill="var(--icon-background-color)"></circle> | ||
| <foreignObject x="8" y="8" height="24" width="24" style="color: var(--icon-color)"> | ||
| <i class="mdi ${this.progress_icon}"></i> | ||
| </foreignObject> | ||
|
|
||
| ${this.deadline_icon ? svg` | ||
| <circle cx="33" cy="34.5" r= "11" fill="var(--deadline-icon-background-color)"></circle> | ||
| <foreignObject x="24" y="26" height="18" width="18" style="color: var(--deadline-icon-color)"> | ||
| <i class="mdi mdi-18 ${this.deadline_icon}"></i> | ||
| </foreignObject> | ||
| ` : ""} | ||
| </g> | ||
|
|
||
| ${this.season ? svg` | ||
| <foreignObject width="100%" height="100%" class="overlay"> | ||
| <div></div> | ||
| </foreignObject> | ||
| ` : ""} | ||
| </svg> | ||
| `; | ||
| } | ||
| } | ||
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,13 @@ | ||
| <% # arguments: loaded (bool), series (Series), user (User) %> | ||
| <% size ||= 40 %> | ||
| <% if defined?(loaded) && loaded && user.present? %> | ||
| <d-series-icon | ||
| size="<%= size %>" | ||
| season="<%= series_status_overlay %>" | ||
| progress="<%= series_status_progress(series, user) %>" | ||
| deadline="<%= series_status_deadline(series, user) %>" | ||
| status="<%= series_status(series, user) %>" | ||
| ></d-series-icon> | ||
| <% else %> | ||
| <d-series-icon size="<%= size %>"></d-series-icon> | ||
| <% end %> |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these specified in a general css file? Why not add them here to make this component self contained?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right now it is a shadowless lit component, which forces all style definitions to be in the global scope.
Changing it to use the shadow dom would not allow any use of globally defined classes. In this this would mean we had to redefine the material design icons used within this class. I do not think that is desired.
Sadly there is no way to 'partially' use the shadow dom. Which is why we also aren't using the shadow dom in most other components for now.