Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(esl-media): control mixin #2878

Merged
merged 7 commits into from
Feb 5, 2025
Merged

feat(esl-media): control mixin #2878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dd220e4
feat(esl-media): control mixin
fshovchko Jan 22, 2025
0fd33af
chore(esl-media): apply suggestions from code review
fshovchko Jan 24, 2025
be4dd46
chore(esl-media): apply suggestions from code review and discussions
fshovchko Jan 29, 2025
ade884d
Merge branch 'main' into feat/esl-media-control-mixin
ala-n Feb 3, 2025
46be55b
chore(esl-media): apply suggestions from code review
fshovchko Feb 4, 2025
7e1a7fd
chore(esl-media): apply suggestions from code review
fshovchko Feb 5, 2025
0a6c174
Merge branch 'main' into feat/esl-media-control-mixin
fshovchko Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions site/src/site.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
ESLVSizeCSSProxy,
ESLImageContainerMixin,
ESLMedia,
ESLMediaControlMixin,
ESLToggleable,
ESLPopup,
ESLPopupPlaceholder,
Expand Down Expand Up @@ -88,6 +89,8 @@ ESLRandomText.register('lorem-ipsum');
ESLImageContainerMixin.register();
ESLMedia.register();

ESLMediaControlMixin.register();

ESLToggleableDispatcher.init();
ESLToggleable.register();
ESLPopup.register();
Expand Down
28 changes: 14 additions & 14 deletions site/views/examples/embedded-media.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ aside:
</div>

<div class="btn-group btn-group-centered">
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').play()">Play
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'play'}">Play
</button>
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').pause()">Pause
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'pause'}">Pause
</button>
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').stop()">Stop
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'stop'}">Stop
</button>
</div>
</script>
Expand All @@ -45,11 +45,11 @@ aside:
</esl-media>

<div class="btn-group btn-group-centered">
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').play()">Play
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'play'}">Play
</button>
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').pause()">Pause
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'pause'}">Pause
</button>
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').stop()">Stop
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'stop'}">Stop
</button>
</div>
</script>
Expand All @@ -72,11 +72,11 @@ aside:
</div>

<div class="btn-group btn-group-centered">
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').play()">Play
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'play'}">Play
</button>
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').pause()">Pause
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'pause'}">Pause
</button>
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').stop()">Stop
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'stop'}">Stop
</button>
</div>
</script>
Expand All @@ -102,11 +102,11 @@ aside:
</div>

<div class="btn-group btn-group-centered">
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').play()">Play
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'play'}">Play
</button>
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').pause()">Pause
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'pause'}">Pause
</button>
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').stop()">Stop
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'stop'}">Stop
</button>
</div>

Expand Down Expand Up @@ -140,9 +140,9 @@ aside:
</div>

<div class="btn-group btn-group-centered">
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').play()">Play
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'play'}">Play
</button>
<button class="btn btn-sec-blue" onclick="this.closest('uip-root').querySelector('.esl-media').stop()">Stop
<button class="btn btn-sec-blue" esl-media-contol="{target: '::closest(uip-root)::find(.esl-media)', action: 'stop'}">Stop
</button>
</div>
</script>
Expand Down
66 changes: 66 additions & 0 deletions src/modules/esl-media/control/esl-media-control-mixin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import {ESLMixinElement} from '../../esl-mixin-element/core';
import {ESLTraversingQuery} from '../../esl-traversing-query/core/esl-traversing-query';
import {listen, memoize} from '../../esl-utils/decorators';
import {ExportNs} from '../../esl-utils/environment/export-ns';
import {evaluate} from '../../esl-utils/misc/format';

import type {ESLMedia} from '../core/esl-media';

export interface ESLMediaControlConfig {
target?: string;
action?: 'play' | 'pause' | 'stop' | 'toggle';
activeCls?: string;
}

@ExportNs('MediaControlMixin')
export class ESLMediaControlMixin extends ESLMixinElement {
public static override is = 'esl-media-contol';

public static readonly DEFAULT_CONFIG: ESLMediaControlConfig = {
action: 'toggle'
};

@memoize()
public get config(): ESLMediaControlConfig {
const attrVal = this.$$attr(ESLMediaControlMixin.is) || '{}';
const userConfig = attrVal.trim().startsWith('{') ? evaluate(attrVal, {}) : {target: attrVal};
return {...ESLMediaControlMixin.DEFAULT_CONFIG, ...userConfig};
}
fshovchko marked this conversation as resolved.
Show resolved Hide resolved

public set config(value: string | ESLMediaControlConfig) {
const serialized = typeof value === 'string' ? value : JSON.stringify(value);
this.$$attr(ESLMediaControlMixin.is, serialized);
}

public get $target(): ESLMedia | null {
fshovchko marked this conversation as resolved.
Show resolved Hide resolved
if (!this.config.target) return null;
return ESLTraversingQuery.first(this.config.target, this.$host) as ESLMedia | null;
}

protected override attributeChangedCallback(): void {
memoize.clear(this, 'config');
this.$$on(this.onStateChange);
}

@listen('click')
protected onClick(): void {
const {$target, config} = this;
if (!$target || !config.action) return;
if (config.action in $target && typeof $target[config.action] === 'function') $target[config.action]();
fshovchko marked this conversation as resolved.
Show resolved Hide resolved
}

@listen({
event: 'esl:media:play esl:media:paused esl:media:ended',
target: (control: ESLMediaControlMixin) => control.$target,
condition: (control: ESLMediaControlMixin) => !!control.config.activeCls
})
protected onStateChange(e: CustomEvent): void {
this.$$cls(this.config.activeCls!, e.type === 'esl:media:play');
}
}

declare global {
export interface ESLLibrary {
MediaControlMixin: typeof ESLMediaControlMixin;
}
}
1 change: 1 addition & 0 deletions src/modules/esl-media/core.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ export type {ESLMediaTagShape} from './core/esl-media.shape';
export * from './core/esl-media';
export * from './core/esl-media-provider';
export * from './core/esl-media-registry';
export * from './control/esl-media-control-mixin';