Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

introduce DatePicker (#46837)

Gildas Garcia093ed8f610c3
diff --git a/apps/design-system/content/docs/components/date-picker.mdx b/apps/design-system/content/docs/components/date-picker.mdx
index 43040dff22c..286c3338eed 100644
--- a/apps/design-system/content/docs/components/date-picker.mdx
+++ b/apps/design-system/content/docs/components/date-picker.mdx
@@ -10,7 +10,7 @@ source:
## Installation
-The Date Picker is built using a composition of the `<Popover />` and the `<Calendar />` components.
+The Date Picker is built using a composition of the `<Popover />`, `<Button />` and `<Calendar />` components.
See installation instructions for the [Popover](/docs/components/popover#installation) and the [Calendar](/docs/components/calendar#installation) components.
@@ -20,41 +20,42 @@ See installation instructions for the [Popover](/docs/components/popover#install
'use client'
import { format } from 'date-fns'
-import { Calendar as CalendarIcon } from 'lucide-react'
import * as React from 'react'
-
-import { Button } from '@/components/ui/button'
-import { Calendar } from '@/components/ui/calendar'
-import { Popover, PopoverContent, PopoverTrigger } from '@/components/ui/popover'
-import { cn } from '@/lib/utils'
+import { Button, Calendar } from 'ui'
+import {
+ DatePicker,
+ DatePickerButton,
+ DatePickerContent,
+ DatePickerTrigger,
+} from 'ui-patterns/DatePicker'
export function DatePickerDemo() {
const [date, setDate] = React.useState<Date>()
return (
- <Popover>
- <PopoverTrigger asChild>
- <Button
- variant={'outline'}
- className={cn(
- 'w-[280px] justify-start text-left font-normal',
- !date && 'text-muted-foreground'
- )}
- >
- <CalendarIcon className="mr-2 h-4 w-4" />
+ <DatePicker>
+ <DatePickerTrigger asChild>
+ <DatePickerButton variant="outline" className="w-[280px]">
{date ? format(date, 'PPP') : <span>Pick a date</span>}
- </Button>
- </PopoverTrigger>
- <PopoverContent className="w-auto p-0">
+ </DatePickerButton>
+ </DatePickerTrigger>
+ <DatePickerContent>
<Calendar mode="single" selected={date} onSelect={setDate} initialFocus />
- </PopoverContent>
- </Popover>
+ </DatePickerContent>
+ </DatePicker>
)
}
```
See the [React DayPicker](https://react-day-picker.js.org) documentation for more information.
+## API Reference
+
+- `<DatePicker />` accepts the same props as [the `<Popover />` component](./popover).
+- `<DatePickerTrigger />` accepts the same props as [the `<PopoverTrigger />` component](./popover#api-reference).
+- `<DatePickerContent />` accepts the same props as [the `<PopoverContent />` component](./popover#api-reference).
+- `<DatePickerButton />` accepts the same props as [the `<Button />` component](./button) and an optional `isInvalid` prop to visually indicate an invalid date.
+
## Examples
### Date Picker
diff --git a/apps/design-system/registry/default/example/date-picker-demo.tsx b/apps/design-system/registry/default/example/date-picker-demo.tsx
index 8ac1d493670..d8bfeb6b862 100644
--- a/apps/design-system/registry/default/example/date-picker-demo.tsx
+++ b/apps/design-system/registry/default/example/date-picker-demo.tsx
@@ -1,32 +1,28 @@
'use client'
import { format } from 'date-fns'
-import { Calendar as CalendarIcon } from 'lucide-react'
import * as React from 'react'
-import { Button, Calendar, Popover, PopoverContent, PopoverTrigger } from 'ui'
-
-import { cn } from '@/lib/utils'
+import { Calendar } from 'ui'
+import {
+ DatePicker,
+ DatePickerButton,
+ DatePickerContent,
+ DatePickerTrigger,
+} from 'ui-patterns/DatePicker'
export default function DatePickerDemo() {
const [date, setDate] = React.useState<Date>()
return (
- <Popover>
- <PopoverTrigger asChild>
- <Button
- variant="outline"
- className={cn(
- 'w-[280px] justify-start text-left font-normal',
- !date && 'text-muted-foreground'
- )}
- icon={<CalendarIcon className="h-4 w-4" />}
- >
+ <DatePicker>
+ <DatePickerTrigger asChild>
+ <DatePickerButton variant="outline" className="w-[280px]">
{date ? format(date, 'PPP') : <span>Pick a date</span>}
- </Button>
- </PopoverTrigger>
- <PopoverContent className="w-auto p-0">
+ </DatePickerButton>
+ </DatePickerTrigger>
+ <DatePickerContent>
<Calendar mode="single" selected={date} onSelect={setDate} initialFocus />
- </PopoverContent>
- </Popover>
+ </DatePickerContent>
+ </DatePicker>
)
}
diff --git a/apps/design-system/registry/default/example/date-picker-form.tsx b/apps/design-system/registry/default/example/date-picker-form.tsx
index 26724729db3..52aa14fc345 100644
--- a/apps/design-system/registry/default/example/date-picker-form.tsx
+++ b/apps/design-system/registry/default/example/date-picker-form.tsx
@@ -2,27 +2,26 @@
import { zodResolver } from '@hookform/resolvers/zod'
import { format } from 'date-fns'
-import { CalendarIcon } from 'lucide-react'
import { useForm } from 'react-hook-form'
import { toast } from 'sonner'
import {
Button,
Calendar,
Form,
- FormControl,
FormDescription,
FormField,
FormItem,
FormLabel,
FormMessage,
- Popover,
- PopoverContent,
- PopoverTrigger,
} from 'ui'
+import {
+ DatePicker,
+ DatePickerButton,
+ DatePickerContent,
+ DatePickerTrigger,
+} from 'ui-patterns/DatePicker'
import { z } from 'zod'
-import { cn } from '@/lib/utils'
-
const FormSchema = z.object({
dob: z.date({
required_error: 'A date of birth is required.',
@@ -50,25 +49,16 @@ export default function DatePickerForm() {
<FormField
control={form.control}
name="dob"
- render={({ field }) => (
+ render={({ field, fieldState }) => (
<FormItem className="flex flex-col">
<FormLabel>Date of birth</FormLabel>
- <Popover>
- <PopoverTrigger asChild>
- <FormControl>
- <Button
- variant="outline"
- className={cn(
- 'w-[240px] pl-3 text-left font-normal',
- !field.value && 'text-muted-foreground'
- )}
- icon={<CalendarIcon className="h-4 w-4 opacity-50" />}
- >
- {field.value ? format(field.value, 'PPP') : <span>Pick a date</span>}
- </Button>
- </FormControl>
- </PopoverTrigger>
- <PopoverContent className="w-auto p-0" align="start">
+ <DatePicker>
+ <DatePickerTrigger asChild>
+ <DatePickerButton isInvalid={fieldState.invalid}>
+ {field.value ? format(field.value, 'PPP') : 'Pick a date'}
+ </DatePickerButton>
+ </DatePickerTrigger>
+ <DatePickerContent>
<Calendar
mode="single"
selected={field.value}
@@ -76,8 +66,8 @@ export default function DatePickerForm() {
disabled={(date) => date > new Date() || date < new Date('1900-01-01')}
initialFocus
/>
- </PopoverContent>
- </Popover>
+ </DatePickerContent>
+ </DatePicker>
<FormDescription>Your date of birth is used to calculate your age.</FormDescription>
<FormMessage />
</FormItem>
diff --git a/apps/design-system/registry/default/example/date-picker-with-presets.tsx b/apps/design-system/registry/default/example/date-picker-with-presets.tsx
index c4faa7f1d2e..cb252655d34 100644
--- a/apps/design-system/registry/default/example/date-picker-with-presets.tsx
+++ b/apps/design-system/registry/default/example/date-picker-with-presets.tsx
@@ -1,41 +1,26 @@
'use client'
import { addDays, format } from 'date-fns'
-import { Calendar as CalendarIcon } from 'lucide-react'
import * as React from 'react'
+import { Calendar, Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from 'ui'
import {
- Button,
- Calendar,
- Popover,
- PopoverContent,
- PopoverTrigger,
- Select,
- SelectContent,
- SelectItem,
- SelectTrigger,
- SelectValue,
-} from 'ui'
-
-import { cn } from '@/lib/utils'
+ DatePicker,
+ DatePickerButton,
+ DatePickerContent,
+ DatePickerTrigger,
+} from 'ui-patterns/DatePicker'
export default function DatePickerWithPresets() {
const [date, setDate] = React.useState<Date>()
return (
- <Popover>
- <PopoverTrigger asChild>
- <Button
- variant="outline"
- className={cn(
- 'w-[280px] justify-start text-left font-normal',
- !date && 'text-muted-foreground'
- )}
- icon={<CalendarIcon className="h-4 w-4" />}
- >
+ <DatePicker>
+ <DatePickerTrigger asChild>
+ <DatePickerButton variant="outline" className="w-[280px]">
{date ? format(date, 'PPP') : <span>Pick a date</span>}
- </Button>
- </PopoverTrigger>
- <PopoverContent className="flex w-auto flex-col space-y-2 p-2">
+ </DatePickerButton>
+ </DatePickerTrigger>
+ <DatePickerContent className="flex w-auto flex-col space-y-2 p-2">
<Select onValueChange={(value) => setDate(addDays(new Date(), parseInt(value)))}>
<SelectTrigger>
<SelectValue placeholder="Select" />
@@ -50,7 +35,7 @@ export default function DatePickerWithPresets() {
<div className="rounded-md border">
<Calendar mode="single" selected={date} onSelect={setDate} />
</div>
- </PopoverContent>
- </Popover>
+ </DatePickerContent>
+ </DatePicker>
)
}
diff --git a/apps/design-system/registry/default/example/date-picker-with-range.tsx b/apps/design-system/registry/default/example/date-picker-with-range.tsx
index 533c909e022..a2aa91105f9 100644
--- a/apps/design-system/registry/default/example/date-picker-with-range.tsx
+++ b/apps/design-system/registry/default/example/date-picker-with-range.tsx
@@ -1,10 +1,15 @@
'use client'
import { addDays, format } from 'date-fns'
-import { Calendar as CalendarIcon } from 'lucide-react'
import * as React from 'react'
import { DateRange } from 'react-day-picker'
-import { Button, Calendar, Popover, PopoverContent, PopoverTrigger } from 'ui'
+import { Calendar } from 'ui'
+import {
+ DatePicker,
+ DatePickerButton,
+ DatePickerContent,
+ DatePickerTrigger,
+} from 'ui-patterns/DatePicker'
import { cn } from '@/lib/utils'
@@ -16,17 +21,9 @@ export default function DatePickerWithRange({ className }: React.HTMLAttributes<
return (
<div className={cn('grid gap-2', className)}>
- <Popover>
- <PopoverTrigger asChild>
- <Button
- id="date"
- variant="outline"
- className={cn(
- 'w-[300px] justify-start text-left font-normal',
- !date && 'text-muted-foreground'
- )}
- icon={<CalendarIcon className="h-4 w-4" />}
- >
+ <DatePicker>
+ <DatePickerTrigger asChild>
+ <DatePickerButton variant="outline" className="w-[300px]">
{date?.from ? (
date.to ? (
<>
@@ -38,9 +35,9 @@ export default function DatePickerWithRange({ className }: React.HTMLAttributes<
) : (
<span>Pick a date</span>
)}
- </Button>
- </PopoverTrigger>
- <PopoverContent className="w-auto p-0" align="start">
+ </DatePickerButton>
+ </DatePickerTrigger>
+ <DatePickerContent>
<Calendar
initialFocus
mode="range"
@@ -49,8 +46,8 @@ export default function DatePickerWithRange({ className }: React.HTMLAttributes<
onSelect={setDate}
numberOfMonths={2}
/>
- </PopoverContent>
- </Popover>
+ </DatePickerContent>
+ </DatePicker>
</div>
)
}
diff --git a/apps/design-system/registry/default/example/form-patterns-pagelayout.tsx b/apps/design-system/registry/default/example/form-patterns-pagelayout.tsx
index d3c6ef7d14d..ba7b07db120 100644
--- a/apps/design-system/registry/default/example/form-patterns-pagelayout.tsx
+++ b/apps/design-system/registry/default/example/form-patterns-pagelayout.tsx
@@ -1,6 +1,6 @@
import { zodResolver } from '@hookform/resolvers/zod'
import { format } from 'date-fns'
-import { CalendarIcon, ExternalLink, Trash, Upload } from 'lucide-react'
+import { ExternalLink, Trash, Upload } from 'lucide-react'
import { useRef, useState } from 'react'
import { useForm } from 'react-hook-form'
import {
@@ -19,9 +19,6 @@ import {
InputGroup,
InputGroupAddon,
InputGroupText,
- Popover,
- PopoverContent,
- PopoverTrigger,
RadioGroupStacked,
RadioGroupStackedItem,
Select,
@@ -33,6 +30,12 @@ import {
Textarea,
} from 'ui'
import { Input as PasswordInput } from 'ui-patterns/DataInputs/Input'
+import {
+ DatePicker,
+ DatePickerButton,
+ DatePickerContent,
+ DatePickerTrigger,
+} from 'ui-patterns/DatePicker'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import { KeyValueFieldArray } from 'ui-patterns/form/KeyValueFieldArray/KeyValueFieldArray'
import { getKeyValueFieldArrayValidationIssues } from 'ui-patterns/form/KeyValueFieldArray/validation'
@@ -73,7 +76,7 @@ const formSchema = z
region: z.string().min(1, 'Region is required'),
schemas: z.array(z.string()).min(1, 'At least one schema is required'),
queueType: z.enum(['basic', 'partitioned']),
- expiryDate: z.date().optional(),
+ expiryDate: z.date(),
password: z.string().min(8, 'Password must be at least 8 characters'),
duration: z
.union([
@@ -664,32 +667,28 @@ export default function FormPatternsPageLayout() {
<FormField
control={form.control}
name="expiryDate"
- render={({ field }) => (
+ render={({ field, fieldState }) => (
<FormItemLayout
layout="flex-row-reverse"
label="Date Picker"
description="Date selection with calendar popover"
>
<FormControl>
- <Popover>
- <PopoverTrigger asChild>
- <Button
- variant="outline"
- className="bg-control w-full justify-start text-left font-normal px-3 py-4"
- icon={<CalendarIcon className="h-4 w-4" />}
- >
+ <DatePicker>
+ <DatePickerTrigger asChild>
+ <DatePickerButton block isInvalid={fieldState.invalid}>
{field.value ? format(field.value, 'PPP') : 'Pick a date'}
- </Button>
- </PopoverTrigger>
- <PopoverContent className="w-auto p-0" align="start">
+ </DatePickerButton>
+ </DatePickerTrigger>
+ <DatePickerContent>
<Calendar
mode="single"
selected={field.value}
onSelect={field.onChange}
initialFocus
/>
- </PopoverContent>
- </Popover>
+ </DatePickerContent>
+ </DatePicker>
</FormControl>
</FormItemLayout>
)}
diff --git a/apps/design-system/registry/default/example/form-patterns-sidepanel.tsx b/apps/design-system/registry/default/example/form-patterns-sidepanel.tsx
index 99c75e107ec..1f2909f41a6 100644
--- a/apps/design-system/registry/default/example/form-patterns-sidepanel.tsx
+++ b/apps/design-system/registry/default/example/form-patterns-sidepanel.tsx
@@ -1,6 +1,6 @@
import { zodResolver } from '@hookform/resolvers/zod'
import { format } from 'date-fns'
-import { CalendarIcon, ExternalLink, Trash, Upload } from 'lucide-react'
+import { ExternalLink, Trash, Upload } from 'lucide-react'
import { useRef, useState } from 'react'
import { useForm } from 'react-hook-form'
import {
@@ -14,11 +14,7 @@ import {
Input,
InputGroup,
InputGroupAddon,
- InputGroupInput,
InputGroupText,
- Popover,
- PopoverContent,
- PopoverTrigger,
RadioGroupStacked,
RadioGroupStackedItem,
Select,
@@ -37,6 +33,12 @@ import {
Textarea,
} from 'ui'
import { Input as PasswordInput } from 'ui-patterns/DataInputs/Input'
+import {
+ DatePicker,
+ DatePickerButton,
+ DatePickerContent,
+ DatePickerTrigger,
+} from 'ui-patterns/DatePicker'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import { KeyValueFieldArray } from 'ui-patterns/form/KeyValueFieldArray/KeyValueFieldArray'
import { getKeyValueFieldArrayValidationIssues } from 'ui-patterns/form/KeyValueFieldArray/validation'
@@ -70,7 +72,7 @@ const formSchema = z
region: z.string().min(1, 'Region is required'),
schemas: z.array(z.string()).min(1, 'At least one schema is required'),
queueType: z.enum(['basic', 'partitioned']),
- expiryDate: z.date().optional(),
+ expiryDate: z.date(),
password: z.string().min(8, 'Password must be at least 8 characters'),
duration: z
.union([
@@ -666,32 +668,28 @@ export default function FormPatternsSidePanel() {
<FormField
control={form.control}
name="expiryDate"
- render={({ field }) => (
+ render={({ field, fieldState }) => (
<FormItemLayout
layout="horizontal"
label="Date Picker"
description="Date selection with calendar popover"
>
<FormControl className="col-span-6">
- <Popover>
- <PopoverTrigger asChild>
- <Button
- variant="outline"
- className="bg-control w-full justify-start text-left font-normal px-3 py-4"
- icon={<CalendarIcon className="h-4 w-4" />}
- >
+ <DatePicker>
+ <DatePickerTrigger asChild>
+ <DatePickerButton block isInvalid={fieldState.invalid}>
{field.value ? format(field.value, 'PPP') : 'Pick a date'}
- </Button>
- </PopoverTrigger>
- <PopoverContent className="w-auto p-0" align="start">
+ </DatePickerButton>
+ </DatePickerTrigger>
+ <DatePickerContent>
<Calendar
mode="single"
selected={field.value}
onSelect={field.onChange}
initialFocus
/>
- </PopoverContent>
- </Popover>
+ </DatePickerContent>
+ </DatePicker>
</FormControl>
</FormItemLayout>
)}
diff --git a/packages/ui-patterns/index.tsx b/packages/ui-patterns/index.tsx
index 8a2eb48ea6b..5b42cd773f3 100644
--- a/packages/ui-patterns/index.tsx
+++ b/packages/ui-patterns/index.tsx
@@ -9,6 +9,7 @@ export * from './src/AuthenticatedDropdownMenu'
export * from './src/Chart'
export * from './src/CommandMenu'
export * from './src/ComputeBadge'
+export * from './src/DatePicker'
export * from './src/EmptyStatePresentational'
export * from './src/FilterBar'
export * from './src/GlassPanel'
diff --git a/packages/ui-patterns/package.json b/packages/ui-patterns/package.json
index 093c476cd4d..72b4cd0a574 100644
--- a/packages/ui-patterns/package.json
+++ b/packages/ui-patterns/package.json
@@ -314,6 +314,10 @@
"import": "./src/DataInputs/Input.tsx",
"types": "./src/DataInputs/Input.tsx"
},
+ "./DatePicker": {
+ "import": "./src/DatePicker/index.ts",
+ "types": "./src/DatePicker/index.ts"
+ },
"./Dialogs/ConfirmationModal": {
"import": "./src/Dialogs/ConfirmationModal.tsx",
"types": "./src/Dialogs/ConfirmationModal.tsx"
diff --git a/packages/ui-patterns/src/DatePicker/DatePicker.tsx b/packages/ui-patterns/src/DatePicker/DatePicker.tsx
new file mode 100644
index 00000000000..f495a3604f3
--- /dev/null
+++ b/packages/ui-patterns/src/DatePicker/DatePicker.tsx
@@ -0,0 +1,50 @@
+import { CalendarIcon } from 'lucide-react'
+import { ComponentProps } from 'react'
+import { Button, cn, Popover, PopoverContent, PopoverTrigger } from 'ui'
+
+export const DatePicker = (props: ComponentProps<typeof Popover>) => {
+ return <Popover {...props} />
+}
+
+export const DatePickerTrigger = ({
+ asChild = true,
+ ...props
+}: ComponentProps<typeof PopoverTrigger>) => {
+ return <PopoverTrigger asChild={asChild} {...props} />
+}
+
+const DatePickerIcon = <CalendarIcon className="h-4 w-4" />
+
+export type DatePickerButtonProps = ComponentProps<typeof Button> & { isInvalid?: boolean }
+
+export const DatePickerButton = ({
+ className,
+ variant = 'default',
+ icon = DatePickerIcon,
+ isInvalid = false,
+ ...props
+}: DatePickerButtonProps) => {
+ return (
+ <Button
+ variant={variant}
+ className={cn(
+ 'justify-start text-left font-normal px-3 py-4',
+ {
+ 'bg-destructive-200! border-destructive-400 focus:border-destructive focus-visible:border-destructive focus-visible:outline-amber-700':
+ isInvalid,
+ },
+ className
+ )}
+ icon={icon}
+ {...props}
+ />
+ )
+}
+
+export const DatePickerContent = ({
+ className,
+ align = 'start',
+ ...props
+}: ComponentProps<typeof PopoverContent>) => {
+ return <PopoverContent className={cn('w-auto p-0', className)} align={align} {...props} />
+}
diff --git a/packages/ui-patterns/src/DatePicker/index.ts b/packages/ui-patterns/src/DatePicker/index.ts
new file mode 100644
index 00000000000..192c3958a5e
--- /dev/null
+++ b/packages/ui-patterns/src/DatePicker/index.ts
@@ -0,0 +1 @@
+export * from './DatePicker'