Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add `<StoreDatePicker>` component

Damian Legawieccd247fc30eca
diff --git a/CLAUDE.md b/CLAUDE.md
index 0f1518ca72..10fcd10deb 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -484,6 +484,20 @@ Mappers should only exist for **pure frontend state** (upload progress flags, tr
Use `verticalListSortingStrategy` for table rows / vertical lists, `rectSortingStrategy` for grids. Always include `KeyboardSensor` with `sortableKeyboardCoordinates` alongside `PointerSensor` for accessibility. Set `activationConstraint: { distance: 5 }` on the pointer sensor so clicks on row content don't hijack as drags.
+**Always use `<StoreDatePicker>` (with `react-hook-form` `<Controller>`) for date/datetime fields — never `<Input type="date">`, never the raw `<DatePicker>`.** `@/components/spree/store-date-picker` wraps `<DatePicker>` and pulls the store's IANA timezone from `<StoreProvider>` so every datetime in the admin SPA means the same thing for every admin regardless of where they're logged in from. The underlying picker (`@/components/ui/date-picker`) wraps shadcn `<Calendar>` + `<Popover>` and emits:
+
+- **Date-only mode** (default): `yyyy-MM-dd` plain strings (timezone-agnostic). Persist as-is — the backend's `date` columns accept these directly via Ransack `*_eq`/`*_gt`/`*_lt`. Don't slice an ISO; the picker no longer emits one.
+- **Datetime mode** (`includeTime`): full UTC ISO string. The user picks a wall-clock time **in the store's timezone**, and the picker converts to the corresponding UTC instant. On read, the picker reinterprets the UTC instant back into store-local wall clock for display.
+
+Two patterns:
+
+1. **Form fields**: wire through `<Controller name="…" control={form.control} render={({ field }) => <StoreDatePicker value={field.value || null} onChange={(next) => field.onChange(next ?? '')} placeholder="Pick a date" />} />`. Reference: `routes/_authenticated/$storeId/promotions/gift-cards.tsx`.
+2. **Filter panels / ad-hoc inputs**: pass the value through directly. `<StoreDatePicker value={state || null} onChange={(next) => setState(next ?? '')} />`. The toolbar's `filterType: 'date'` branch already routes here.
+
+The picker accepts `includeTime` when you need a time component (`PaymentMethod#starts_at`/`ends_at`, scheduled publishing, etc.) — set it explicitly; default is date-only. Never render a raw `<input type="date">` — browsers render that natively, with platform-specific styling that breaks the design system. If you find one, replace it. Only reach for the bare `<DatePicker>` in `components/ui/` when you need to override the timezone explicitly (very rare — e.g. picking the store's own timezone setting itself).
+
+**Inside a `<Sheet>`, pass `inline` to `<StoreDatePicker>`.** The default Popover-based path hits the in-Sheet portal mounting bug below; the `inline` prop renders the calendar as an absolute-positioned panel beneath the trigger (with click-outside / Escape close) instead. Filter panels and page-level forms keep the default Popover. Reference: gift card create/edit sheets in `routes/_authenticated/$storeId/promotions/gift-cards.tsx`.
+
**Base UI `<Popover>` is unreliable when nested inside a `<Sheet>`'s portal tree.** Symptom: the trigger button gets `aria-expanded="true"` and `data-popup-open=""` on click, but no `[data-slot="popover-content"]` ever appears in the DOM — the Popup component silently fails to mount its rendered output. Happens in deeply-nested portal trees (Sheet → SortableContext → TableRow → Popover). When clicks fire and state opens but no panel appears, **don't keep poking at Popover** — render the panel inline with `absolute top-full left-0 z-50` + a `document.pointerdown` click-outside listener + Escape-to-close. The picker doesn't need a portal unless it must escape an `overflow: hidden` ancestor; for table cells and form fields, inline is fine. Reference: `components/spree/color-picker.tsx`.
### @spree/sdk-core — Shared HTTP Layer
diff --git a/packages/admin/package.json b/packages/admin/package.json
index 4d2c5dc0ae..60dc8c84dc 100644
--- a/packages/admin/package.json
+++ b/packages/admin/package.json
@@ -37,6 +37,7 @@
"clsx": "^2.1.1",
"cmdk": "^1.1.1",
"date-fns": "^4.1.0",
+ "date-fns-tz": "^3.2.0",
"flag-icons": "^7.5.0",
"lucide-react": "^1.14.0",
"next-themes": "^0.4.6",
diff --git a/packages/admin/src/components/spree/promotion-editors/promotion-form.tsx b/packages/admin/src/components/spree/promotion-editors/promotion-form.tsx
index 0a5551af05..c18865d8b6 100644
--- a/packages/admin/src/components/spree/promotion-editors/promotion-form.tsx
+++ b/packages/admin/src/components/spree/promotion-editors/promotion-form.tsx
@@ -32,6 +32,7 @@ import {
} from '@/components/spree/promotion-editors/types'
import { ResourceLayout } from '@/components/spree/resource-layout'
import { Slot } from '@/components/spree/slot'
+import { StoreDatePicker } from '@/components/spree/store-date-picker'
import { ActiveBadge, Badge } from '@/components/ui/badge'
import { Button } from '@/components/ui/button'
import { Card, CardContent, CardHeader, CardTitle } from '@/components/ui/card'
@@ -43,7 +44,6 @@ import {
TableHeader,
TableRow,
} from '@/components/ui/data-table'
-import { DatePicker } from '@/components/ui/date-picker'
import { Field, FieldGroup, FieldLabel } from '@/components/ui/field'
import { Input } from '@/components/ui/input'
import {
@@ -490,7 +490,7 @@ function ScheduleCard({ form }: { form: any }) {
name="starts_at"
control={form.control}
render={({ field }) => (
- <DatePicker
+ <StoreDatePicker
value={field.value || null}
onChange={(v) => field.onChange(v ?? '')}
placeholder="No start date"
@@ -505,7 +505,7 @@ function ScheduleCard({ form }: { form: any }) {
name="expires_at"
control={form.control}
render={({ field }) => (
- <DatePicker
+ <StoreDatePicker
value={field.value || null}
onChange={(v) => field.onChange(v ?? '')}
placeholder="No expiry"
diff --git a/packages/admin/src/components/spree/store-date-picker.tsx b/packages/admin/src/components/spree/store-date-picker.tsx
new file mode 100644
index 0000000000..192b154fb6
--- /dev/null
+++ b/packages/admin/src/components/spree/store-date-picker.tsx
@@ -0,0 +1,18 @@
+import { DatePicker, type DatePickerProps } from '@/components/ui/date-picker'
+import { useStore } from '@/providers/store-provider'
+
+/**
+ * Drop-in `<DatePicker>` that pulls the timezone from `<StoreProvider>` so
+ * every datetime in the admin SPA is interpreted in the store's timezone
+ * regardless of where the admin is logged in from.
+ *
+ * Use this in every admin form, filter, and sheet that touches a date.
+ * Only reach for the bare `<DatePicker>` when you need to override the
+ * timezone explicitly (rare).
+ */
+function StoreDatePicker(props: Omit<DatePickerProps, 'timezone'>) {
+ const { timezone } = useStore()
+ return <DatePicker {...props} timezone={timezone} />
+}
+
+export { StoreDatePicker }
diff --git a/packages/admin/src/components/spree/table-toolbar.tsx b/packages/admin/src/components/spree/table-toolbar.tsx
index 841d04ad38..cf2a04b8e4 100644
--- a/packages/admin/src/components/spree/table-toolbar.tsx
+++ b/packages/admin/src/components/spree/table-toolbar.tsx
@@ -10,6 +10,7 @@ import {
} from 'lucide-react'
import { useCallback, useMemo, useRef, useState } from 'react'
import { ResourceMultiAutocomplete } from '@/components/spree/resource-multi-autocomplete'
+import { StoreDatePicker } from '@/components/spree/store-date-picker'
import { Badge } from '@/components/ui/badge'
import { Button } from '@/components/ui/button'
import { CardTitle } from '@/components/ui/card'
@@ -696,15 +697,21 @@ function FilterPanel({
<SelectItem value="false">No</SelectItem>
</SelectContent>
</Select>
+ ) : col?.filterType === 'date' ? (
+ // Filter values are stored as plain strings; for dates we
+ // persist `yyyy-MM-dd`, which Ransack accepts as-is for
+ // `*_eq`/`*_gt`/`*_lt`. The picker emits `yyyy-MM-dd`
+ // directly in date-only mode.
+ <div className="flex-1">
+ <StoreDatePicker
+ value={filter.value || null}
+ onChange={(next) => updateFilter(filter.id, { value: next ?? '' })}
+ placeholder="Pick a date"
+ />
+ </div>
) : (
<Input
- type={
- col?.filterType === 'number'
- ? 'number'
- : col?.filterType === 'date'
- ? 'date'
- : 'text'
- }
+ type={col?.filterType === 'number' ? 'number' : 'text'}
className="flex-1 py-1 px-2 text-sm h-7"
placeholder="Value..."
value={filter.value}
diff --git a/packages/admin/src/components/ui/date-picker.tsx b/packages/admin/src/components/ui/date-picker.tsx
index 8cdfc8d5ab..c829418c20 100644
--- a/packages/admin/src/components/ui/date-picker.tsx
+++ b/packages/admin/src/components/ui/date-picker.tsx
@@ -1,10 +1,12 @@
-import { format, parseISO } from 'date-fns'
+import { format, parse, parseISO } from 'date-fns'
+import { formatInTimeZone, fromZonedTime, toZonedTime } from 'date-fns-tz'
import { CalendarIcon, XIcon } from 'lucide-react'
-import { useState } from 'react'
+import { useEffect, useRef, useState } from 'react'
import { Button } from '@/components/ui/button'
import { Calendar } from '@/components/ui/calendar'
import { Input } from '@/components/ui/input'
import { Popover, PopoverContent, PopoverTrigger } from '@/components/ui/popover'
+import { cn } from '@/lib/utils'
interface DatePickerProps {
value?: string | null
@@ -13,41 +15,112 @@ interface DatePickerProps {
className?: string
disabled?: boolean
includeTime?: boolean
+ /**
+ * IANA timezone (e.g. `Europe/Berlin`) used to interpret datetime values.
+ * Defaults to the browser's resolved timezone. **Pass the store timezone
+ * for any admin-facing surface** so that wall-clock times mean the same
+ * thing for every admin regardless of where they're logged in from. Use
+ * `<StoreDatePicker>` (in `components/spree/`) to do this automatically.
+ *
+ * Date-only mode (`includeTime=false`) is timezone-agnostic — values are
+ * plain `yyyy-MM-dd` strings with no clock component.
+ */
+ timezone?: string
+ /**
+ * Render the calendar panel inline (absolute-positioned beneath the
+ * trigger) instead of via Base UI's `<Popover>` Portal. Set this on any
+ * usage nested inside a `<Sheet>` — Base UI's Popover Portal silently
+ * fails to mount inside deeply nested portal trees, so callers in form
+ * sheets / edit drawers must opt in. Filter panels and page-level forms
+ * keep the default Popover behavior.
+ */
+ inline?: boolean
}
+const DATE_ONLY = /^\d{4}-\d{2}-\d{2}$/
+
function DatePicker({
value,
onChange,
placeholder = 'Pick a date',
- className: _,
+ className,
disabled = false,
includeTime = false,
+ timezone,
+ inline = false,
}: DatePickerProps) {
const [open, setOpen] = useState(false)
+ const containerRef = useRef<HTMLDivElement | null>(null)
+
+ // Resolve the active timezone once per render. Browser TZ is the fallback
+ // — used in non-admin contexts (Storybook, isolated tests) where there's
+ // no store context to pull from.
+ const tz = timezone ?? Intl.DateTimeFormat().resolvedOptions().timeZone ?? 'UTC'
- const date = value ? parseISO(value) : undefined
+ // Parse the inbound value into a Date whose **browser-local components**
+ // match the *store-local* date/time the value represents. The Calendar
+ // and the trigger label both read these local components, so anchoring
+ // them to store-local wall-clock is what makes the UI correct.
+ //
+ // - `yyyy-MM-dd` (date-only): timezone-agnostic; parse in browser-local.
+ // - Full ISO timestamp (datetime): UTC instant → reinterpret in store TZ.
+ const date = value
+ ? DATE_ONLY.test(value)
+ ? parse(value, 'yyyy-MM-dd', new Date())
+ : toZonedTime(parseISO(value), tz)
+ : undefined
const isValidDate = date && !Number.isNaN(date.getTime())
+ // Inline mode only: close on outside pointerdown / Escape. Popover mode
+ // gets this behavior from Base UI.
+ useEffect(() => {
+ if (!inline || !open) return
+ function handle(event: PointerEvent) {
+ const target = event.target as Node | null
+ if (!target || !containerRef.current) return
+ if (!containerRef.current.contains(target)) setOpen(false)
+ }
+ function handleKey(event: KeyboardEvent) {
+ if (event.key === 'Escape') setOpen(false)
+ }
+ document.addEventListener('pointerdown', handle)
+ document.addEventListener('keydown', handleKey)
+ return () => {
+ document.removeEventListener('pointerdown', handle)
+ document.removeEventListener('keydown', handleKey)
+ }
+ }, [inline, open])
+
const handleSelect = (selected: Date | undefined) => {
if (!selected) {
onChange?.(null)
return
}
- if (includeTime && isValidDate) {
- // Preserve existing time when changing date
- selected.setHours(date.getHours(), date.getMinutes())
+ if (!includeTime) {
+ // Date-only: emit `yyyy-MM-dd` using browser-local components. The
+ // user clicked a specific calendar day; the day number is what
+ // matters, not the timezone.
+ onChange?.(format(selected, 'yyyy-MM-dd'))
+ setOpen(false)
+ return
}
- onChange?.(selected.toISOString())
- if (!includeTime) setOpen(false)
+ // Datetime: the picked Date has browser-local components for the
+ // selected day at (preserved or zero) hours/minutes. Reinterpret those
+ // wall-clock components as **store-local time**, then emit the UTC
+ // instant. `fromZonedTime` does exactly this conversion.
+ if (isValidDate) {
+ selected.setHours(date.getHours(), date.getMinutes())
+ }
+ onChange?.(fromZonedTime(selected, tz).toISOString())
}
const handleTimeChange = (e: React.ChangeEvent<HTMLInputElement>) => {
const [hours, minutes] = e.target.value.split(':').map(Number)
const d = isValidDate ? new Date(date) : new Date()
d.setHours(hours, minutes, 0, 0)
- onChange?.(d.toISOString())
+ onChange?.(fromZonedTime(d, tz).toISOString())
}
const handleClear = (e: React.MouseEvent) => {
@@ -59,38 +132,88 @@ function DatePicker({
? `${String(date.getHours()).padStart(2, '0')}:${String(date.getMinutes()).padStart(2, '0')}`
: ''
+ // For the trigger label we want to show the value as the store would
+ // interpret it. Date-only uses the locally-anchored Date; datetime uses
+ // store-TZ formatting on the original UTC instant.
+ let triggerLabel = placeholder
+ if (isValidDate) {
+ if (includeTime && value && !DATE_ONLY.test(value)) {
+ triggerLabel = formatInTimeZone(parseISO(value), tz, 'PPP p')
+ } else {
+ triggerLabel = format(date, includeTime ? 'PPP p' : 'PPP')
+ }
+ }
+
+ const triggerChildren = (
+ <>
+ <CalendarIcon className="size-4 shrink-0 text-muted-foreground" />
+ <span className="flex-1 truncate">{triggerLabel}</span>
+ {isValidDate && (
+ <span
+ role="button"
+ tabIndex={-1}
+ className="inline-flex size-4 items-center justify-center rounded-sm text-muted-foreground hover:text-foreground transition-colors cursor-pointer"
+ onPointerDown={handleClear}
+ >
+ <XIcon className="size-3.5" />
+ </span>
+ )}
+ </>
+ )
+
+ const panelChildren = (
+ <>
+ <Calendar
+ mode="single"
+ selected={isValidDate ? date : undefined}
+ onSelect={handleSelect}
+ defaultMonth={isValidDate ? date : undefined}
+ />
+ {includeTime && (
+ <div className="border-t border-border px-3 py-2">
+ <Input type="time" value={timeValue} onChange={handleTimeChange} />
+ </div>
+ )}
+ </>
+ )
+
+ if (inline) {
+ return (
+ <div ref={containerRef} className={cn('relative', className)}>
+ <Button
+ type="button"
+ variant="outline"
+ data-empty={!isValidDate}
+ disabled={disabled}
+ aria-haspopup="dialog"
+ aria-expanded={open}
+ onClick={() => setOpen((v) => !v)}
+ className="w-full justify-start"
+ >
+ {triggerChildren}
+ </Button>
+ {open && (
+ <div
+ role="dialog"
+ aria-label={placeholder}
+ className="absolute top-full left-0 z-50 mt-2 w-auto rounded-lg border border-border bg-popover p-0 text-popover-foreground shadow-md"
+ >
+ {panelChildren}
+ </div>
+ )}
+ </div>
+ )
+ }
+
return (
<Popover open={open} onOpenChange={setOpen}>
<PopoverTrigger asChild disabled={disabled}>
- <Button type="button" variant="outline" data-empty={!isValidDate}>
- <CalendarIcon className="size-4 shrink-0 text-muted-foreground" />
- <span className="flex-1 truncate">
- {isValidDate ? format(date, includeTime ? 'PPP p' : 'PPP') : placeholder}
- </span>
- {isValidDate && (
- <span
- role="button"
- tabIndex={-1}
- className="inline-flex size-4 items-center justify-center rounded-sm text-muted-foreground hover:text-foreground transition-colors cursor-pointer"
- onPointerDown={handleClear}
- >
- <XIcon className="size-3.5" />
- </span>
- )}
+ <Button type="button" variant="outline" data-empty={!isValidDate} className={className}>
+ {triggerChildren}
</Button>
</PopoverTrigger>
<PopoverContent className="w-auto p-0" align="start">
- <Calendar
- mode="single"
- selected={isValidDate ? date : undefined}
- onSelect={handleSelect}
- defaultMonth={isValidDate ? date : undefined}
- />
- {includeTime && (
- <div className="border-t border-border px-3 py-2">
- <Input type="time" value={timeValue} onChange={handleTimeChange} />
- </div>
- )}
+ {panelChildren}
</PopoverContent>
</Popover>
)
diff --git a/packages/admin/src/providers/store-provider.tsx b/packages/admin/src/providers/store-provider.tsx
index 313d4b6025..a042c3ab47 100644
--- a/packages/admin/src/providers/store-provider.tsx
+++ b/packages/admin/src/providers/store-provider.tsx
@@ -10,6 +10,9 @@ interface StoreContextValue {
locales: string[]
defaultCurrency: string
defaultLocale: string
+ /** IANA timezone for the store (e.g. `Europe/Berlin`). Falls back to the
+ * browser's resolved timezone when the store hasn't loaded yet. */
+ timezone: string
refetch: () => Promise<void>
}
@@ -40,6 +43,8 @@ export function StoreProvider({ storeId, children }: { storeId: string; children
const locales = store?.supported_locales ?? []
const defaultCurrency = store?.default_currency ?? 'USD'
const defaultLocale = store?.default_locale ?? 'en'
+ const timezone =
+ store?.preferred_timezone ?? Intl.DateTimeFormat().resolvedOptions().timeZone ?? 'UTC'
return (
<StoreContext.Provider
@@ -51,6 +56,7 @@ export function StoreProvider({ storeId, children }: { storeId: string; children
locales,
defaultCurrency,
defaultLocale,
+ timezone,
refetch: fetchStore,
}}
>
diff --git a/packages/admin/src/routes/_authenticated/$storeId/products/$productId.tsx b/packages/admin/src/routes/_authenticated/$storeId/products/$productId.tsx
index cf9d2c36b6..706a8425cf 100644
--- a/packages/admin/src/routes/_authenticated/$storeId/products/$productId.tsx
+++ b/packages/admin/src/routes/_authenticated/$storeId/products/$productId.tsx
@@ -30,6 +30,7 @@ import { InventorySection } from '@/components/spree/products/inventory-section'
import { MediaEditSheet } from '@/components/spree/products/media-edit-sheet'
import { ResourceLayout } from '@/components/spree/resource-layout'
import { ErrorState } from '@/components/spree/route-error-boundary'
+import { StoreDatePicker } from '@/components/spree/store-date-picker'
import { TagCombobox } from '@/components/spree/tag-combobox'
import { StatusBadge } from '@/components/ui/badge'
import { Button } from '@/components/ui/button'
@@ -46,7 +47,6 @@ import {
ComboboxValue,
useComboboxAnchor,
} from '@/components/ui/combobox'
-import { DatePicker } from '@/components/ui/date-picker'
import { Field, FieldLabel } from '@/components/ui/field'
import { Input } from '@/components/ui/input'
import { RichTextEditor } from '@/components/ui/rich-text-editor'
@@ -702,7 +702,7 @@ function StatusCard({ form }: FormCardProps) {
name="make_active_at"
control={form.control}
render={({ field }) => (
- <DatePicker
+ <StoreDatePicker
value={field.value}
onChange={field.onChange}
placeholder="Pick a date"
@@ -719,7 +719,7 @@ function StatusCard({ form }: FormCardProps) {
name="available_on"
control={form.control}
render={({ field }) => (
- <DatePicker
+ <StoreDatePicker
value={field.value}
onChange={field.onChange}
placeholder="Pick a date"
@@ -735,7 +735,7 @@ function StatusCard({ form }: FormCardProps) {
name="discontinue_on"
control={form.control}
render={({ field }) => (
- <DatePicker
+ <StoreDatePicker
value={field.value}
onChange={field.onChange}
placeholder="Pick a date"
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 589a33c982..47a8941480 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -84,6 +84,9 @@ importers:
date-fns:
specifier: ^4.1.0
version: 4.1.0
+ date-fns-tz:
+ specifier: ^3.2.0
+ version: 3.2.0([email protected])
flag-icons:
specifier: ^7.5.0
version: 7.5.0
@@ -2274,6 +2277,11 @@ packages:
resolution: {integrity: sha512-hTIP/z+t+qKwBDcmmsnmjWTduxCg+5KfdqWQvb2X/8C9+knYY6epN/pfxdDuyVlSVeFz0sM5eEfwIUQ70U4ckg==}
+ resolution: {integrity: sha512-sg8HqoTEulcbbbVXeg84u5UnlsQa8GS5QXMqjjYIhS4abEVVKIUwe0/l/UhrZdKaL/W5eWZNlbTeEIiOXTcsBQ==}
+ peerDependencies:
+ date-fns: ^3.0.0 || ^4.0.0
+
resolution: {integrity: sha512-Ukq0owbQXxa/U3EGtsdVBkR1w7KOQ5gIBqdH2hkvknzZPYvBxb/aa6E8L7tmjFtkwZBu3UXBbjIgPo/Ez4xaNg==}
@@ -5916,6 +5924,10 @@ snapshots:
+ dependencies:
+ date-fns: 4.1.0
+