diff --git a/README.md b/README.md index e533a7cb..9bca61ea 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ A full-featured Frigate Lovelace card: * Support for filtering events by zone and label. * Arbitrary entity access via menu (e.g. motion sensor access). * Fullscreen mode. +* Carousel/Swipeable media & thumbnails. +* Direct media downloads. * Lovelace visual editing support. * Full [Picture Elements](https://www.home-assistant.io/lovelace/picture-elements/) support. * Theme friendly. @@ -65,15 +67,20 @@ lovelace: ## Options -### Basic options +### Basic Options | Option | Default | Description | | - | - | - | | `camera_entity` | | The optional Frigate camera entity to use in the `frigate` live provider view. Also used to automatically detect the value of `frigate.camera_name`.| -### Frigate server options +### Frigate Server Options + +All configuration is under: + + ```yaml +frigate: +``` -All variables listed are under a `frigate:` section. | Option | Default | Description | | - | - | - | @@ -83,9 +90,14 @@ All variables listed are under a `frigate:` section. | `zone` | | A Frigate zone used to filter events (clips & snapshots), e.g. 'front_door'.| | `client_id` | `frigate` | The Frigate client id to use. If this Home Assistant server has multiple Frigate server backends configured, this selects which server should be used. It should be set to the MQTT client id configured for this server, see [Frigate Integration Multiple Instance Support](https://blakeblackshear.github.io/frigate/usage/home-assistant/#multiple-instance-support).| -### View options +### View Options + +All configuration is under: + + ```yaml +view: +``` -All variables listed are under a `view:` section. | Option | Default | Description | | - | - | - | @@ -93,30 +105,51 @@ All variables listed are under a `view:` section. | `timeout` | | A numbers of seconds of inactivity after which the card will reset to the default configured view. Inactivity is defined as lack of interaction with the Frigate menu.| | `actions` | | Actions to use for all views, individual actions may be overriden by view-specific actions. See [actions](#actions) below.| -### Menu options +### Menu Options -All variables listed are under a `menu:` section. +All configuration is under: + + ```yaml +menu: +``` | Option | Default | Description | | - | - | - | | `mode` | `hidden-top` | The menu mode to show by default. See [menu modes](#menu-modes) below.| -| `button_size` | `40px` | The size of the menu buttons (in CSS Units)[https://www.w3schools.com/cssref/css_units.asp].| -| `buttons.{frigate, live, clips, snapshots, image, download, frigate_ui, fullscreen}` | `true`, except for `image` | Whether or not to show these builtin actions in the card menu. | +| `button_size` | `40px` | The size of the menu buttons [in CSS Units](https://www.w3schools.com/cssref/css_units.asp).| +| `buttons` | | Whether to show or hide built-in buttons. See below. | | `conditions` | | Condition(s) that must be met in order for the menu to be displayed. These conditions use the same format as the `custom:frigate-card-conditional` card (see [Possible conditions](#frigate-card-conditions) below). If conditions are specified but not met, then the menu is not rendered.| -### Live options +#### Menu Options: Buttons -All variables listed are under a `live:` section. +All configuration is under: + +```yaml +menu: + buttons: +``` + +| Option | Default | Description | +| - | - | - | +| `{frigate, live, clips, snapshots, image, download, frigate_ui, fullscreen}` | `true`, except for `image` | Whether or not to show these builtin actions in the card menu. | + + +### Live Options + +All configuration is under: + + ```yaml +live: +``` | Option | Default | Description | | - | - | - | | `preload` | `false` | Whether or not to preload the live view. Preloading causes the live view to render in the background so it's instantly available when requested. This consumes additional network/CPU resources continually.| | `provider` | `frigate` | The means through which the live camera view is displayed. See [Live Provider](#live-provider) below.| -| `webrtc.url` | | The RTSP url to pass to WebRTC. Specify this OR `webrtc.entity` (below).| -| `webrtc.entity` | | The RTSP entity to pass WebRTC. Specify this OR `webrtc.url` (above). | -| `webrtc.*`| | Any other options in a `webrtc:` YAML dictionary are silently passed through to WebRTC. See [WebRTC Configuration](https://github.com/AlexxIT/WebRTC#configuration) for full details this external card provides.| | `actions` | | Actions to use for the `live` view. See [actions](#actions) below.| -| `jsmpeg.options.{audio, video, pauseWhenHidden, disableGl, disableWebAssembly, preserveDrawingBuffer, progressive, throttled, chunkSize, maxAudioLag, videoBufferSize, audioBufferSize}` | | **Advanced users only**: Control the underlying [JSMPEG library options](https://github.com/phoboslab/jsmpeg#usage). This is not necessary for the vast majority of users: only set these flags if you know what you're doing, as you may entirely break video rendering in the card.| +| `controls` | | Configuration for the `live` view controls. See below. | +| `jsmpeg` | | Configuration for the `frigate-jsmpeg` live provider. See below.| +| `webrtc` | | Configuration for the `webrtc` live provider. See below.| #### Available Live Providers @@ -126,39 +159,134 @@ All variables listed are under a `live:` section. |`frigate-jsmpeg`|Lower|Low|Builtin|Stream the JSMPEG stream from Frigate (proxied via the Frigate integration). See [note below on the required integration version](#jsmpeg-troubleshooting) for this live provider to function. This is the only live provider that can view the Frigate `birdseye` view.| |`webrtc`|Lowest|High|Separate installation required|Uses [WebRTC](https://github.com/AlexxIT/WebRTC) to stream live feed, requires manual extra setup, see [below](#webrtc).| -### Event Viewer options -The `event_viewer` is used for viewing all `clip` and `snapshot` media, in a media carousel. All variables listed are under an `event_viewer:` section. +#### Live Provider: JSMPEG Configuration + +All configuration is under: + +```yaml +live: + jsmpeg: +``` + +| Option | Default | Description | +| - | - | - | +| `options` | | **Advanced users only**: Control the underlying [JSMPEG library options](https://github.com/phoboslab/jsmpeg#usage). Supports setting these JSMPEG options `{audio, video, pauseWhenHidden, disableGl, disableWebAssembly, preserveDrawingBuffer, progressive, throttled, chunkSize, maxAudioLag, videoBufferSize, audioBufferSize}`. This is not necessary for the vast majority of users: only set these flags if you know what you're doing, as you may entirely break video rendering in the card.| + +#### Live Provider: WebRTC Configuration + +All configuration is under: + +```yaml +live: + webrtc: +``` + +| Option | Default | Description | +| - | - | - | +| `entity` | | The RTSP entity to pass WebRTC. Specify this OR `webrtc.url` (above). | +| `url` | | The RTSP url to pass to WebRTC. Specify this OR `webrtc.entity` (below).| +| `*`| | Any other options in the `webrtc:` YAML dictionary are silently passed through to WebRTC. See [WebRTC Configuration](https://github.com/AlexxIT/WebRTC#configuration) for full details this external card provides.| + +#### Live Controls: Thumbnails + +All configuration is under: + +```yaml +live: + controls: + thumbnails: +``` + +| Option | Default | Description | +| - | - | - | +| `mode` | `none` | Whether to show the thumbnail carousel `below` the media, `above` the media or to hide it entirely (`none`).| +| `size` | `100px` | The size of the thumbnails in the thumbnail carousel [in CSS Units](https://www.w3schools.com/cssref/css_units.asp).| +| `media` | `clips` | Whether to show `clips` or `snapshots` in the thumbnail carousel in the `live` view.| + +### Event Viewer Options + +The `event_viewer` is used for viewing all `clip` and `snapshot` media, in a media carousel. + +All configuration is under: + +```yaml +event_viewer: +``` + | Option | Default | Description | | - | - | - | | `autoplay_clip` | `false` | Whether or not to autoplay clips in the 'clip' [view](#views). Clips manually chosen in the clips gallery will still autoplay.| | `lazy_load` | `true` | Whether or not to lazily load media in the event viewer carousel. Setting this will false will fetch all media immediately which may make the carousel experience smoother at a cost of (potentially) a substantial number of simultaneous media fetches on load. | | `draggable` | `true` | Whether or not the event viewer carousel can be dragged left or right, via touch/swipe and mouse dragging. | -| `controls.next_previous.style` | `thumbnails` | When viewing media, what kind of controls to show to move to the previous/next media item. Acceptable values: `thumbnails`, `chevrons`, `none` . | -| `controls.next_previous.size` | `48px` | The size of the next/previous controls (in CSS Units)[https://www.w3schools.com/cssref/css_units.asp].| +| `controls` | | Configuration for the event viewer. See below. | | `actions` | | Actions to use for all views that use the `event_viewer` (e.g. `clip`, `snapshot`). See [actions](#actions) below.| -### Event Gallery options +#### Event Viewer Controls: Next / Previous -The `event_gallery` is used for providing an overview of all `clips` and `snapshots` in a thumbnail gallery. All variables listed are under a `event_gallery:` section. +All configuration is under: + +```yaml +event_viewer: + controls: + next_previous: +``` + +| Option | Default | Description | +| - | - | - | +| `style` | `thumbnails` | When viewing media, what kind of controls to show to move to the previous/next media item. Acceptable values: `thumbnails`, `chevrons`, `none` . | +| `size` | `48px` | The size of the next/previous controls [in CSS Units](https://www.w3schools.com/cssref/css_units.asp).| + +#### Event Viewer Controls: Thumbnails + +All configuration is under: + +```yaml +event_viewer: + controls: + thumbnails: +``` + +| Option | Default | Description | +| - | - | - | +| `mode` | `none` | Whether to show the thumbnail carousel `below` the media, `above` the media or to hide it entirely (`none`).| +| `size` | `100px` | The size of the thumbnails in the thumbnail carousel [in CSS Units](https://www.w3schools.com/cssref/css_units.asp).| + +### Event Gallery Options + +The `event_gallery` is used for providing an overview of all `clips` and `snapshots` in a thumbnail gallery. + +All configuration is under: + +```yaml +event_gallery: +``` | Option | Default | Description | | - | - | - | | `actions` | | Actions to use for all views that use the `event_gallery` (e.g. `clips`, `snapshots`). See [actions](#actions) below.| -### Image options +### Image Options -All variables listed are under a `image:` section. +All configuration is under: + +```yaml +image: +``` | Option | Default | Description | | - | - | - | | `src` | [embedded image](https://www.flickr.com/photos/dianasch/47543120431) | A static image URL for use with the `image` [view](#views).| | `actions` | | Actions to use for the `image` view. See [actions](#actions) below.| -### Dimension options +### Dimension Options -All variables listed are under a `dimensions:` section. +All configuration is under: + +```yaml +dimensions: +``` | Option | Default | Description | | - | - | - | @@ -179,7 +307,6 @@ All variables listed are under a `dimensions:` section. * `4 / 3` or `4:3`: Default fullscreen ratio. * `/` or `:`: Any arbitrary aspect-ratio. - #### Aspect Ratio @@ -216,7 +343,7 @@ events/snapshots/UI. A perfect combination! **Note**: WebRTC must be installed and configured separately (see [details](https://github.com/AlexxIT/WebRTC)) before it can be used with this card. -#### Specifying the WebRTC Camera +#### Specifying The WebRTC Camera WebRTC does **not** support use of Frigate-provided camera entities, as it requires an RTSP stream which Frigate does not provide. There are two ways to @@ -248,7 +375,7 @@ live: See [WebRTC configuration](https://github.com/AlexxIT/WebRTC#configuration) for full configuration options. -## Picture Elements / Menu customizations +## Picture Elements / Menu Customizations This card supports the [Picture Elements configuration syntax](https://www.home-assistant.io/lovelace/picture-elements/) to seamlessly @@ -329,7 +456,7 @@ This card supports several different views: |`clip`|Shows an event viewer for the most recent clip for this camera/zone/label. Can also be accessed by holding down the `clips` menu icon.| |`image`|Shows a static image specified by the `image` parameter, can be used as a discrete default view or a screensaver (via `view_timeout`).| -### Automatic updates in the `clip` or `snapshot` view +### Automatic Updates In The `clip` Or `snapshot` View Updates will occur whenever on every change of the state of the `camera_entity` or any entity configured under `update_entities`. In particular, if the desire is @@ -345,7 +472,7 @@ update_entities: See the [other options](#other-options) above. -### Getting from a snapshot to a clip +### Navigating From A Snapshot To A Clip Clicking on a snapshot will take the user to a clip that was taken at the ~same time as the snapshot (if any). @@ -398,10 +525,14 @@ This card supports several menu configurations. ## Screenshot: Snapshot / Clip Gallery -Full viewing of clips: +### Full Viewing Of Events Gallery +### Live Viewing With Thumbnail Carousel + +Live view with event thumbnails + ## Card Editing This card supports full editing via the Lovelace card editor. Additional arbitrary configuration for WebRTC may be specified in YAML mode. @@ -532,7 +663,7 @@ elements: -### Restricting icons to certain views +### Restricting Icons To Certain Views You can restrict icons to only show for certain [views](#views) using a `custom:frigate-card-conditional` element (e.g. PTZ controls) @@ -607,7 +738,7 @@ elements: -### Triggering card actions +### Triggering Card Actions You can control the card itself with the `custom:frigate-card-action` action. @@ -630,7 +761,7 @@ elements: ``` -### Adding card-wide actions +### Adding Card-wide Actions You can add actions to the card to be trigger on `tap`, `double_tap` or `hold`. See [actions](#actions) above. @@ -657,7 +788,7 @@ live: ``` -### Hiding the menu in certain circumstances +### Hiding The Menu In Certain Circumstances You can add conditions to the menu, which will hide the menu unless met. @@ -684,47 +815,14 @@ menu: -### JSMPEG live camera only shows a 'spinner' +### JSMPEG Live Camera Only Shows A 'spinner' You must be using a version of the [Frigate integration](https://github.com/blakeblackshear/frigate-hass-integration) >= 2.1.0 to use JSMPEG proxying. The `frigate-jsmpeg` live provider will not work with earlier integration versions. -### Fullscreen button does not appear on iPhone +### Fullscreen Button Does Not Appear On iPhone Unfortunately, [iOS does not support the Javascript fullscreen API](https://caniuse.com/fullscreen). As a result, card-level fullscreen support for the iPhone is not currently possible. - -### Failed to fetch - -**Note:** This error should no longer be possible >= v0.1.5 . - -`Failed to fetch` is a generic error indicating your browser (and this card) -could not communicate with the Frigate server specified in the card -configuration. This could be for any number of reasons (e.g. incorrect URL, -incorrect port, broken DNS, etc). - -If the 'globe' icon in the menu bar of the card also doesn't open the Frigate -UI, the address entered is probably incorrect/inaccessible. - -#### Mixed content - -**Note:** This error should no longer be possible >= v0.1.5 . - -If you are accessing your Home Assistant instance over `https`, you will likely -receive this error unless you have configured the card to also communicate with -Frigate via `https` (e.g. via a reverse proxy). This is because the browser is -blocking the attempt to mix access to both `https` and `http` resources. - -The javascript console ([how to access](https://javascript.info/devtools)) will -show an error such as: - -``` -Mixed Content: The page at '' was loaded over HTTPS, but requested an -insecure resource ''. This request has been blocked; the content must be -served over HTTPS. -``` - -Accessing both Home Assistant and Frigate over `https` will likely resolve this -issue (e.g. through the use of a reverse proxy in front of Frigate). diff --git a/images/live-thumbnails.gif b/images/live-thumbnails.gif new file mode 100644 index 00000000..df3b0fab Binary files /dev/null and b/images/live-thumbnails.gif differ diff --git a/src/card.ts b/src/card.ts index 520073a5..0fa946f0 100644 --- a/src/card.ts +++ b/src/card.ts @@ -41,11 +41,7 @@ import type { import { CARD_VERSION, REPO_URL } from './const.js'; import { FrigateCardElements } from './components/elements.js'; -import { - FRIGATE_BUTTON_MENU_ICON, - MENU_HEIGHT, - FrigateCardMenu, -} from './components/menu.js'; +import { FRIGATE_BUTTON_MENU_ICON, FrigateCardMenu } from './components/menu.js'; import { View } from './view.js'; import { convertActionToFrigateCardCustomAction, @@ -67,6 +63,7 @@ import './components/live.js'; import './components/menu.js'; import './components/message.js'; import './components/viewer.js'; +import './components/thumbnail-carousel.js'; import './patches/ha-camera-stream.js'; import './patches/ha-hls-player.js'; @@ -737,15 +734,21 @@ export class FrigateCard extends LitElement { * Get the parameters to search for media related to the current view. * @returns A BrowseMediaQueryParameters object. */ - protected _getBrowseMediaQueryParameters(): BrowseMediaQueryParameters | undefined { + protected _getBrowseMediaQueryParameters( + mediaType?: 'clips' | 'snapshots', + ): BrowseMediaQueryParameters | undefined { if ( !this._frigateCameraName || - !(this._view.isClipRelatedView() || this._view.isSnapshotRelatedView()) + !( + this._view.isClipRelatedView() || + this._view.isSnapshotRelatedView() || + mediaType + ) ) { return undefined; } return { - mediaType: this._view.isClipRelatedView() ? 'clips' : 'snapshots', + mediaType: mediaType || (this._view.isClipRelatedView() ? 'clips' : 'snapshots'), clientId: this.config.frigate.client_id, cameraName: this._frigateCameraName, label: this.config.frigate.label, @@ -913,41 +916,13 @@ export class FrigateCard extends LitElement { */ protected render(): TemplateResult | void { const padding = this._getAspectRatioPadding(); - const outerStyle = {}, - innerStyle = {}; + const outerStyle = {}; // Padding to force a particular aspect ratio. if (padding != null) { outerStyle['padding-top'] = `${padding}%`; } - // Special hacky treatment required when: - // - // - It's in fullscreen mode - // - It's viewing a media item - // - And the aspect ratio of the media item < aspect ratio of the window - // - // Cannot seem to scale the video by height in CSS without actually styling - // the underlying video element (which there is no access to as it's buried - // past multiple shadow roots), so instead scale the width in terms of'vh' - // (viewport height) in proportion to the aspect-ratio of the media. - if ( - screenfull.isEnabled && - screenfull.isFullscreen && - this._view.isMediaView() && - this._mediaShowInfo && - this._mediaShowInfo.width / this._mediaShowInfo.height < - window.innerWidth / window.innerHeight - ) { - // If the menu is outside the media (i.e. above/below) allow space for it. - const allowance = ['above', 'below'].includes(this.config.menu.mode) - ? MENU_HEIGHT - : 0; - innerStyle['max-width'] = `calc(${ - (100 * this._mediaShowInfo.width) / this._mediaShowInfo.height - }vh - ${allowance}px )`; - } - const contentClasses = { 'frigate-card-contents': true, absolute: padding != null, @@ -965,7 +940,7 @@ export class FrigateCard extends LitElement { > ${this.config.menu.mode == 'above' ? this._renderMenu() : ''}
-
+
${this._frigateCameraName == undefined ? until( (async () => { @@ -997,7 +972,6 @@ export class FrigateCard extends LitElement { true, ); } - const mediaQueryParameters = this._getBrowseMediaQueryParameters(); const pictureElementsClasses = { 'picture-elements': true, @@ -1032,7 +1006,7 @@ export class FrigateCard extends LitElement { ? html` { - conditionStateRequestHandler(ev, this._conditionState) + conditionStateRequestHandler(ev, this._conditionState); }} > diff --git a/src/components/carousel.ts b/src/components/carousel.ts new file mode 100644 index 00000000..cd8da910 --- /dev/null +++ b/src/components/carousel.ts @@ -0,0 +1,79 @@ +import { + CSSResultGroup, + LitElement, + unsafeCSS, + PropertyValues, +} from 'lit'; +import EmblaCarousel, { EmblaCarouselType, EmblaOptionsType } from 'embla-carousel'; + +import { dispatchFrigateCardEvent } from '../common'; + +import carouselStyle from '../scss/carousel.scss'; + +export interface CarouselSelect { + index: number; +} + +export class FrigateCardCarousel extends LitElement { + protected _options?: EmblaOptionsType; + protected _carousel?: EmblaCarouselType; + + /** + * Scroll to a particular slide. + * @param index Slide number. + */ + carouselScrollTo(index: number): void { + this._carousel?.scrollTo(index); + } + + /** + * Get the selected slide. + * @returns The slide index or undefined if the carousel is not loaded. + */ + carouselSelected(): number | undefined { + return this._carousel?.selectedScrollSnap(); + } + + /** + * The updated lifecycle callback for this element. + * @param changedProperties The properties that were changed in this render. + */ + updated(changedProperties: PropertyValues): void { + super.updated(changedProperties); + + if (!this._carousel) { + this.updateComplete.then(() => { + this._loadCarousel(); + }); + } + } + + /** + * Load the carousel with "slides". + */ + protected _loadCarousel(): void { + const carouselNode = this.renderRoot.querySelector( + '.embla__viewport', + ) as HTMLElement; + + if (!this._carousel && carouselNode) { + this._carousel = EmblaCarousel(carouselNode, this._options); + this._carousel.on('init', () => dispatchFrigateCardEvent(this, 'carousel:init')); + this._carousel.on('select', () => { + const selected = this.carouselSelected(); + if (selected !== undefined) { + dispatchFrigateCardEvent(this, 'carousel:select', { + index: selected, + }); + } + }); + } + } + + /** + * Get element styles. + */ + static get styles(): CSSResultGroup { + return unsafeCSS(carouselStyle); + } +} diff --git a/src/components/gallery.ts b/src/components/gallery.ts index e4751776..214f821b 100644 --- a/src/components/gallery.ts +++ b/src/components/gallery.ts @@ -131,7 +131,7 @@ export class FrigateCardGalleryCore extends LitElement { protected _resizeHandler(): void { this._columns = Math.max( DEFAULT_COLUMNS, - Math.floor(this.clientWidth / MAX_THUMBNAIL_WIDTH), + Math.ceil(this.clientWidth / MAX_THUMBNAIL_WIDTH), ); } @@ -146,8 +146,8 @@ export class FrigateCardGalleryCore extends LitElement { } const styles = { - // Controls the number of columns in the gallery (allows for 1px gutter). - width: `calc(${100 / this._columns}% - 1.2px)`, + // Controls the number of columns in the gallery (allows for 5px gutter). + width: `calc(${100 / this._columns}% - 5.25px)`, }; return html`
    diff --git a/src/components/live.ts b/src/components/live.ts index 264a3418..90b7b537 100644 --- a/src/components/live.ts +++ b/src/components/live.ts @@ -1,5 +1,6 @@ import { CSSResultGroup, LitElement, TemplateResult, html, unsafeCSS } from 'lit'; import type { + BrowseMediaQueryParameters, ExtendedHomeAssistant, FrigateCardConfig, JSMPEGConfig, @@ -25,6 +26,12 @@ import { renderProgressIndicator } from '../components/message.js'; import JSMpeg from '@cycjimmy/jsmpeg-player'; import liveStyle from '../scss/live.scss'; +import liveFrigateStyle from '../scss/live-frigate.scss'; +import liveJSMPEGStyle from '../scss/live-jsmpeg.scss'; +import liveWebRTCStyle from '../scss/live-webrtc.scss'; + +import { View } from '../view.js'; +import { ThumbnailCarouselTap } from './thumbnail-carousel.js'; // Number of seconds a signed URL is valid for. const URL_SIGN_EXPIRY_SECONDS = 24 * 60 * 60; @@ -41,7 +48,7 @@ export class FrigateCardLive extends LitElement { protected config?: FrigateCardConfig; @property({ attribute: false }) - protected frigateCameraName?: string; + protected browseMediaQueryParameters?: BrowseMediaQueryParameters; @property({ attribute: false }) set preload(preload: boolean) { @@ -72,6 +79,33 @@ export class FrigateCardLive extends LitElement { } } + /** + * Render thumbnails carousel. + * @returns A rendered template or void. + */ + protected renderThumbnails(): TemplateResult | void { + if (!this.config) { + return; + } + return html` ) => { + const mediaType = this.browseMediaQueryParameters?.mediaType; + if (mediaType && ['snapshots', 'clips'].includes(mediaType)) { + new View({ + view: mediaType === 'clips' ? 'clip-specific' : 'snapshot-specific', + target: ev.detail.target, + childIndex: ev.detail.childIndex, + }).dispatchChangeEvent(this); + } + }} + > + `; + } + /** * Master render method. * @returns A rendered template. @@ -81,28 +115,36 @@ export class FrigateCardLive extends LitElement { return; } - return html` ${this.config.live.provider == 'frigate' - ? html` - ` - : this.config.live.provider == 'webrtc' - ? html` - ` - : html` - `}`; + return html` + ${this.config.live.controls.thumbnails.mode === 'above' + ? this.renderThumbnails() + : ''} + ${this.config.live.provider == 'frigate' + ? html` + ` + : this.config.live.provider == 'webrtc' + ? html` + ` + : html` + `} + ${this.config.live.controls.thumbnails.mode === 'below' + ? this.renderThumbnails() + : ''} + `; } /** @@ -150,7 +192,7 @@ export class FrigateCardLiveFrigate extends LitElement { * Get styles. */ static get styles(): CSSResultGroup { - return unsafeCSS(liveStyle); + return unsafeCSS(liveFrigateStyle); } } @@ -237,7 +279,7 @@ export class FrigateCardLiveWebRTC extends LitElement { * Get styles. */ static get styles(): CSSResultGroup { - return unsafeCSS(liveStyle); + return unsafeCSS(liveWebRTCStyle); } } @@ -415,6 +457,6 @@ export class FrigateCardLiveJSMPEG extends LitElement { * Get styles. */ static get styles(): CSSResultGroup { - return unsafeCSS(liveStyle); + return unsafeCSS(liveJSMPEGStyle); } } diff --git a/src/components/menu.ts b/src/components/menu.ts index 29625e4e..0b8bd3ef 100644 --- a/src/components/menu.ts +++ b/src/components/menu.ts @@ -28,7 +28,6 @@ import { import menuStyle from '../scss/menu.scss'; import { ConditionState, evaluateCondition } from '../card-condition.js'; -export const MENU_HEIGHT = 46; export const FRIGATE_BUTTON_MENU_ICON = 'frigate'; /** @@ -46,7 +45,7 @@ export class FrigateCardMenu extends LitElement { this.style.setProperty('--frigate-card-menu-button-size', menuConfig.button_size); } } - public _menuConfig?: MenuConfig; + protected _menuConfig?: MenuConfig; @property({ attribute: false }) protected expand = false; diff --git a/src/components/thumbnail-carousel.ts b/src/components/thumbnail-carousel.ts new file mode 100644 index 00000000..6bc62704 --- /dev/null +++ b/src/components/thumbnail-carousel.ts @@ -0,0 +1,204 @@ +import { BrowseMediaUtil } from '../browse-media-util.js'; +import { CSSResultGroup, TemplateResult, html, unsafeCSS, LitElement } from 'lit'; +import { customElement, property } from 'lit/decorators.js'; +import { until } from 'lit/directives/until'; + +import type { BrowseMediaQueryParameters, BrowseMediaSource, ExtendedHomeAssistant, ThumbnailsControlConfig } from '../types.js'; +import { FrigateCardCarousel } from './carousel.js'; +import { HomeAssistant } from 'custom-card-helpers'; +import { actionHandler } from '../action-handler-directive.js'; +import { dispatchErrorMessageEvent, dispatchFrigateCardEvent } from '../common.js'; +import { renderProgressIndicator } from './message.js'; + +import thumbnailCarouselStyle from '../scss/thumbnail-carousel.scss'; + +export interface ThumbnailCarouselTap { + slideIndex: number; + target: BrowseMediaSource; + childIndex: number; +} + +@customElement('frigate-card-thumbnail-carousel') +export class FrigateCardThumbnailCarousel extends LitElement { + @property({ attribute: false }) + protected hass?: HomeAssistant & ExtendedHomeAssistant; + + @property({ attribute: false }) + protected browseMediaQueryParameters?: BrowseMediaQueryParameters; + + @property({ attribute: false }) + protected config?: ThumbnailsControlConfig; + + @property({ attribute: false }) + protected highlightSelected = true; + + /** + * Master render method. + * @returns A rendered template. + */ + protected render(): TemplateResult | void { + return html`${until(this._render(), renderProgressIndicator())}`; + } + + /** + * Asyncronously render the element. + * @returns A rendered template. + */ + protected async _render(): Promise { + if (!this.hass || !this.browseMediaQueryParameters) { + return html``; + } + + let parent: BrowseMediaSource | null = null; + try { + parent = await BrowseMediaUtil.browseMediaQuery( + this.hass, + this.browseMediaQueryParameters, + ); + } catch (e) { + return dispatchErrorMessageEvent(this, (e as Error).message); + } + return html` + `; + } +} + +@customElement('frigate-card-thumbnail-carousel-core') +export class FrigateCardThumbnailCarouselCore extends FrigateCardCarousel { + @property({ attribute: false }) + protected target?: BrowseMediaSource; + + protected _tapSelected?; + + @property({ attribute: false }) + set config(config: ThumbnailsControlConfig | undefined) { + if (config) { + if (config && (config.size !== undefined && config.size !== null)) { + this.style.setProperty('--frigate-card-carousel-thumbnail-size', config.size); + } + this._config = config; + } + } + protected _config?: ThumbnailsControlConfig; + + @property({ attribute: false }) + set highlightSelected(value: boolean) { + this.style.setProperty('--frigate-card-carousel-thumbnail-opacity', value ? '0.6' : '1.0'); + } + + constructor() { + super(); + this._options = { + containScroll: 'keepSnaps', + dragFree: true, + }; + } + + /** + * Scroll to a particular slide. + * @param index Slide number. + */ + carouselScrollTo(index: number): void { + if (!this._carousel) { + return; + } + + if (this._tapSelected !== undefined) { + this._carousel.slideNodes()[this._tapSelected].classList.remove('slide-selected'); + } + + super.carouselScrollTo(index); + + this._carousel.slideNodes()[index].classList.add('slide-selected'); + this._tapSelected = index; + } + + /** + * Get slides to include in the render. + * @returns The slides to include in the render. + */ + protected _getSlides(): TemplateResult[] { + if (!this.target || !this.target.children || !this.target.children.length) { + return []; + } + + const slides: TemplateResult[] = []; + for (let i = 0; i < this.target.children.length; ++i) { + const thumbnail = this._renderThumbnail( + this.target, + i, + slides.length); + if (thumbnail) { + slides.push(thumbnail); + } + } + return slides; + } + + /** + * Render a given thumbnail. + * @param mediaToRender The media item to render. + * @returns A template or void if the item could not be rendered. + */ + protected _renderThumbnail( + parent: BrowseMediaSource, + childIndex: number, + slideIndex: number, + ): TemplateResult | void { + if (!parent.children || !parent.children.length) { + return; + } + + const mediaToRender = parent.children[childIndex]; + if (!BrowseMediaUtil.isTrueMedia(mediaToRender) || !mediaToRender.thumbnail) { + return; + } + + return html`
    { + if (this._carousel && this._carousel.clickAllowed()) { + dispatchFrigateCardEvent(this, 'carousel:tap', { + slideIndex: slideIndex, + target: parent, + childIndex: childIndex, + }); + } + }} + > + +
    `; + } + + /** + * Render the element. + * @returns A template to display to the user. + */ + protected render(): TemplateResult | void { + const slides = this._getSlides(); + if (!slides || !this._config || this._config.mode == 'none') { + return; + } + + return html`
    +
    +
    ${slides}
    +
    +
    `; + } + + /** + * Get element styles. + */ + static get styles(): CSSResultGroup { + return [super.styles, unsafeCSS(thumbnailCarouselStyle)]; + } +} diff --git a/src/components/viewer.ts b/src/components/viewer.ts index f54abb40..89e2aa19 100644 --- a/src/components/viewer.ts +++ b/src/components/viewer.ts @@ -1,14 +1,8 @@ -import { - CSSResultGroup, - LitElement, - TemplateResult, - html, - unsafeCSS, - PropertyValues, -} from 'lit'; +import { CSSResultGroup, LitElement, TemplateResult, html, unsafeCSS } from 'lit'; import { BrowseMediaUtil } from '../browse-media-util.js'; -import EmblaCarousel, { EmblaCarouselType } from 'embla-carousel'; +import { EmblaCarouselType } from 'embla-carousel'; import { HomeAssistant } from 'custom-card-helpers'; +import { createRef, Ref, ref } from 'lit/directives/ref.js'; import { customElement, property } from 'lit/decorators.js'; import { ifDefined } from 'lit-html/directives/if-defined.js'; import { until } from 'lit/directives/until.js'; @@ -21,8 +15,11 @@ import type { MediaShowInfo, ViewerConfig, } from '../types.js'; +import { FrigateCardCarousel } from './carousel.js'; +import { FrigateCardThumbnailCarouselCore, ThumbnailCarouselTap } from './thumbnail-carousel.js'; import { ResolvedMediaCache, ResolvedMediaUtil } from '../resolved-media.js'; import { View } from '../view.js'; +import { actionHandler } from '../action-handler-directive.js'; import { createMediaShowInfo, dispatchErrorMessageEvent, @@ -38,7 +35,8 @@ import { renderProgressIndicator } from '../components/message.js'; import './next-prev-control.js'; import viewerStyle from '../scss/viewer.scss'; -import { actionHandler } from '../action-handler-directive.js'; +import viewerCoreStyle from '../scss/viewer-core.scss'; +import mediaCarouselStyle from '../scss/media-carousel.scss'; const getEmptyImageSrc = (width: number, height: number) => `data:image/svg+xml,%3Csvg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${width} ${height}"%3E%3C/svg%3E`; @@ -166,9 +164,80 @@ export class FrigateCardViewerCore extends LitElement { @property({ attribute: false }) protected resolvedMediaCache?: ResolvedMediaCache; - // Media carousel object. - protected _carousel?: EmblaCarouselType; - protected _loadedCarousel = false; + protected _mediaCarouselRef: Ref = createRef(); + protected _thumbnailCarouselRef: Ref = createRef(); + + protected _syncThumbnailCarousel(): void { + const mediaSelected = this._mediaCarouselRef.value?.carouselSelected(); + if (mediaSelected !== undefined) { + this._thumbnailCarouselRef.value?.carouselScrollTo(mediaSelected); + } + } + + protected _renderThumbnails(): TemplateResult { + if (!this.view || !this.viewerConfig) { + return html``; + } + + return html` ) => { + this._mediaCarouselRef.value?.carouselScrollTo(ev.detail.slideIndex); + }} + @frigate-card:carousel:init=${this._syncThumbnailCarousel.bind(this)} + > + `; + } + + protected render(): TemplateResult | void { + if (!this.view || !this.viewerConfig) { + return html``; + } + return html` ${this.viewerConfig && + this.viewerConfig.controls.thumbnails.mode === 'above' + ? this._renderThumbnails() + : ''} + + + ${this.viewerConfig && this.viewerConfig.controls.thumbnails.mode === 'below' + ? this._renderThumbnails() + : ''}`; + } + + /** + * Get element styles. + */ + static get styles(): CSSResultGroup { + return unsafeCSS(viewerCoreStyle); + } +} + +@customElement('frigate-card-media-carousel') +export class FrigateCardMediaCarousel extends FrigateCardCarousel { + @property({ attribute: false }) + protected hass?: HomeAssistant & ExtendedHomeAssistant; + + @property({ attribute: false }) + protected view?: View; + + @property({ attribute: false }) + protected viewerConfig?: ViewerConfig; + + @property({ attribute: false }) + protected browseMediaQueryParameters?: BrowseMediaQueryParameters; + + @property({ attribute: false }) + protected resolvedMediaCache?: ResolvedMediaCache; // Mapping of slide # to BrowseMediaSource child #. // (Folders are not media items that can be rendered). @@ -180,53 +249,42 @@ export class FrigateCardViewerCore extends LitElement { // Whether or not a given slide has been successfully lazily loaded. protected _slideHasBeenLazyLoaded: Record = {}; - /** - * The updated lifecycle callback for this element. - * @param changedProperties The properties that were changed in this render. - */ - updated(changedProperties: PropertyValues): void { - super.updated(changedProperties); - - if (!this._loadedCarousel) { - this.updateComplete.then(() => { - this._loadCarousel(); - }); - } - } - /** * Load the carousel with "slides" (clips or snapshots). */ protected _loadCarousel(): void { - const carouselNode = this.renderRoot.querySelector( - '.embla__viewport', - ) as HTMLElement; - - if (carouselNode && this.viewerConfig) { - this._loadedCarousel = true; - - // Start the carousel on the selected child number. - const startIndex = Number( - Object.keys(this._slideToChild).find( - (key) => this._slideToChild[key] === this.view?.childIndex, - ), - ); - - this._carousel = EmblaCarousel(carouselNode, { - startIndex: isNaN(startIndex) ? undefined : startIndex, - draggable: this.viewerConfig.draggable, - }); - // Update views and dispatch media-show events based on slide selections. - this._carousel.on('select', this._selectSlideSetViewHandler.bind(this)); - this._carousel.on('select', this._selectSlideMediaShowHandler.bind(this)); - - // Lazily load media that is displayed. These handlers are registered - // regardless of the value of this.lazyLoad to allow that value to change - // after the carousel has been initialized. - this._carousel.on('init', this._lazyLoadMediaHandler.bind(this)); - this._carousel.on('select', this._lazyLoadMediaHandler.bind(this)); - this._carousel.on('resize', this._lazyLoadMediaHandler.bind(this)); + if (this._carousel || !this.viewerConfig) { + return; } + + // Start the carousel on the selected child number. + const startIndex = Number( + Object.keys(this._slideToChild).find( + (key) => this._slideToChild[key] === this.view?.childIndex, + ), + ); + + this._options = { + startIndex: isNaN(startIndex) ? undefined : startIndex, + draggable: this.viewerConfig.draggable, + }; + + super._loadCarousel(); + + // Necessary because typescript local type narrowing is not paying attention + // to the side-effect of the call to super._loadCarousel(). + const carousel = this._carousel as EmblaCarouselType | undefined; + + // Update views and dispatch media-show events based on slide selections. + carousel?.on('select', this._selectSlideSetViewHandler.bind(this)); + carousel?.on('select', this._selectSlideMediaShowHandler.bind(this)); + + // Lazily load media that is displayed. These handlers are registered + // regardless of the value of this.lazyLoad to allow that value to change + // after the carousel has been initialized. + carousel?.on('init', this._lazyLoadMediaHandler.bind(this)); + carousel?.on('select', this._lazyLoadMediaHandler.bind(this)); + carousel?.on('resize', this._lazyLoadMediaHandler.bind(this)); } /** @@ -451,35 +509,45 @@ export class FrigateCardViewerCore extends LitElement { } /** - * Render the element. - * @returns A template to display to the user. + * Get slides to include in the render. + * @returns The slides to include in the render. */ - protected render(): TemplateResult | void { + protected _getSlides(): TemplateResult[] { if ( !this.view || !this.view.target || !this.view.target.children || - !this.view.target.children.length || - this.view.childIndex === undefined || - !this.resolvedMediaCache + !this.view.target.children.length ) { - return html``; + return []; } - const slides: TemplateResult[] = []; this._slideToChild = {}; - + const slides: TemplateResult[] = []; for (let i = 0; i < this.view.target.children?.length; ++i) { const slide = this._renderMediaItem(this.view.target.children[i], slides.length); + if (slide) { this._slideToChild[slides.length] = i; slides.push(slide); } } + return slides; + } + + /** + * Render the element. + * @returns A template to display to the user. + */ + protected render(): TemplateResult | void { + const slides = this._getSlides(); + if (!slides) { + return; + } const neighbors = this._getMediaNeighbors(); - return html`
    + return html`
    ${neighbors && neighbors.previous ? html`` : ``} -
    -
    -
    ${slides}
    -
    +
    +
    ${slides}
    ${neighbors && neighbors.next ? html` + + + ${Object.keys(thumbnailModes).map((key) => { + return html` + + ${thumbnailModes[key]} + + `; + })} + + + + + ${Object.keys(thumbnailMedias).map((key) => { + return html` + + ${thumbnailMedias[key]} + + `; + })} + + +
    ` : ''} @@ -678,6 +762,44 @@ export class FrigateCardEditor extends LitElement implements LovelaceCardEditor .configValue=${CONF_EVENT_VIEWER_CONTROLS_NEXT_PREVIOUS_SIZE} @value-changed=${this._valueChangedHandler} > + + + ${Object.keys(thumbnailModes).map((key) => { + return html` + + ${thumbnailModes[key]} + + `; + })} + + +
    ` : ''}
    { : ''} `; } + + static get styles(): CSSResultGroup { + return [ + super.styles, + css` + :host { + width: 100%; + height: 100%; + }` + ]; + } } }); diff --git a/src/patches/ha-hls-player.ts b/src/patches/ha-hls-player.ts index bf988b76..4e8cbce5 100644 --- a/src/patches/ha-hls-player.ts +++ b/src/patches/ha-hls-player.ts @@ -9,8 +9,9 @@ // available as compilation time. // ==================================================================== -import { TemplateResult, html } from 'lit'; +import { TemplateResult, css, html } from 'lit'; import { customElement } from 'lit/decorators.js'; + import { dispatchMediaShowEvent, dispatchPauseEvent, @@ -44,5 +45,22 @@ customElements.whenDefined('ha-hls-player').then(() => { > `; } + + static get styles(): CSSResultGroup { + return [ + super.styles, + css` + :host { + width: 100%; + height: 100%; + } + video { + object-fit: contain; + height: 100%; + width: 100%; + } + ` + ] + } } }); diff --git a/src/scss/card.scss b/src/scss/card.scss index 2a1d6445..8bf73f30 100644 --- a/src/scss/card.scss +++ b/src/scss/card.scss @@ -47,7 +47,8 @@ /* A relative div to place absolute picture elements onto */ .picture-elements { position: relative; - width: inherit; + width: 100%; + height: 100%; } /* Enforce picture elements to only be the size of the card/fullscreen (and not @@ -68,13 +69,6 @@ ha-card { background-color: var(--secondary-background-color, black); } -frigate-card-gallery, frigate-card-viewer, frigate-card-live, frigate-card-message, frigate-card-error-message { - width: 100%; - display: block; -} -frigate-card-gallery { - height: 100%; -} frigate-card-gallery.hidden,frigate-card-viewer.hidden,frigate-card-live.hidden { display: none; } diff --git a/src/scss/carousel.scss b/src/scss/carousel.scss new file mode 100644 index 00000000..66ea1971 --- /dev/null +++ b/src/scss/carousel.scss @@ -0,0 +1,55 @@ +:host { + display: block; + height: 100%; + width: 100%; +} + +img,video { + width: 100%; + height: 100%; + display: block; +} + +.embla { + width: 100%; + height: 100%; + position: relative; + margin-left: auto; + margin-right: auto; +} + +.embla__container { + display: flex; + width: 100%; + height: 100%; + + user-select: none; + -webkit-touch-callout: none; + -khtml-user-select: none; + -webkit-tap-highlight-color: transparent; +} + +.embla__viewport { + width: 100%; + height: 100%; + overflow: hidden; +} +.embla__viewport.is-draggable { + cursor: move; + cursor: grab; +} +.embla__viewport.is-dragging { + cursor: grabbing; +} + +.embla__slide { + position: relative; + height: 100%; + margin-right: 5px; + overflow: visible; +} +.embla__slide img,video { + // Letterbox media. has similar added directly in + // its element. + object-fit: contain; +} \ No newline at end of file diff --git a/src/scss/gallery.scss b/src/scss/gallery.scss index 9df685f1..57cefaa2 100644 --- a/src/scss/gallery.scss +++ b/src/scss/gallery.scss @@ -3,6 +3,8 @@ :host { display: block; + width: 100%; + height: 100%; overflow: auto; -ms-overflow-style: none; /* Hide scrollbar: IE and Edge */ scrollbar-width: none; /* Hide scrollbar: Firefox */ @@ -16,20 +18,27 @@ .frigate-card-gallery { // Note: In fullscreen, number of columns is overwritten in Javascript based // on dimensions. - @include image-list.standard-columns(5, 1px); + @include image-list.standard-columns(4, 5px); @include image-list.shape-radius(5px); } +.frigate-card-gallery .mdc-image-list__image { + transition: transform 0.2s linear; +} +.frigate-card-gallery .mdc-image-list__image:hover { + transform: scale(1.04); +} + ha-card.frigate-card-gallery-folder { display: flex; justify-content: center; align-items: center; box-sizing: border-box; text-align: center; - border-style: 2px solid; opacity: 0.7; color: var(--secondary-text-color, white); - border-color: var(--secondary-text-color, black); + border: 2px ridge var(--secondary-text-color, black); + border-radius: 5px; background-color: var(--primary-background-color, black); padding: 10px; height: 100%; diff --git a/src/scss/live-frigate.scss b/src/scss/live-frigate.scss new file mode 100644 index 00000000..a9b9a68b --- /dev/null +++ b/src/scss/live-frigate.scss @@ -0,0 +1,7 @@ +:host { + width: 100%; + height: 100%; + display: block; + + --video-max-height: none; +} \ No newline at end of file diff --git a/src/scss/live-jsmpeg.scss b/src/scss/live-jsmpeg.scss new file mode 100644 index 00000000..9f7cbf2c --- /dev/null +++ b/src/scss/live-jsmpeg.scss @@ -0,0 +1,12 @@ +:host { + width: 100%; + height: 100%; + display: block; +} + +canvas { + display: block; + width: 100%; + height: 100%; + object-fit: contain; +} \ No newline at end of file diff --git a/src/scss/live-webrtc.scss b/src/scss/live-webrtc.scss new file mode 100644 index 00000000..8297c2d8 --- /dev/null +++ b/src/scss/live-webrtc.scss @@ -0,0 +1,12 @@ +:host { + width: 100%; + height: 100%; + display: block; +} + +/* Don't drop shadow or have radius for nested webrtc card */ +webrtc-camera ha-card { + box-shadow: none; + border-radius: 0px; + background-color: var(--secondary-background-color, black); +} \ No newline at end of file diff --git a/src/scss/live.scss b/src/scss/live.scss index 13a89892..850a3197 100644 --- a/src/scss/live.scss +++ b/src/scss/live.scss @@ -1,15 +1,16 @@ :host { - --video-max-height: none; -} - -canvas { width: 100%; - display: block; + height: 100%; + display: flex; + flex-direction: column; + gap: 5px; } -/* Don't drop shadow or have radius for nested webrtc card */ -webrtc-camera ha-card { - box-shadow: none; - border-radius: 0px; - background-color: var(--secondary-background-color, black); +frigate-card-live { + flex: 1; + min-height: 0; +} + +frigate-card-thumbnail-carousel { + flex: 0 0 var(--frigate-card-carousel-thumbnail-size); } \ No newline at end of file diff --git a/src/scss/media-carousel.scss b/src/scss/media-carousel.scss new file mode 100644 index 00000000..39c877d0 --- /dev/null +++ b/src/scss/media-carousel.scss @@ -0,0 +1,13 @@ +:host { + --video-max-height: none; +} + +.embla__slide { + flex: 0 0 100%; +} + +frigate-card-ha-hls-player { + height: 100%; + width: 100%; + transform-style: preserve-3d; +} \ No newline at end of file diff --git a/src/scss/message.scss b/src/scss/message.scss index 54727410..21181063 100644 --- a/src/scss/message.scss +++ b/src/scss/message.scss @@ -1,5 +1,7 @@ :host { height: 100%; + width: 100%; + display: block; } .message { diff --git a/src/scss/thumbnail-carousel.scss b/src/scss/thumbnail-carousel.scss new file mode 100644 index 00000000..b3feefa8 --- /dev/null +++ b/src/scss/thumbnail-carousel.scss @@ -0,0 +1,24 @@ +:host { + --frigate-card-carousel-thumbnail-size: 100px; + --frigate-card-carousel-thumbnail-opacity: 0.6; +} + +.embla__slide { + flex: 0 0 var(--frigate-card-carousel-thumbnail-size); + opacity: var(--frigate-card-carousel-thumbnail-opacity); + transition: opacity 0.6s ease, transform 0.2s linear; +} +.embla__slide.slide-selected { + opacity: 1.0; +} +.embla__slide:hover { + transform: scale(1.04); +} +.embla__slide img { + border-radius: 5px; + + // Not 'contain' as some thumbnails may vary in aspect-ratio slightly and + // should be clipped to fill the thumbnail div whilst maintaining + // aspect-ratio. + object-fit: cover; +} \ No newline at end of file diff --git a/src/scss/viewer-core.scss b/src/scss/viewer-core.scss new file mode 100644 index 00000000..7dcf4a98 --- /dev/null +++ b/src/scss/viewer-core.scss @@ -0,0 +1,17 @@ +:host { + display: flex; + flex-direction: column; + gap: 5px; + + height: 100%; + width: 100%; +} + +frigate-card-media-carousel { + flex: 1; + min-height: 0; +} + +frigate-card-thumbnail-carousel-core { + flex: 0 0 var(--frigate-card-carousel-thumbnail-size); +} \ No newline at end of file diff --git a/src/scss/viewer.scss b/src/scss/viewer.scss index e9359202..e792d174 100644 --- a/src/scss/viewer.scss +++ b/src/scss/viewer.scss @@ -1,54 +1,5 @@ :host { - --video-max-height: none; -} - -ha-hls-player { - transform-style: preserve-3d; -} - -img,video { + height: 100%; width: 100%; - height: auto; display: block; } - -div.container { - // Keep the controls positioned relative to the video. - position: relative; -} - -.embla { - position: relative; - margin-left: auto; - margin-right: auto; -} - -.embla__viewport { - overflow: hidden; - width: 100%; -} - -.embla__container { - display: flex; - user-select: none; - -webkit-touch-callout: none; - -khtml-user-select: none; - -webkit-tap-highlight-color: transparent; -} - -.embla__viewport.is-draggable { - cursor: move; - cursor: grab; -} - -.embla__viewport.is-dragging { - cursor: grabbing; -} - -.embla__slide { - position: relative; - min-width: 100%; - max-width: 100%; - margin-right: 10px; - overflow: hidden; -} \ No newline at end of file diff --git a/src/types.ts b/src/types.ts index 68d2e67d..73abcb01 100644 --- a/src/types.ts +++ b/src/types.ts @@ -355,12 +355,29 @@ const imageConfigSchema = z .optional(); export type ImageViewConfig = z.infer; +/** + * Thumbnail controls configuration section. + */ + +// This type is not inferred from a schema since different (compatible) schemas +// have different defaults. +export type ThumbnailsControlConfig = { + mode: 'above' | 'below' | 'none'; + size?: string; +} + /** * Live view configuration section. */ const liveConfigDefault = { provider: 'frigate' as const, preload: false, + controls: { + thumbnails: { + mode: 'none' as const, + media: 'clips' as const, + }, + }, }; const webrtcConfigSchema = z .object({ @@ -400,6 +417,19 @@ const liveConfigSchema = z preload: z.boolean().default(liveConfigDefault.preload), webrtc: webrtcConfigSchema, jsmpeg: jsmpegConfigSchema, + controls: z + .object({ + thumbnails: z + .object({ + media: z + .enum(['clips', 'snapshots']) + .default(liveConfigDefault.controls.thumbnails.media), + mode: z.enum(['none', 'above', 'below']).default(liveConfigDefault.controls.thumbnails.mode), + size: z.string().optional(), + }) + .default(liveConfigDefault.controls.thumbnails), + }) + .default(liveConfigDefault.controls), }) .merge(actionsSchema) .default(liveConfigDefault); @@ -454,6 +484,9 @@ const viewerConfigDefault = { size: '48px', style: 'thumbnails' as const, }, + thumbnails: { + mode: 'below' as const, + }, }, }; const nextPreviousControlConfigSchema = z @@ -474,6 +507,10 @@ const viewerConfigSchema = z controls: z .object({ next_previous: nextPreviousControlConfigSchema, + thumbnails: z.object({ + mode: z.enum(['none', 'above', 'below']).default(viewerConfigDefault.controls.thumbnails.mode), + size: z.string().optional(), + }).default(viewerConfigDefault.controls.thumbnails), }) .default(viewerConfigDefault.controls), })