A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.
// SPDX-License-Identifier: AGPL-3.0-or-later
export type ScrollIndicatorSeverity = 'mention' | 'unread';
type ScrollIndicatorDirection = 'top' | 'bottom';
export interface ScrollIndicatorTargetMeasurement {
id: string;
severity: ScrollIndicatorSeverity;
top: number;
bottom: number;
order: number;
}
interface ScrollIndicatorEdgeCandidate extends ScrollIndicatorTargetMeasurement {
direction: ScrollIndicatorDirection;
distance: number;
}
export interface ActiveScrollIndicator {
direction: ScrollIndicatorDirection;
indicator: ScrollIndicatorEdgeCandidate;
}
export interface ActiveScrollIndicators {
top: ActiveScrollIndicator | null;
bottom: ActiveScrollIndicator | null;
}
interface ScrollIndicatorMeasurement {
scrollTop: number;
viewportHeight: number;
targets: ReadonlyArray<ScrollIndicatorTargetMeasurement>;
}
const severityOrder: Record<ScrollIndicatorSeverity, number> = {
mention: 2,
unread: 1,
};
const VISIBILITY_EPSILON = 0.5;
function isFiniteMeasurement(target: ScrollIndicatorTargetMeasurement): boolean {
return (
Number.isFinite(target.top) &&
Number.isFinite(target.bottom) &&
Number.isFinite(target.order) &&
target.bottom >= target.top
);
}
function isBetterEdgeCandidate(
candidate: ScrollIndicatorEdgeCandidate,
current: ScrollIndicatorEdgeCandidate | null,
): boolean {
if (!current) return true;
const candidateSeverity = severityOrder[candidate.severity];
const currentSeverity = severityOrder[current.severity];
if (candidateSeverity !== currentSeverity) return candidateSeverity > currentSeverity;
if (candidate.distance !== current.distance) return candidate.distance < current.distance;
return candidate.order < current.order;
}
function resolveScrollIndicatorEdgeCandidates(measurement: ScrollIndicatorMeasurement): {
topIndicator: ScrollIndicatorEdgeCandidate | null;
bottomIndicator: ScrollIndicatorEdgeCandidate | null;
} {
const viewportTop = Math.max(0, measurement.scrollTop);
const viewportBottom = viewportTop + Math.max(0, measurement.viewportHeight);
let topIndicator: ScrollIndicatorEdgeCandidate | null = null;
let bottomIndicator: ScrollIndicatorEdgeCandidate | null = null;
for (const target of measurement.targets) {
if (!target.id || !isFiniteMeasurement(target)) continue;
if (target.bottom <= viewportTop + VISIBILITY_EPSILON) {
const candidate = {
...target,
direction: 'top' as const,
distance: Math.max(0, viewportTop - target.bottom),
};
if (isBetterEdgeCandidate(candidate, topIndicator)) topIndicator = candidate;
} else if (target.top >= viewportBottom - VISIBILITY_EPSILON) {
const candidate = {
...target,
direction: 'bottom' as const,
distance: Math.max(0, target.top - viewportBottom),
};
if (isBetterEdgeCandidate(candidate, bottomIndicator)) bottomIndicator = candidate;
}
}
return {topIndicator, bottomIndicator};
}
export function resolveActiveScrollIndicators(measurement: ScrollIndicatorMeasurement): ActiveScrollIndicators {
const {topIndicator, bottomIndicator} = resolveScrollIndicatorEdgeCandidates(measurement);
return {
top: topIndicator == null ? null : {direction: 'top', indicator: topIndicator},
bottom: bottomIndicator == null ? null : {direction: 'bottom', indicator: bottomIndicator},
};
}
export const EMPTY_ACTIVE_SCROLL_INDICATORS: ActiveScrollIndicators = Object.freeze({top: null, bottom: null});
export function areActiveScrollIndicatorsEqual(left: ActiveScrollIndicators, right: ActiveScrollIndicators): boolean {
return (
areActiveScrollIndicatorsEqualAtEdge(left.top, right.top) &&
areActiveScrollIndicatorsEqualAtEdge(left.bottom, right.bottom)
);
}
function areActiveScrollIndicatorsEqualAtEdge(
left: ActiveScrollIndicator | null,
right: ActiveScrollIndicator | null,
): boolean {
if (left === right) return true;
if (left == null || right == null) return false;
return left.indicator.id === right.indicator.id && left.indicator.severity === right.indicator.severity;
}