Skip to content

automatically provide localised Date for SSR in RelativeTime #4305

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

Merged
merged 6 commits into from
Mar 19, 2024
Merged

automatically provide localised Date for SSR in RelativeTime #4305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5eaee82
automatically provide localised Date for SSR in RelativeTime
keithamus Feb 26, 2024
36a3983
changeset
keithamus Mar 6, 2024
a27770a
fix and add tests
keithamus Mar 18, 2024
5a096d8
format
keithamus Mar 18, 2024
7e75152
fix types
keithamus Mar 18, 2024
ff29e49
Merge branch 'main' into automatically-provide-localised-date-for-ssr…
keithamus Mar 19, 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
5 changes: 5 additions & 0 deletions .changeset/honest-feet-shop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Render SSR date for RelativeTime
15 changes: 13 additions & 2 deletions packages/react/src/RelativeTime/RelativeTime.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
import React from 'react'
import {RelativeTimeElement} from '@github/relative-time-element'
import type {ComponentProps} from '../utils/types'
import {createComponent} from '../utils/custom-element'

const RelativeTime = createComponent(RelativeTimeElement, 'relative-time')
const RelativeTimeComponent = createComponent(RelativeTimeElement, 'relative-time')

export type RelativeTimeProps = ComponentProps<typeof RelativeTime>
const localeOptions: Intl.DateTimeFormatOptions = {month: 'short', day: 'numeric', year: 'numeric'}
function RelativeTime({date, datetime, ...props}: RelativeTimeProps) {
if (datetime) date = new Date(datetime)
return (
<RelativeTimeComponent {...props} date={date}>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I pass datetime instead of date, like <RelativeTime datetime="2024-03-10T16:30:00-08:00" /> in a sample app, it doesn't render any date in SSR. Seems like the props return undefined. Is there anything I am missing here? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've fixed this and added tests to confirm.

{date?.toLocaleDateString('en', localeOptions) || ''}
</RelativeTimeComponent>
)
}

export type RelativeTimeProps = ComponentProps<typeof RelativeTimeComponent>
export default RelativeTime
10 changes: 10 additions & 0 deletions packages/react/src/__tests__/RelativeTime.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,14 @@ describe('RelativeTime', () => {
it('renders a <relative-time>', () => {
expect(render(<RelativeTime />).type).toEqual('relative-time')
})

it('renders a date inside', () => {
const date = new Date('2024-03-07T12:22:48.123Z')
expect(render(<RelativeTime date={date} />).children).toEqual(['Mar 7, 2024'])
})

it('renders a datetime inside', () => {
const date = new Date('2024-03-07T12:22:48.123Z')
expect(render(<RelativeTime datetime={date.toJSON()} />).children).toEqual(['Mar 7, 2024'])
})
})