Skip to content

Experimental: <relative-time> supports thresholds that are specified by the user #330

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Experimental: <relative-time> supports thresholds that are specified by the user #330

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e91ea2
add support for evaluating format based on user's preferred threshold
zaataylor Oct 28, 2025
f7ab161
set element root text based on resolvedFormat
zaataylor Oct 28, 2025
0dfe5f9
remove dependence on absolute time setting for dateObserver enablement
zaataylor Oct 28, 2025
7f0c982
Add comment detailing planned supported threshold values
zaataylor Oct 28, 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
30 changes: 25 additions & 5 deletions src/relative-time-element.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,24 @@ export class RelativeTimeElement extends HTMLElement implements Intl.DateTimeFor

// 'auto' is an alias for 'relative'
if ((format === 'auto' || format === 'relative') && typeof Intl !== 'undefined' && Intl.RelativeTimeFormat) {
const tense = this.tense
if (tense === 'past' || tense === 'future') return 'relative'
if (Duration.compare(duration, this.threshold) === 1) return 'relative'
// This attribute will only be present if the user has setting enabled
const userPreferredThreshold = this.ownerDocument.body?.getAttribute('data-preferred-threshold')
if (userPreferredThreshold) {
// Possible values of ISO 8601 durations for our cases are:
// - "PT0S" (always) would be a threshold of 0 seconds, corresponding to always showing absolute time
// - "P1D" (1 day)
// - "P7D" (1 week)
// - "P1M" (1 month)
// - "P1Y" (1 year)
if (isDuration(userPreferredThreshold)) {
if (Duration.compare(duration, userPreferredThreshold) === 1) return 'relative'
}
return 'datetime'
} else {
const tense = this.tense
if (tense === 'past' || tense === 'future') return 'relative'
if (Duration.compare(duration, this.threshold) === 1) return 'relative'
}
}
return 'datetime'
}
Expand Down Expand Up @@ -503,7 +518,12 @@ export class RelativeTimeElement extends HTMLElement implements Intl.DateTimeFor
// Experimental: Enable absolute time if users prefers it, but never for `duration` format
const displayUserPreferredAbsoluteTime = this.#shouldDisplayUserPreferredAbsoluteTime(format)
if (displayUserPreferredAbsoluteTime) {
newText = this.#getUserPreferredAbsoluteTimeFormat(date)
if (format === 'relative') {
newText = this.#getRelativeFormat(duration)
} else {
// datetime
newText = this.#getUserPreferredAbsoluteTimeFormat(date)
}
} else {
if (format === 'duration') {
newText = this.#getDurationFormat(duration)
Expand All @@ -525,7 +545,7 @@ export class RelativeTimeElement extends HTMLElement implements Intl.DateTimeFor
this.dispatchEvent(new RelativeTimeUpdatedEvent(oldText, newText, oldTitle, newTitle))
}

if ((format === 'relative' || format === 'duration') && !displayUserPreferredAbsoluteTime) {
if (format === 'relative' || format === 'duration') {
dateObserver.observe(this)
} else {
dateObserver.unobserve(this)
Expand Down