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

Jump to bottom

feat(esl-footnotes): migrate esl-note to esl-base-trigger #2690

Merged
merged 4 commits into from
Oct 29, 2024
Merged

feat(esl-footnotes): migrate esl-note to esl-base-trigger #2690

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d2e0dbb
feat(esl-footnotes): migrate esl-note to esl-base-trigger
dshovchko Sep 30, 2024
a1e40fa
Merge remote-tracking branch 'origin/main-beta' into feat/esl-note-to…
dshovchko Sep 30, 2024
ad8d837
style(esl-footnotes): apply suggestions from code review
dshovchko Sep 30, 2024
67f1073
Merge branch 'main-beta' into feat/esl-note-to-base-trigger
ala-n Oct 29, 2024
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
2 changes: 1 addition & 1 deletion src/modules/esl-footnotes/core/esl-note.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ esl-note {
content: ']';
}

&[tooltip-shown] {
&[active] {
text-decoration: underline;
}

Expand Down
121 changes: 29 additions & 92 deletions src/modules/esl-footnotes/core/esl-note.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
import {ExportNs} from '../../esl-utils/environment/export-ns';
import {ESLBaseElement} from '../../esl-base-element/core';
import {ESLBaseTrigger} from '../../esl-trigger/core/esl-base-trigger';
import {ready, attr, prop, boolAttr, memoize, listen} from '../../esl-utils/decorators';
import {ESLTooltip} from '../../esl-tooltip/core';
import {promisifyTimeout, repeatSequence} from '../../esl-utils/async';
import {ESLEventUtils} from '../../esl-utils/dom/events';
import {ENTER, SPACE} from '../../esl-utils/dom/keys';
import {scrollIntoView} from '../../esl-utils/dom/scroll';
import {hasHover} from '../../esl-utils/environment/device-detector';
import {ESLMediaQuery} from '../../esl-media-query/core';
import {ESLTraversingQuery} from '../../esl-traversing-query/core';

import type {ESLToggleable, ESLToggleableActionParams} from '../../esl-toggleable/core/esl-toggleable';
import type {ESLFootnotes} from './esl-footnotes';
import type {ESLTooltipActionParams} from '../../esl-tooltip/core/esl-tooltip';
import type {IMediaQueryCondition} from '../../esl-media-query/core/conditions/media-query-base';

@ExportNs('Note')
export class ESLNote extends ESLBaseElement {
export class ESLNote extends ESLBaseTrigger {
public static override is = 'esl-note';
public static observedAttributes = ['ignore'];

Expand Down Expand Up @@ -45,10 +43,8 @@ export class ESLNote extends ESLBaseElement {
*/
@attr({defaultValue: '*'}) public standaloneLabel: string;

/** Click event tracking media query. Default: `all` */
@attr({defaultValue: 'all'}) public trackClick: string;
/** Hover event tracking media query. Default: `all` */
@attr({defaultValue: 'all'}) public trackHover: string;
@attr({defaultValue: 'all'}) public override trackHover: string;

/** Target to container element {@link ESLTraversingQuery} to define bounds of tooltip visibility (window by default) */
@attr() public container: string;
Expand All @@ -59,13 +55,9 @@ export class ESLNote extends ESLBaseElement {
protected _$footnotes: ESLFootnotes | null;
protected _index: number;

/** Marker to allow track hover */
public get allowHover(): boolean {
return hasHover && ESLMediaQuery.for(this.trackHover).matches;
}
/** Marker to allow track clicks */
public get allowClick(): boolean {
return ESLMediaQuery.for(this.trackClick).matches;
/** Target observable Toggleable */
public get $target(): ESLToggleable {
dshovchko marked this conversation as resolved.
Show resolved Hide resolved
return ESLTooltip.sharedInstance;
}

/** Marker to allow footnotes to pick up this note */
Expand Down Expand Up @@ -110,13 +102,12 @@ export class ESLNote extends ESLBaseElement {
/** The base language of the element */
protected get currentLang(): string {
const el = this.closest('[lang]');
return (el) ? (el as HTMLElement).lang : '';
return el ? (el as HTMLElement).lang : '';
}

/** @returns true if tooltip is active and activated with the current note */
public get isTargetActive(): boolean {
const $target = ESLTooltip.sharedInstance;
return $target && $target.open && $target.activator === this;
/** Checks that the target is in active state */
public override get isTargetActive(): boolean {
return !!this.$target.open && this.$target.activator === this;
}

@ready
Expand Down Expand Up @@ -156,15 +147,13 @@ export class ESLNote extends ESLBaseElement {

/** Activates note */
public activate(): void {
if (ESLTooltip.open) {
this.hideTooltip();
}
ESLEventUtils.dispatch(this, 'esl:show:request');
this.hideTarget();
this.$$fire('esl:show:request');
// TODO: replace timeout with a more reliable mechanism to have time to show content with this note
repeatSequence(() => {
return promisifyTimeout((this.constructor as typeof ESLNote).activateTimeout)
.then(() => scrollIntoView(this, {behavior: 'smooth', block: 'center'}))
.then(() => ESLTooltip.open || this.showTooltip());
repeatSequence(async () => {
await promisifyTimeout((this.constructor as typeof ESLNote).activateTimeout);
await scrollIntoView(this, {behavior: 'smooth', block: 'center'});
return this.$target.open || this.showTarget();
}, 3);
}

Expand Down Expand Up @@ -214,10 +203,10 @@ export class ESLNote extends ESLBaseElement {
}

/** Merge params to pass to the toggleable */
protected mergeToggleableParams(this: ESLNote, ...params: ESLTooltipActionParams[]): ESLTooltipActionParams {
protected override mergeToggleableParams(this: ESLNote, ...params: ESLTooltipActionParams[]): ESLTooltipActionParams {
const container = this.getClosestRelatedAttr('container') || this.container;
const containerEl = container ? ESLTraversingQuery.first(container, this) as HTMLElement : undefined;
return Object.assign({
return super.mergeToggleableParams({
initiator: 'note',
activator: this,
containerEl,
Expand All @@ -228,70 +217,19 @@ export class ESLNote extends ESLBaseElement {
}, ...params);
}

/** Shows tooltip with passed params */
public showTooltip(params: ESLTooltipActionParams = {}): void {
const actionParams = this.mergeToggleableParams({
}, params);
if (ESLTooltip.open) {
this.hideTooltip();
}
ESLTooltip.show(actionParams);
/** Show target toggleable with passed params */
public override showTarget(params: ESLToggleableActionParams = {}): void {
super.showTarget(params);
this.highlight();
}
/** Hides tooltip with passed params */
public hideTooltip(params: ESLTooltipActionParams = {}): void {
const actionParams = this.mergeToggleableParams({
}, params);
ESLTooltip.hide(actionParams);
}
/** Toggles tooltip with passed params */
public toggleTooltip(params: ESLTooltipActionParams = {}, state: boolean = !this.tooltipShown): void {
state ? this.showTooltip(params) : this.hideTooltip(params);
}

/** Handles `click` event */
@listen('click')
protected _onClick(event: MouseEvent): void {
if (!this.allowClick) return;
event.preventDefault();
event.stopPropagation();
return this.toggleTooltip({event});
}

/** Handles `keydown` event */
@listen('keydown')
protected _onKeydown(event: KeyboardEvent): void {
if (![ENTER, SPACE].includes(event.key)) return;
event.preventDefault();
event.stopPropagation();
return this.toggleTooltip({event});
}

/** Handles hover `mouseenter` event */
@listen('mouseenter')
protected _onMouseEnter(event: MouseEvent): void {
if (!this.allowHover) return;
this.showTooltip({event});
event.preventDefault();
}

/** Handles hover `mouseleave` event */
@listen('mouseleave')
protected _onMouseLeave(event: MouseEvent): void {
if (!this.allowHover) return;
this.hideTooltip({event, trackHover: true});
event.preventDefault();
}

/** Actions on breakpoint changing */
@listen({
event: 'change',
target: (el: ESLNote) => el.queryToIgnore
})
protected _onIgnoreConditionChange(): void {
if (ESLTooltip.open) {
this.hideTooltip();
}
this.hideTarget();
this.innerHTML = this.renderedHTML;
this.update();
this._$footnotes?.update();
Expand All @@ -307,19 +245,18 @@ export class ESLNote extends ESLBaseElement {
this._sendResponseToFootnote();
}

/** Handles ESLToggleable state change */
/** Handles ESLNote state change */
@listen({
event: 'esl:show esl:hide',
target: () => ESLTooltip.sharedInstance
event: 'esl:hide',
target: (that: ESLNote) => that.$target
})
protected _onTargetStateChange(event?: Event): void {
this.tooltipShown = ESLTooltip.open && this.isTargetActive;
if (!this.tooltipShown) this._$footnotes?.turnOffHighlight(this);
protected _onTargetHide(): void {
if (!this.isTargetActive) this._$footnotes?.turnOffHighlight(this);
}

/** Sends the response to footnotes */
protected _sendResponseToFootnote(): void {
ESLEventUtils.dispatch(this, this.FOOTNOTE_RESPONSE_EVENT);
this.$$fire(this.FOOTNOTE_RESPONSE_EVENT);
}
}

Expand Down