jeans/frontend
jeans/frontend
1
0
Fork 0
mirror of https://github.com/home-assistant/frontend.git synced 2025-07-25 10:16:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add fit mode support to picture glance card and picture entity card (#25005)

Browse Source 
Co-authored-by: karwosts <karwosts@gmail.com>
This commit is contained in:
Paul Bottein 2025-04-17 15:36:34 +02:00 committed by GitHub
parent 77216e8e76
commit e74cac697e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 357 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/components/ha-camera-stream.ts
View File

@ -1,6 +1,7 @@
import { css, html, LitElement, nothing, type PropertyValues } from "lit";
import { customElement, property, state } from "lit/decorators";
import { repeat } from "lit/directives/repeat";
import { styleMap } from "lit/directives/style-map";
import memoizeOne from "memoize-one";
import { computeStateName } from "../common/entity/compute_state_name";
import { supportsFeature } from "../common/entity/supports-feature";
@ -32,6 +33,10 @@ export class HaCameraStream extends LitElement {
@property({ attribute: false }) public stateObj?: CameraEntity;
@property({ attribute: false }) public aspectRatio?: number;
@property({ attribute: false }) public fitMode?: "cover" | "contain" | "fill";
@property({ type: Boolean, attribute: "controls" })
public controls = false;
@ -101,6 +106,10 @@ export class HaCameraStream extends LitElement {
: this._connected
? computeMJPEGStreamUrl(this.stateObj)
: this._posterUrl || ""}
style=${styleMap({
aspectRatio: this.aspectRatio,
objectFit: this.fitMode,
})}
alt=${`Preview of the ${computeStateName(this.stateObj)} camera.`}
/>`;
}
@ -117,6 +126,8 @@ export class HaCameraStream extends LitElement {
.posterUrl=${this._posterUrl}
@streams=${this._handleHlsStreams}
class=${stream.visible ? "" : "hidden"}
.aspectRatio=${this.aspectRatio}
.fitMode=${this.fitMode}
></ha-hls-player>`;
}
@ -131,6 +142,8 @@ export class HaCameraStream extends LitElement {
.posterUrl=${this._posterUrl}
@streams=${this._handleWebRtcStreams}
class=${stream.visible ? "" : "hidden"}
.aspectRatio=${this.aspectRatio}
.fitMode=${this.fitMode}
></ha-web-rtc-player>`;
}
@ -259,6 +272,16 @@ export class HaCameraStream extends LitElement {
width: 100%;
}
ha-web-rtc-player {
width: 100%;
height: 100%;
}
ha-hls-player {
width: 100%;
height: 100%;
}
.hidden {
display: none;
}

14
src/components/ha-hls-player.ts
View File

@ -2,12 +2,13 @@ import type HlsType from "hls.js";
import type { PropertyValues, TemplateResult } from "lit";
import { css, html, LitElement } from "lit";
import { customElement, property, query, state } from "lit/decorators";
import { styleMap } from "lit/directives/style-map";
import { isComponentLoaded } from "../common/config/is_component_loaded";
import { fireEvent } from "../common/dom/fire_event";
import { nextRender } from "../common/util/render-status";
import { fetchStreamUrl } from "../data/camera";
import type { HomeAssistant } from "../types";
import "./ha-alert";
import { fetchStreamUrl } from "../data/camera";
import { isComponentLoaded } from "../common/config/is_component_loaded";
type HlsLite = Omit<
HlsType,
@ -24,6 +25,10 @@ class HaHLSPlayer extends LitElement {
@property({ attribute: "poster-url" }) public posterUrl?: string;
@property({ attribute: false }) public aspectRatio?: number;
@property({ attribute: false }) public fitMode?: "cover" | "contain" | "fill";
@property({ type: Boolean, attribute: "controls" })
public controls = false;
@ -87,6 +92,11 @@ class HaHLSPlayer extends LitElement {
?playsinline=${this.playsInline}
?controls=${this.controls}
@loadeddata=${this._loadedData}
style=${styleMap({
height: this.aspectRatio == null ? "100%" : "auto",
aspectRatio: this.aspectRatio,
objectFit: this.fitMode,
})}
></video>`
: ""}
`;

12
src/components/ha-web-rtc-player.ts
View File

@ -1,8 +1,9 @@
import type { PropertyValues, TemplateResult } from "lit";
import type { UnsubscribeFunc } from "home-assistant-js-websocket";
import type { PropertyValues, TemplateResult } from "lit";
import { css, html, LitElement } from "lit";
import { customElement, property, query, state } from "lit/decorators";
import { ifDefined } from "lit/directives/if-defined";
import { styleMap } from "lit/directives/style-map";
import { fireEvent } from "../common/dom/fire_event";
import {
addWebRtcCandidate,
@ -26,6 +27,10 @@ class HaWebRtcPlayer extends LitElement {
@property() public entityid?: string;
@property({ attribute: false }) public aspectRatio?: number;
@property({ attribute: false }) public fitMode?: "cover" | "contain" | "fill";
@property({ type: Boolean, attribute: "controls" })
public controls = false;
@ -69,6 +74,11 @@ class HaWebRtcPlayer extends LitElement {
?controls=${this.controls}
poster=${ifDefined(this.posterUrl)}
@loadeddata=${this._loadedData}
style=${styleMap({
height: this.aspectRatio == null ? "100%" : "auto",
aspectRatio: this.aspectRatio,
objectFit: this.fitMode,
})}
></video>
`;
}

3
src/panels/lovelace/cards/hui-area-card.ts
View File

@ -93,8 +93,7 @@ export class HuiAreaCard
@property({ attribute: false }) public hass!: HomeAssistant;
@property({ attribute: false })
public layout?: string;
@property({ attribute: false }) public layout?: string;
@state() private _config?: AreaCardConfig;

10
src/panels/lovelace/cards/hui-picture-entity-card.ts
View File

@ -55,6 +55,8 @@ class HuiPictureEntityCard extends LitElement implements LovelaceCard {
@property({ attribute: false }) public hass?: HomeAssistant;
@property({ attribute: false }) public layout?: string;
@state() private _config?: PictureEntityCardConfig;
public getCardSize(): number {
@ -155,6 +157,10 @@ class HuiPictureEntityCard extends LitElement implements LovelaceCard {
}
}
const ignoreAspectRatio =
this.layout === "grid" &&
typeof this._config.grid_options?.rows === "number";
return html`
<ha-card>
<hui-image
@ -167,7 +173,9 @@ class HuiPictureEntityCard extends LitElement implements LovelaceCard {
: this._config.camera_image}
.cameraView=${this._config.camera_view}
.entity=${this._config.entity}
.aspectRatio=${this._config.aspect_ratio}
.aspectRatio=${ignoreAspectRatio
? undefined
: this._config.aspect_ratio}
.fitMode=${this._config.fit_mode}
@action=${this._handleAction}
.actionHandler=${actionHandler({

14
src/panels/lovelace/cards/hui-picture-glance-card.ts
View File

@ -63,6 +63,8 @@ class HuiPictureGlanceCard extends LitElement implements LovelaceCard {
@property({ attribute: false }) public hass!: HomeAssistant;
@property({ attribute: false }) public layout?: string;
@state() private _config?: PictureGlanceCardConfig;
private _entitiesDialog?: PictureGlanceEntityConfig[];
@ -199,6 +201,10 @@ class HuiPictureGlanceCard extends LitElement implements LovelaceCard {
}
}
const ignoreAspectRatio =
this.layout === "grid" &&
typeof this._config.grid_options?.rows === "number";
return html`
<ha-card>
<hui-image
@ -226,7 +232,10 @@ class HuiPictureGlanceCard extends LitElement implements LovelaceCard {
.cameraImage=${this._config.camera_image}
.cameraView=${this._config.camera_view}
.entity=${this._config.entity}
.aspectRatio=${this._config.aspect_ratio}
.fitMode=${this._config.fit_mode}
.aspectRatio=${ignoreAspectRatio
? undefined
: this._config.aspect_ratio}
></hui-image>
<div class="box">
${this._config.title
@ -324,6 +333,9 @@ class HuiPictureGlanceCard extends LitElement implements LovelaceCard {
height: 100%;
box-sizing: border-box;
}
hui-image {
height: 100%;
}
hui-image.clickable {
cursor: pointer;
}

2
src/panels/lovelace/cards/types.ts
View File

@ -440,6 +440,7 @@ export interface PictureEntityCardConfig extends LovelaceCardConfig {
state_image?: Record<string, unknown>;
state_filter?: string[];
aspect_ratio?: string;
fit_mode?: "cover" | "contain" | "fill";
tap_action?: ActionConfig;
hold_action?: ActionConfig;
double_tap_action?: ActionConfig;
@ -458,6 +459,7 @@ export interface PictureGlanceCardConfig extends LovelaceCardConfig {
state_image?: Record<string, unknown>;
state_filter?: string[];
aspect_ratio?: string;
fit_mode?: "cover" | "contain" | "fill";
entity?: string;
tap_action?: ActionConfig;
hold_action?: ActionConfig;

10
src/panels/lovelace/components/hui-image.ts
View File

@ -217,6 +217,10 @@ export class HuiImage extends LitElement {
muted
.hass=${this.hass}
.stateObj=${cameraObj}
.fitMode=${this.fitMode}
.aspectRatio=${this._ratio
? this._ratio.w / this._ratio.h
: undefined}
@load=${this._onVideoLoad}
></ha-camera-stream>
`
@ -400,6 +404,12 @@ export class HuiImage extends LitElement {
object-fit: cover;
}
ha-camera-stream {
display: block;
height: 100%;
width: 100%;
}
.progress-container {
display: flex;
justify-content: center;

203
src/panels/lovelace/editor/config-elements/hui-picture-entity-card-editor.ts
View File

@ -2,11 +2,24 @@ import { mdiGestureTap } from "@mdi/js";
import type { CSSResultGroup } from "lit";
import { html, LitElement, nothing } from "lit";
import { customElement, property, state } from "lit/decorators";
import { assert, assign, boolean, object, optional, string } from "superstruct";
import memoizeOne from "memoize-one";
import {
assert,
assign,
boolean,
enums,
object,
optional,
string,
} from "superstruct";
import { fireEvent } from "../../../../common/dom/fire_event";
import { computeDomain } from "../../../../common/entity/compute_domain";
import type { LocalizeFunc } from "../../../../common/translations/localize";
import "../../../../components/ha-form/ha-form";
import type { SchemaUnion } from "../../../../components/ha-form/types";
import type {
HaFormSchema,
SchemaUnion,
} from "../../../../components/ha-form/types";
import type { HomeAssistant } from "../../../../types";
import { STUB_IMAGE } from "../../cards/hui-picture-entity-card";
import type { PictureEntityCardConfig } from "../../cards/types";
@ -22,7 +35,7 @@ const cardConfigStruct = assign(
image: optional(string()),
name: optional(string()),
camera_image: optional(string()),
camera_view: optional(string()),
camera_view: optional(enums(["auto", "live"])),
aspect_ratio: optional(string()),
tap_action: optional(actionConfigStruct),
hold_action: optional(actionConfigStruct),
@ -30,74 +43,10 @@ const cardConfigStruct = assign(
show_name: optional(boolean()),
show_state: optional(boolean()),
theme: optional(string()),
fit_mode: optional(string()),
fit_mode: optional(enums(["cover", "contain", "fill"])),
})
);
const SCHEMA = [
{ name: "entity", required: true, selector: { entity: {} } },
{ name: "name", selector: { text: {} } },
{ name: "image", selector: { image: {} } },
{ name: "camera_image", selector: { entity: { domain: "camera" } } },
{
name: "",
type: "grid",
schema: [
{
name: "camera_view",
selector: { select: { options: ["auto", "live"] } },
},
{ name: "aspect_ratio", selector: { text: {} } },
],
},
{
name: "",
type: "grid",
schema: [
{
name: "show_name",
selector: { boolean: {} },
},
{
name: "show_state",
selector: { boolean: {} },
},
],
},
{ name: "theme", selector: { theme: {} } },
{
name: "interactions",
type: "expandable",
flatten: true,
iconPath: mdiGestureTap,
schema: [
{
name: "tap_action",
selector: {
ui_action: {
default_action: "more-info",
},
},
},
{
name: "",
type: "optional_actions",
flatten: true,
schema: (["hold_action", "double_tap_action"] as const).map(
(action) => ({
name: action,
selector: {
ui_action: {
default_action: "none" as const,
},
},
})
),
},
],
},
] as const;
@customElement("hui-picture-entity-card-editor")
export class HuiPictureEntityCardEditor
extends LitElement
@ -112,6 +61,99 @@ export class HuiPictureEntityCardEditor
this._config = config;
}
private _schema = memoizeOne(
(localize: LocalizeFunc) =>
[
{ name: "entity", required: true, selector: { entity: {} } },
{ name: "name", selector: { text: {} } },
{ name: "image", selector: { image: {} } },
{ name: "camera_image", selector: { entity: { domain: "camera" } } },
{
name: "",
type: "grid",
schema: [
{
name: "camera_view",
required: true,
selector: {
select: {
options: ["auto", "live"].map((value) => ({
value,
label: localize(
`ui.panel.lovelace.editor.card.generic.camera_view_options.${value}`
),
})),
mode: "dropdown",
},
},
},
{
name: "fit_mode",
required: true,
selector: {
select: {
options: ["cover", "contain", "fill"].map((value) => ({
value,
label: localize(
`ui.panel.lovelace.editor.card.generic.fit_mode_options.${value}`
),
})),
mode: "dropdown",
},
},
},
{ name: "aspect_ratio", selector: { text: {} } },
],
},
{
name: "",
type: "grid",
schema: [
{
name: "show_name",
selector: { boolean: {} },
},
{
name: "show_state",
selector: { boolean: {} },
},
],
},
{ name: "theme", selector: { theme: {} } },
{
name: "interactions",
type: "expandable",
flatten: true,
iconPath: mdiGestureTap,
schema: [
{
name: "tap_action",
selector: {
ui_action: {
default_action: "more-info",
},
},
},
{
name: "",
type: "optional_actions",
flatten: true,
schema: (["hold_action", "double_tap_action"] as const).map(
(action) => ({
name: action,
selector: {
ui_action: {
default_action: "none" as const,
},
},
})
),
},
],
},
] as const satisfies HaFormSchema[]
);
protected render() {
if (!this.hass || !this._config) {
return nothing;
@ -121,15 +163,19 @@ export class HuiPictureEntityCardEditor
show_state: true,
show_name: true,
camera_view: "auto",
fit_mode: "cover",
...this._config,
};
const schema = this._schema(this.hass.localize);
return html`
<ha-form
.hass=${this.hass}
.data=${data}
.schema=${SCHEMA}
.schema=${schema}
.computeLabel=${this._computeLabelCallback}
.computeHelper=${this._computeHelperCallback}
@value-changed=${this._valueChanged}
></ha-form>
</div>
@ -152,7 +198,9 @@ export class HuiPictureEntityCardEditor
fireEvent(this, "config-changed", { config });
}
private _computeLabelCallback = (schema: SchemaUnion<typeof SCHEMA>) => {
private _computeLabelCallback = (
schema: SchemaUnion<ReturnType<typeof this._schema>>
) => {
switch (schema.name) {
case "theme":
case "tap_action":
@ -170,6 +218,21 @@ export class HuiPictureEntityCardEditor
}
};
private _computeHelperCallback = (
schema: SchemaUnion<ReturnType<typeof this._schema>>
) => {
switch (schema.name) {
case "aspect_ratio":
return typeof this._config?.grid_options?.rows === "number"
? this.hass!.localize(
`ui.panel.lovelace.editor.card.generic.aspect_ratio_ignored`
)
: "";
default:
return "";
}
};
static styles: CSSResultGroup = configElementStyle;
}

201
src/panels/lovelace/editor/config-elements/hui-picture-glance-card-editor.ts
View File

@ -1,11 +1,24 @@
import { mdiGestureTap } from "@mdi/js";
import type { CSSResultGroup } from "lit";
import { html, LitElement, nothing } from "lit";
import { customElement, property, state } from "lit/decorators";
import { array, assert, assign, object, optional, string } from "superstruct";
import { mdiGestureTap } from "@mdi/js";
import memoizeOne from "memoize-one";
import {
array,
assert,
assign,
enums,
object,
optional,
string,
} from "superstruct";
import { fireEvent } from "../../../../common/dom/fire_event";
import type { LocalizeFunc } from "../../../../common/translations/localize";
import "../../../../components/ha-form/ha-form";
import type { SchemaUnion } from "../../../../components/ha-form/types";
import type {
HaFormSchema,
SchemaUnion,
} from "../../../../components/ha-form/types";
import type { ActionConfig } from "../../../../data/lovelace/config/action";
import type { HomeAssistant } from "../../../../types";
import type { PictureGlanceCardConfig } from "../../cards/types";
@ -26,78 +39,17 @@ const cardConfigStruct = assign(
image: optional(string()),
image_entity: optional(string()),
camera_image: optional(string()),
camera_view: optional(string()),
camera_view: optional(enums(["auto", "live"])),
aspect_ratio: optional(string()),
tap_action: optional(actionConfigStruct),
hold_action: optional(actionConfigStruct),
double_tap_action: optional(actionConfigStruct),
entities: array(entitiesConfigStruct),
theme: optional(string()),
fit_mode: optional(enums(["cover", "contain", "fill"])),
})
);
const SCHEMA = [
{ name: "title", selector: { text: {} } },
{ name: "image", selector: { image: {} } },
{
name: "image_entity",
selector: { entity: { domain: ["image", "person"] } },
},
{ name: "camera_image", selector: { entity: { domain: "camera" } } },
{
name: "",
type: "grid",
schema: [
{
name: "camera_view",
selector: { select: { options: ["auto", "live"] } },
},
{ name: "aspect_ratio", selector: { text: {} } },
],
},
{ name: "entity", selector: { entity: {} } },
{ name: "theme", selector: { theme: {} } },
{
name: "interactions",
type: "expandable",
flatten: true,
iconPath: mdiGestureTap,
schema: [
{
name: "tap_action",
selector: {
ui_action: {
default_action: "more-info",
},
},
},
{
name: "hold_action",
selector: {
ui_action: {
default_action: "more-info",
},
},
},
{
name: "",
type: "optional_actions",
flatten: true,
schema: [
{
name: "double_tap_action",
selector: {
ui_action: {
default_action: "none",
},
},
},
],
},
],
},
] as const;
@customElement("hui-picture-glance-card-editor")
export class HuiPictureGlanceCardEditor
extends LitElement
@ -109,6 +61,97 @@ export class HuiPictureGlanceCardEditor
@state() private _configEntities?: EntityConfig[];
private _schema = memoizeOne(
(localize: LocalizeFunc) =>
[
{ name: "title", selector: { text: {} } },
{ name: "image", selector: { image: {} } },
{
name: "image_entity",
selector: { entity: { domain: ["image", "person"] } },
},
{ name: "camera_image", selector: { entity: { domain: "camera" } } },
{
name: "",
type: "grid",
schema: [
{
name: "camera_view",
required: true,
selector: {
select: {
options: ["auto", "live"].map((value) => ({
value,
label: localize(
`ui.panel.lovelace.editor.card.generic.camera_view_options.${value}`
),
})),
mode: "dropdown",
},
},
},
{
name: "fit_mode",
required: true,
selector: {
select: {
options: ["cover", "contain", "fill"].map((value) => ({
value,
label: localize(
`ui.panel.lovelace.editor.card.generic.fit_mode_options.${value}`
),
})),
mode: "dropdown",
},
},
},
{ name: "aspect_ratio", selector: { text: {} } },
],
},
{ name: "entity", selector: { entity: {} } },
{ name: "theme", selector: { theme: {} } },
{
name: "interactions",
type: "expandable",
flatten: true,
iconPath: mdiGestureTap,
schema: [
{
name: "tap_action",
selector: {
ui_action: {
default_action: "more-info",
},
},
},
{
name: "hold_action",
selector: {
ui_action: {
default_action: "more-info",
},
},
},
{
name: "",
type: "optional_actions",
flatten: true,
schema: [
{
name: "double_tap_action",
selector: {
ui_action: {
default_action: "none",
},
},
},
],
},
],
},
] as const satisfies HaFormSchema[]
);
public setConfig(config: PictureGlanceCardConfig): void {
assert(config, cardConfigStruct);
this._config = config;
@ -128,14 +171,17 @@ export class HuiPictureGlanceCardEditor
return nothing;
}
const data = { camera_view: "auto", ...this._config };
const data = { camera_view: "auto", fit_mode: "cover", ...this._config };
const schema = this._schema(this.hass.localize);
return html`
<ha-form
.hass=${this.hass}
.data=${data}
.schema=${SCHEMA}
.schema=${schema}
.computeLabel=${this._computeLabelCallback}
.computeHelper=${this._computeHelperCallback}
@value-changed=${this._valueChanged}
></ha-form>
<div class="card-config">
@ -164,7 +210,9 @@ export class HuiPictureGlanceCardEditor
fireEvent(this, "config-changed", { config: this._config });
}
private _computeLabelCallback = (schema: SchemaUnion<typeof SCHEMA>) => {
private _computeLabelCallback = (
schema: SchemaUnion<ReturnType<typeof this._schema>>
) => {
switch (schema.name) {
case "theme":
case "tap_action":
@ -186,6 +234,21 @@ export class HuiPictureGlanceCardEditor
}
};
private _computeHelperCallback = (
schema: SchemaUnion<ReturnType<typeof this._schema>>
) => {
switch (schema.name) {
case "aspect_ratio":
return typeof this._config?.grid_options?.rows === "number"
? this.hass!.localize(
`ui.panel.lovelace.editor.card.generic.aspect_ratio_ignored`
)
: "";
default:
return "";
}
};
static styles: CSSResultGroup = configElementStyle;
}

11
src/translations/en.json
View File

@ -7194,13 +7194,24 @@
"generic": {
"alt_text": "Alternative text",
"aspect_ratio": "Aspect ratio",
"aspect_ratio_ignored": "Will be ignored because the card is resized.",
"attribute": "Attribute",
"camera_image": "Camera entity",
"image_entity": "Image entity",
"camera_view": "Camera view",
"camera_view_options": {
"auto": "Auto",
"live": "Live"
},
"double_tap_action": "Double tap behavior",
"entities": "Entities",
"entity": "Entity",
"fit_mode": "Fit mode",
"fit_mode_options": {
"contain": "Contain",
"cover": "Cover",
"fill": "Fill"
},
"hold_action": "Hold behavior",
"hours_to_show": "Hours to show",
"days_to_show": "Days to show",