Date Range Picker

Facilitates the selection of date ranges through an input and calendar-based interface.

Rental Days

yyyy

	<script lang="ts">
  import { DateRangePicker } from "bits-ui";
  import CalendarBlank from "phosphor-svelte/lib/CalendarBlank";
  import CaretLeft from "phosphor-svelte/lib/CaretLeft";
  import CaretRight from "phosphor-svelte/lib/CaretRight";
</script>
 
<DateRangePicker.Root
  weekdayFormat="short"
  fixedWeeks={true}
  class="flex w-full max-w-[340px] flex-col gap-1.5"
>
  <DateRangePicker.Label class="block select-none text-sm font-medium"
    >Rental Days</DateRangePicker.Label
  >
  <div
    class="h-input rounded-input border-border-input bg-background text-foreground focus-within:border-border-input-hover focus-within:shadow-date-field-focus hover:border-border-input-hover flex w-full select-none items-center border px-2 py-3 text-sm tracking-[0.01em]"
  >
    {#each ["start", "end"] as const as type (type)}
      <DateRangePicker.Input {type}>
        {#snippet children({ segments })}
          {#each segments as { part, value }, i (part + i)}
            <div class="inline-block select-none">
              {#if part === "literal"}
                <DateRangePicker.Segment
                  {part}
                  class="text-muted-foreground p-1"
                >
                  {value}
                </DateRangePicker.Segment>
              {:else}
                <DateRangePicker.Segment
                  {part}
                  class="rounded-5px hover:bg-muted focus:bg-muted focus:text-foreground aria-[valuetext=Empty]:text-muted-foreground focus-visible:ring-0! focus-visible:ring-offset-0! px-1 py-1"
                >
                  {value}
                </DateRangePicker.Segment>
              {/if}
            </div>
          {/each}
        {/snippet}
      </DateRangePicker.Input>
      {#if type === "start"}
        <div aria-hidden="true" class="text-muted-foreground px-1">–⁠⁠⁠⁠⁠</div>
      {/if}
    {/each}
 
    <DateRangePicker.Trigger
      class="text-foreground/60 hover:bg-muted active:bg-dark-10 ml-auto inline-flex size-8 items-center justify-center rounded-[5px] transition-all"
    >
      <CalendarBlank class="size-6" />
    </DateRangePicker.Trigger>
  </div>
  <DateRangePicker.Content sideOffset={6} class="z-50">
    <DateRangePicker.Calendar
      class="rounded-15px border-dark-10 bg-background-alt shadow-popover mt-6 border p-[22px]"
    >
      {#snippet children({ months, weekdays })}
        <DateRangePicker.Header class="flex items-center justify-between">
          <DateRangePicker.PrevButton
            class="rounded-9px bg-background-alt hover:bg-muted inline-flex size-10 items-center justify-center transition-all active:scale-[0.98]"
          >
            <CaretLeft class="size-6" />
          </DateRangePicker.PrevButton>
          <DateRangePicker.Heading class="text-[15px] font-medium" />
          <DateRangePicker.NextButton
            class="rounded-9px bg-background-alt hover:bg-muted inline-flex size-10 items-center justify-center transition-all active:scale-[0.98]"
          >
            <CaretRight class="size-6" />
          </DateRangePicker.NextButton>
        </DateRangePicker.Header>
        <div
          class="flex flex-col space-y-4 pt-4 sm:flex-row sm:space-x-4 sm:space-y-0"
        >
          {#each months as month (month.value)}
            <DateRangePicker.Grid
              class="w-full border-collapse select-none space-y-1"
            >
              <DateRangePicker.GridHead>
                <DateRangePicker.GridRow
                  class="mb-1 flex w-full justify-between"
                >
                  {#each weekdays as day (day)}
                    <DateRangePicker.HeadCell
                      class="text-muted-foreground font-normal! w-10 rounded-md text-xs"
                    >
                      <div>{day.slice(0, 2)}</div>
                    </DateRangePicker.HeadCell>
                  {/each}
                </DateRangePicker.GridRow>
              </DateRangePicker.GridHead>
              <DateRangePicker.GridBody>
                {#each month.weeks as weekDates (weekDates)}
                  <DateRangePicker.GridRow class="flex w-full">
                    {#each weekDates as date (date)}
                      <DateRangePicker.Cell
                        {date}
                        month={month.value}
                        class="p-0! relative m-0 size-10 overflow-visible text-center text-sm focus-within:relative focus-within:z-20"
                      >
                        <DateRangePicker.Day
                          class="rounded-9px text-foreground hover:border-foreground focus-visible:ring-foreground! data-selection-end:rounded-9px data-selection-start:rounded-9px data-highlighted:bg-muted data-selected:bg-muted data-selection-end:bg-foreground data-selection-start:bg-foreground data-disabled:text-foreground/30 data-selected:text-foreground data-selection-end:text-background data-selection-start:text-background data-unavailable:text-muted-foreground data-selected:[&:not([data-selection-start])]:[&:not([data-selection-end])]:focus-visible:border-foreground data-disabled:pointer-events-none data-highlighted:rounded-none  data-outside-month:pointer-events-none data-selected:font-medium data-selection-end:font-medium data-selection-start:font-medium data-selection-start:focus-visible:ring-2 data-selection-start:focus-visible:ring-offset-2! data-unavailable:line-through data-selected:[&:not([data-selection-start])]:[&:not([data-selection-end])]:rounded-none data-selected:[&:not([data-selection-start])]:[&:not([data-selection-end])]:focus-visible:ring-0! data-selected:[&:not([data-selection-start])]:[&:not([data-selection-end])]:focus-visible:ring-offset-0! group relative inline-flex size-10 items-center justify-center overflow-visible whitespace-nowrap border border-transparent bg-transparent p-0 text-sm font-normal transition-all"
                        >
                          <div
                            class="bg-foreground group-data-selected:bg-background group-data-today:block absolute top-[5px] hidden size-1 rounded-full transition-all"
                          ></div>
                          {date.day}
                        </DateRangePicker.Day>
                      </DateRangePicker.Cell>
                    {/each}
                  </DateRangePicker.GridRow>
                {/each}
              </DateRangePicker.GridBody>
            </DateRangePicker.Grid>
          {/each}
        </div>
      {/snippet}
    </DateRangePicker.Calendar>
  </DateRangePicker.Content>
</DateRangePicker.Root>

	@import url("https://fonts.googleapis.com/css2?family=Source+Code+Pro:ital,wght@0,400;0,500;0,600;0,700;1,400;1,500;1,600;1,700&display=swap");
@import url("https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600&display=swap");
 
@import "tailwindcss";
@plugin "tailwindcss-animate";
 
@custom-variant dark (&:is(.dark *));
 
@font-face {
	font-family: "Cal Sans";
	font-style: normal;
	font-weight: 600;
	font-display: swap;
	src: url("/CalSans-SemiBold.woff2") format("woff2");
}
 
:root {
	/* Colors */
	--background: hsl(0 0% 100%);
	--background-alt: hsl(0 0% 100%);
	--foreground: hsl(0 0% 9%);
	--foreground-alt: hsl(0 0% 32%);
	--muted: hsl(240 5% 96%);
	--muted-foreground: hsla(0 0% 9% / 0.4);
	--border: hsl(240 6% 10%);
	--border-input: hsla(240 6% 10% / 0.17);
	--border-input-hover: hsla(240 6% 10% / 0.4);
	--border-card: hsla(240 6% 10% / 0.1);
	--dark: hsl(240 6% 10%);
	--dark-10: hsla(240 6% 10% / 0.1);
	--dark-40: hsla(240 6% 10% / 0.4);
	--dark-04: hsla(240 6% 10% / 0.04);
	--accent: hsl(204 94% 94%);
	--accent-foreground: hsl(204 80% 16%);
	--destructive: hsl(347 77% 50%);
	--tertiary: hsl(37.7 92.1% 50.2%);
	--line: hsl(0 0% 100%);
 
	/* black */
	--contrast: hsl(0 0% 0%);
 
	/* Shadows */
	--shadow-mini: 0px 1px 0px 1px rgba(0, 0, 0, 0.04);
	--shadow-mini-inset: 0px 1px 0px 0px rgba(0, 0, 0, 0.04) inset;
	--shadow-popover: 0px 7px 12px 3px hsla(var(--dark-10));
	--shadow-kbd: 0px 2px 0px 0px rgba(0, 0, 0, 0.07);
	--shadow-btn: 0px 1px 0px 1px rgba(0, 0, 0, 0.03);
	--shadow-card: 0px 2px 0px 1px rgba(0, 0, 0, 0.04);
	--shadow-date-field-focus: 0px 0px 0px 3px rgba(24, 24, 27, 0.17);
}
 
.dark {
	/* Colors */
	--background: hsl(0 0% 5%);
	--background-alt: hsl(0 0% 8%);
	--foreground: hsl(0 0% 95%);
	--foreground-alt: hsl(0 0% 70%);
	--muted: hsl(240 4% 16%);
	--muted-foreground: hsla(0 0% 100% / 0.4);
	--border: hsl(0 0% 96%);
	--border-input: hsla(0 0% 96% / 0.17);
	--border-input-hover: hsla(0 0% 96% / 0.4);
	--border-card: hsla(0 0% 96% / 0.1);
	--dark: hsl(0 0% 96%);
	--dark-40: hsl(0 0% 96% / 0.4);
	--dark-10: hsl(0 0% 96% / 0.1);
	--dark-04: hsl(0 0% 96% / 0.04);
	--accent: hsl(204 90% 90%);
	--accent-foreground: hsl(204 94% 94%);
	--destructive: hsl(350 89% 60%);
	--line: hsl(0 0% 9.02%);
	--tertiary: hsl(61.3 100% 82.2%);
	/* white */
	--contrast: hsl(0 0% 100%);
 
	/* Shadows */
	--shadow-mini: 0px 1px 0px 1px rgba(0, 0, 0, 0.3);
	--shadow-mini-inset: 0px 1px 0px 0px rgba(0, 0, 0, 0.5) inset;
	--shadow-popover: 0px 7px 12px 3px hsla(0deg 0% 0% / 30%);
	--shadow-kbd: 0px 2px 0px 0px rgba(255, 255, 255, 0.07);
	--shadow-btn: 0px 1px 0px 1px rgba(0, 0, 0, 0.2);
	--shadow-card: 0px 2px 0px 1px rgba(0, 0, 0, 0.4);
	--shadow-date-field-focus: 0px 0px 0px 3px rgba(244, 244, 245, 0.1);
}
 
@theme inline {
	--color-background: var(--background);
	--color-background-alt: var(--background-alt);
	--color-foreground: var(--foreground);
	--color-foreground-alt: var(--foreground-alt);
	--color-muted: var(--muted);
	--color-muted-foreground: var(--muted-foreground);
	--color-border: var(--border-card);
	--color-border-input: var(--border-input);
	--color-border-input-hover: var(--border-input-hover);
	--color-border-card: var(--border-card);
	--color-dark: var(--dark);
	--color-dark-10: var(--dark-10);
	--color-dark-40: var(--dark-40);
	--color-dark-04: var(--dark-04);
	--color-accent: var(--accent);
	--color-accent-foreground: var(--accent-foreground);
	--color-destructive: var(--destructive);
	--color-tertiary: var(--tertiary);
	--color-line: var(--line);
	--color-contrast: var(--contrast);
 
	--shadow-mini: var(--shadow-mini);
	--shadow-mini-inset: var(--shadow-mini-inset);
	--shadow-popover: var(--shadow-popover);
	--shadow-kbd: var(--shadow-kbd);
	--shadow-btn: var(--shadow-btn);
	--shadow-card: var(--shadow-card);
	--shadow-date-field-focus: var(--shadow-date-field-focus);
 
	--text-xxs: 10px;
 
	--radius-card: 16px;
	--radius-card-lg: 20px;
	--radius-card-sm: 10px;
	--radius-input: 9px;
	--radius-button: 5px;
	--radius-5px: 5px;
	--radius-9px: 9px;
	--radius-10px: 10px;
	--radius-15px: 15px;
 
	--spacing-input: 3rem;
	--spacing-input-sm: 2.5rem;
 
	--breakpoint-desktop: 1440px;
 
	--animate-accordion-down: accordion-down 0.2s ease-out;
	--animate-accordion-up: accordion-up 0.2s ease-out;
	--animate-caret-blink: caret-blink 1s ease-out infinite;
	--animate-scale-in: scale-in 0.2s ease;
	--animate-scale-out: scale-out 0.15s ease;
	--animate-fade-in: fade-in 0.2s ease;
	--animate-fade-out: fade-out 0.15s ease;
	--animate-enter-from-left: enter-from-left 0.2s ease;
	--animate-enter-from-right: enter-from-right 0.2s ease;
	--animate-exit-to-left: exit-to-left 0.2s ease;
	--animate-exit-to-right: exit-to-right 0.2s ease;
 
	--font-sans: "Inter", "sans-serif";
	--font-mono: "Source Code Pro", "monospace";
	--font-alt: "Courier", "sans-serif";
	--font-display: "Cal Sans", "sans-serif";
 
	@keyframes accordion-down {
		from {
			height: 0;
		}
		to {
			height: var(--bits-accordion-content-height);
		}
	}
 
	@keyframes accordion-up {
		from {
			height: var(--bits-accordion-content-height);
		}
		to {
			height: 0;
		}
	}
 
	@keyframes caret-blink {
		0%,
		70%,
		100% {
			opacity: 1;
		}
		20%,
		50% {
			opacity: 0;
		}
	}
 
	@keyframes enter-from-right {
		from {
			opacity: 0;
			transform: translateX(200px);
		}
		to {
			opacity: 1;
			transform: translateX(0);
		}
	}
 
	@keyframes enter-from-left {
		from {
			opacity: 0;
			transform: translateX(-200px);
		}
		to {
			opacity: 1;
			transform: translateX(0);
		}
	}
 
	@keyframes exit-to-right {
		from {
			opacity: 1;
			transform: translateX(0);
		}
		to {
			opacity: 0;
			transform: translateX(200px);
		}
	}
 
	@keyframes exit-to-left {
		from {
			opacity: 1;
			transform: translateX(0);
		}
		to {
			opacity: 0;
			transform: translateX(-200px);
		}
	}
 
	@keyframes scale-in {
		from {
			opacity: 0;
			transform: rotateX(-10deg) scale(0.9);
		}
		to {
			opacity: 1;
			transform: rotateX(0deg) scale(1);
		}
	}
 
	@keyframes scale-out {
		from {
			opacity: 1;
			transform: rotateX(0deg) scale(1);
		}
		to {
			opacity: 0;
			transform: rotateX(-10deg) scale(0.95);
		}
	}
 
	@keyframes fade-in {
		from {
			opacity: 0;
		}
		to {
			opacity: 1;
		}
	}
 
	@keyframes fade-out {
		from {
			opacity: 1;
		}
		to {
			opacity: 0;
		}
	}
}
 
@layer base {
	*,
	::after,
	::before,
	::backdrop,
	::file-selector-button {
		border-color: var(--color-border-card, currentColor);
	}
 
	* {
		@apply border-border;
	}
	html {
		-webkit-text-size-adjust: 100%;
		font-variation-settings: normal;
		scrollbar-color: var(--bg-muted);
	}
 
	body {
		@apply bg-background text-foreground;
		font-feature-settings:
			"rlig" 1,
			"calt" 1;
	}
 
	::selection {
		background: #fdffa4;
		color: black;
	}
}
 
@layer components {
	*:not(body):not(.focus-override) {
		outline: none !important;
		&:focus-visible {
			@apply focus-visible:ring-foreground focus-visible:ring-offset-background focus-visible:outline-hidden focus-visible:ring-2 focus-visible:ring-offset-1;
		}
	}
 
	.link {
		@apply hover:text-foreground/80 focus-visible:ring-foreground focus-visible:ring-offset-background rounded-xs focus-visible:outline-hidden inline-flex items-center gap-1 font-medium underline underline-offset-4 focus-visible:ring-2 focus-visible:ring-offset-2;
	}
}

Heads up!

Before diving into this component, it's important to understand how dates/times work in Bits UI. Please read the Dates documentation to learn more!

Structure

	<script lang="ts">
  import { DateRangePicker } from "bits-ui";
</script>
 
<DateRangePicker.Root>
  <DateRangePicker.Label />
  {#each ["start", "end"] as const as type}
    <DateRangePicker.Input {type}>
      {#snippet children({ segments })}
        {#each segments as { part, value }}
          <DateRangePicker.Segment {part}>
            {value}
          </DateRangePicker.Segment>
        {/each}
      {/snippet}
    </DateRangePicker.Input>
  {/each}
  <DateRangePicker.Trigger />
  <DateRangePicker.Content>
    <DateRangePicker.Calendar>
      {#snippet children({ months, weekdays })}
        <DateRangePicker.Header>
          <DateRangePicker.PrevButton />
          <DateRangePicker.Heading />
          <DateRangePicker.NextButton />
        </DateRangePicker.Header>
        {#each months as month}
          <DateRangePicker.Grid>
            <DateRangePicker.GridHead>
              <DateRangePicker.GridRow>
                {#each weekdays as day}
                  <DateRangePicker.HeadCell>
                    {day}
                  </DateRangePicker.HeadCell>
                {/each}
              </DateRangePicker.GridRow>
            </DateRangePicker.GridHead>
            <DateRangePicker.GridBody>
              {#each month.weeks as weekDates}
                <DateRangePicker.GridRow>
                  {#each weekDates as date}
                    <DateRangePicker.Cell {date} month={month.value}>
                      <DateRangePicker.Day>
                        {date.day}
                      </DateRangePicker.Day>
                    </DateRangePicker.Cell>
                  {/each}
                </DateRangePicker.GridRow>
              {/each}
            </DateRangePicker.GridBody>
          </DateRangePicker.Grid>
        {/each}
      {/snippet}
    </DateRangePicker.Calendar>
  </DateRangePicker.Content>
</DateRangePicker.Root>

Managing Placeholder State

This section covers how to manage the placeholder state of the component.

Two-Way Binding

Use bind:placeholder for simple, automatic state synchronization:

	<script lang="ts">
  import { DateRangePicker } from "bits-ui";
  import { CalendarDateTime } from "@internationalized/date";
  let myPlaceholder = $state(new CalendarDateTime(2024, 8, 3, 12, 30));
</script>
 
<DateRangePicker.Root bind:placeholder={myPlaceholder}>
  <!-- ... -->
</DateRangePicker.Root>

Fully Controlled

Use a Function Binding for complete control over the state's reads and writes.

	<script lang="ts">
  import { DateRangePicker } from "bits-ui";
  import type { DateValue } from "@internationalized/date";
  let myPlaceholder = $state<DateValue>();
 
  function getPlaceholder() {
    return myPlaceholder;
  }
 
  function setPlaceholder(newPlaceholder: DateValue) {
    myPlaceholder = newPlaceholder;
  }
</script>
 
<DateRangePicker.Root bind:placeholder={getPlaceholder, setPlaceholder}>
  <!-- ... -->
</DateRangePicker.Root>

Managing Value State

This section covers how to manage the value state of the component.

Two-Way Binding

Use bind:value for simple, automatic state synchronization:

	<script lang="ts">
  import { DateRangePicker } from "bits-ui";
  import { CalendarDateTime } from "@internationalized/date";
  let myValue = $state({
    start: new CalendarDateTime(2024, 8, 3, 12, 30),
    end: new CalendarDateTime(2024, 8, 4, 12, 30),
  });
</script>
 
<button
  onclick={() => {
    value = {
      start: value.start.add({ days: 1 }),
      end: value.end.add({ days: 1 }),
    };
  }}
>
  Add 1 day
</button>
<DateRangePicker.Root bind:value={myValue}>
  <!-- ... -->
</DateRangePicker.Root>

Fully Controlled

Use a Function Binding for complete control over the state's reads and writes.

	<script lang="ts">
  import { DateRangePicker, type DateRange } from "bits-ui";
  let myValue = $state<DateRange>();
 
  function getValue() {
    return myValue;
  }
 
  function setValue(newValue: DateRange) {
    myValue = newValue;
  }
</script>
 
<DateRangePicker.Root bind:value={getValue, setValue}>
  <!-- ... -->
</DateRangePicker.Root>

Managing Open State

This section covers how to manage the open state of the component.

Two-Way Binding

Use bind:open for simple, automatic state synchronization:

	<script lang="ts">
  import { DateRangePicker } from "bits-ui";
  let isOpen = $state(false);
</script>
 
<button onclick={() => (isOpen = true)}>Open DateRangePicker</button>
 
<DateRangePicker.Root bind:open={isOpen}>
  <!-- ... -->
</DateRangePicker.Root>

Fully Controlled

Use a Function Binding for complete control over the state's reads and writes.

	<script lang="ts">
  import { DateRangePicker } from "bits-ui";
  let myOpen = $state(false);
 
  function getOpen() {
    return myOpen;
  }
 
  function setOpen(newOpen: boolean) {
    myOpen = newOpen;
  }
</script>
 
<DateRangePicker.Root bind:open={getOpen, setOpen}>
  <!-- ... -->
</DateRangePicker.Root>

Customization

The DateRangePicker component is made up of three other Bits UI components: Date Range Field, Range Calendar, and Popover.

You can check out the documentation for each of these components to learn more about their customization options, each of which can be used to customize the DateRangePicker component.

API Reference

DateRangePicker.Root

The root date picker component.

Property	Type	Description
`value` $bindable	`DateRange`	The selected date range. `Default: —— undefined`
`onValueChange`	`function`	A function that is called when the selected date changes. `Default: —— undefined`
`placeholder` $bindable	`DateValue`	The placeholder date, which is used to determine what date to start the segments from when no value exists. `Default: —— undefined`
`onPlaceholderChange`	`function`	A function that is called when the placeholder date changes. `Default: —— undefined`
`readonlySegments`	`EditableSegmentPart[]`	An array of segments that should be readonly, which prevent user input on them. `Default: —— undefined`
`isDateUnavailable`	`function`	A function that returns whether or not a date is unavailable. `Default: —— undefined`
`minValue`	`DateValue`	The minimum valid date that can be entered. `Default: —— undefined`
`maxValue`	`DateValue`	The maximum valid date that can be entered. `Default: —— undefined`
`validate`	`function`	A function that returns whether or not a date is valid. `Default: —— undefined`
`onInvalid`	`function`	A callback fired when the value is invalid. `Default: —— undefined`
`granularity`	`enum`	The granularity to use for formatting the field. Defaults to `'day'` if a `CalendarDate` is provided, otherwise defaults to `'minute'`. The field will render segments for each part of the date up to and including the specified granularity. `Default: —— undefined`
`hideTimeZone`	`boolean`	Whether or not to hide the time zone segment of the field. `Default: false`
`errorMessageId`	`string`	The `id` of the element which contains the error messages for the date field when the date is invalid. `Default: —— undefined`
`hourCycle`	`enum`	The hour cycle to use for formatting times. Defaults to the locale preference `Default: —— undefined`
`locale`	`string`	The locale to use for formatting dates. `Default: en-US`
`disabled`	`boolean`	Whether or not the field is disabled. `Default: false`
`readonly`	`boolean`	Whether or not the field is readonly. `Default: false`
`required`	`boolean`	Whether or not the date field is required. `Default: false`
`closeOnRangeSelect`	`boolean`	Whether or not to close the popover when a date range is selected. `Default: true`
`disableDaysOutsideMonth`	`boolean`	Whether or not to disable days outside the current month. `Default: false`
`pagedNavigation`	`boolean`	Whether or not to use paged navigation for the calendar. Paged navigation causes the previous and next buttons to navigate by the number of months displayed at once, rather than by one month. `Default: false`
`preventDeselect`	`boolean`	Whether or not to prevent the user from deselecting a date without selecting another date first. `Default: false`
`weekdayFormat`	`enum`	The format to use for the weekday strings provided via the `weekdays` slot prop. `Default: ''narrow''`
`weekStartsOn`	`number`	An absolute day of the week to start the calendar on, regardless of locale. `0` is Sunday, `1` is Monday, etc. If not provided, the calendar will default to the locale's first day of the week. `Default: —— undefined`
`calendarLabel`	`string`	The accessible label for the calendar. `Default: —— undefined`
`fixedWeeks`	`boolean`	Whether or not to always display 6 weeks in the calendar. `Default: false`
`isDateDisabled`	`function`	A function that returns whether or not a date is disabled. `Default: —— undefined`
`numberOfMonths`	`number`	The number of months to display at once. `Default: 1`
`open` $bindable	`boolean`	The open state of the popover content. `Default: false`
`onOpenChange`	`function`	A callback function called when the open state changes. `Default: —— undefined`
`onOpenChangeComplete`	`function`	A callback function called after the open state changes and all animations have completed. `Default: —— undefined`
`onEndValueChange`	`function`	A function that is called when the end date changes. `Default: —— undefined`
`onStartValueChange`	`function`	A function that is called when the start date changes. `Default: —— undefined`
`minDays`	`number`	The minimum number of days that can be selected in a range. `Default: —— undefined`
`maxDays`	`number`	The maximum number of days that can be selected in a range. `Default: —— undefined`
`excludeDisabled`	`boolean`	Whether to automatically reset the range if any date within the selected range becomes disabled. `Default: false`
`monthFormat`	`union`	The format to use for the month strings provided via the `months` slot prop. `Default: 'long'`
`yearFormat`	`union`	The format to use for the year strings provided via the `years` slot prop. `Default: 'numeric'`
`ref` $bindable	`HTMLDivElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-invalid`	`''`	Present on the root element when the calendar is invalid.
`data-disabled`	`''`	Present on the root element when the calendar is disabled.
`data-readonly`	`''`	Present on the root element when the calendar is readonly.
`data-calendar-root`	`''`	Present on the root element.

DateRangePicker.Label

The label for the date field.

Property	Type	Description
`ref` $bindable	`HTMLSpanElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description	Details
`data-invalid`	`''`	Present on the element when the field is invalid
`data-date-field-label`	`''`	Present on the element.

DateRangePicker.Input

The field input component which contains the segments of the date field.

Property	Type	Description
`name`	`string`	The name of the input field used for form submission. If provided a hidden input will be rendered alongside the field. `Default: —— undefined`
`type` required	`enum`	The type of field to render (start or end). `Default: —— undefined`
`ref` $bindable	`HTMLDivElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-invalid`	`''`	Present on the element when the field is invalid.
`data-disabled`	`''`	Present on the element when the field is disabled.
`data-date-field-input`	`''`	Present on the element.

DateRangePicker.Segment

A segment of the date field.

Property	Type	Description
`part` required	`SegmentPart`	The part of the date to render. `Default: —— undefined`
`ref` $bindable	`HTMLSpanElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-invalid`	`''`	Present on the element when the field is invalid
`data-disabled`	`''`	Present on the element when the field is disabled
`data-segment`	`enum`	The type of segment the element represents.
`data-date-field-segment`	`''`	Present on the element.

DateRangePicker.Trigger

A component which toggles the opening and closing of the popover on press.

Property	Type	Description
`ref` $bindable	`HTMLButtonElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description	Details
`data-state`	`enum`	Whether the popover is open or closed.
`data-popover-trigger`	`''`	Present on the trigger element.

DateRangePicker.Content

The contents of the popover which are displayed when the popover is open.

Property	Type	Description
`side`	`enum`	The preferred side of the anchor to render the floating element against when open. Will be reversed when collisions occur. `Default: 'bottom'`
`sideOffset`	`number`	The distance in pixels from the anchor to the floating element. `Default: 0`
`align`	`enum`	The preferred alignment of the anchor to render the floating element against when open. This may change when collisions occur. `Default: 'start'`
`alignOffset`	`number`	The distance in pixels from the anchor to the floating element. `Default: 0`
`arrowPadding`	`number`	The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision. `Default: 0`
`avoidCollisions`	`boolean`	When `true`, overrides the `side` and `align` options to prevent collisions with the boundary edges. `Default: true`
`collisionBoundary`	`union`	A boundary element or array of elements to check for collisions against. `Default: —— undefined`
`collisionPadding`	`union`	The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision. `Default: 0`
`sticky`	`enum`	The sticky behavior on the align axis. `'partial'` will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst `'always'` will keep the content in the boundary regardless. `Default: 'partial'`
`hideWhenDetached`	`boolean`	When `true`, hides the content when it is detached from the DOM. This is useful for when you want to hide the content when the user scrolls away. `Default: true`
`updatePositionStrategy`	`enum`	The strategy to use when updating the position of the content. When `'optimized'` the content will only be repositioned when the trigger is in the viewport. When `'always'` the content will be repositioned whenever the position changes. `Default: 'optimized'`
`strategy`	`enum`	The positioning strategy to use for the floating element. When `'fixed'` the element will be positioned relative to the viewport. When `'absolute'` the element will be positioned relative to the nearest positioned ancestor. `Default: 'fixed'`
`preventScroll`	`boolean`	When `true`, prevents the body from scrolling when the content is open. This is useful when you want to use the content as a modal. `Default: false`
`customAnchor`	`union`	Use an element other than the trigger to anchor the content to. If provided, the content will be anchored to the provided element instead of the trigger. `Default: null`
`onInteractOutside`	`function`	Callback fired when an outside interaction event occurs, which is a `pointerdown` event. You can call `event.preventDefault()` to prevent the default behavior of handling the outside interaction. `Default: —— undefined`
`onFocusOutside`	`function`	Callback fired when focus leaves the dismissible layer. You can call `event.preventDefault()` to prevent the default behavior on focus leaving the layer. `Default: —— undefined`
`interactOutsideBehavior`	`enum`	The behavior to use when an interaction occurs outside of the floating content. `'close'` will close the content immediately. `'ignore'` will prevent the content from closing. `'defer-otherwise-close'` will defer to the parent element if it exists, otherwise it will close the content. `'defer-otherwise-ignore'` will defer to the parent element if it exists, otherwise it will ignore the interaction. `Default: 'close'`
`onEscapeKeydown`	`function`	Callback fired when an escape keydown event occurs in the floating content. You can call `event.preventDefault()` to prevent the default behavior of handling the escape keydown event. `Default: —— undefined`
`escapeKeydownBehavior`	`enum`	The behavior to use when an escape keydown event occurs in the floating content. `'close'` will close the content immediately. `'ignore'` will prevent the content from closing. `'defer-otherwise-close'` will defer to the parent element if it exists, otherwise it will close the content. `'defer-otherwise-ignore'` will defer to the parent element if it exists, otherwise it will ignore the interaction. `Default: 'close'`
`onOpenAutoFocus`	`function`	Event handler called when auto-focusing the content as it is opened. Can be prevented. `Default: —— undefined`
`onCloseAutoFocus`	`function`	Event handler called when auto-focusing the content as it is closed. Can be prevented. `Default: —— undefined`
`trapFocus`	`boolean`	Whether or not to trap the focus within the content when open. `Default: true`
`preventOverflowTextSelection`	`boolean`	When `true`, prevents the text selection from overflowing the bounds of the element. `Default: true`
`forceMount`	`boolean`	Whether or not to forcefully mount the content. This is useful if you want to use Svelte transitions or another animation library for the content. `Default: false`
`dir`	`enum`	The reading direction of the app. `Default: 'ltr'`
`ref` $bindable	`HTMLDivElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet` - type ChildSnippetProps = { /** * Props for the positioning wrapper * Do not style this element - * styling should be applied to the content element / wrapperProps: Record<string, unknown>; /* * Props for your content element * Apply your custom styles here / props: Record<string, unknown>; /* * Content visibility state * Use this for conditional rendering with * Svelte transitions */ open: boolean; };	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description	Details
`data-state`	`enum`	Whether the popover is open or closed.
`data-popover-content`	`''`	Present on the content element.

CSS Variable	Description	Details
`--bits-popover-content-transform-origin`	The transform origin of the content element.
`--bits-popover-content-available-width`	The available width of the content element.
`--bits-popover-content-available-height`	The available height of the content element.
`--bits-popover-anchor-width`	The width of the anchor element.
`--bits-popover-anchor-height`	The height of the anchor element.

DateRangePicker.Portal

When used, will render the popover content into the body or custom to element when open

Property	Type	Description
`to`	`union`	Where to render the content when it is open. Defaults to the body. `Default: document.body`
`disabled`	`boolean`	Whether the portal is disabled or not. When disabled, the content will be rendered in its original DOM location. `Default: false`
`children`	`Snippet`	The children content to render. `Default: —— undefined`

Data Attribute	Value	Description	Details

DateRangePicker.Calendar

The calendar component containing the grids of dates.

Data Attribute	Value	Description
`data-invalid`	`''`	Present on the root element when the calendar is invalid.
`data-disabled`	`''`	Present on the root element when the calendar is disabled.
`data-readonly`	`''`	Present on the root element when the calendar is readonly.
`data-calendar-root`	`''`	Present on the root element.

The header of the calendar.

Property	Type	Description
`ref` $bindable	`HTMLElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-disabled`	`''`	Present on the header element when the calendar is disabled.
`data-readonly`	`''`	Present on the header element when the calendar is readonly.
`data-range-calendar-header`	`''`	Present on the header element.

DateRangePicker.PrevButton

The previous button of the calendar.

Property	Type	Description
`ref` $bindable	`HTMLButtonElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description	Details
`data-disabled`	`''`	Present on the prev button element when the calendar or this button is disabled.
`data-range-calendar-prev-button`	`''`	Present on the prev button element.

DateRangePicker.Heading

The heading of the calendar.

Property	Type	Description
`ref` $bindable	`HTMLDivElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-disabled`	`''`	Present on the heading element when the calendar is disabled.
`data-readonly`	`''`	Present on the heading element when the calendar is readonly.
`data-range-calendar-heading`	`''`	Present on the heading element.

DateRangePicker.NextButton

The next button of the calendar.

Property	Type	Description
`ref` $bindable	`HTMLButtonElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description	Details
`data-disabled`	`''`	Present on the next button element when the calendar or this button is disabled.
`data-range-calendar-next-button`	`''`	Present on the next button element.

DateRangePicker.Grid

The grid of dates in the calendar, typically representing a month.

Property	Type	Description
`ref` $bindable	`HTMLTableElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-disabled`	`''`	Present on the grid element when the calendar is disabled.
`data-readonly`	`''`	Present on the grid element when the calendar is readonly.
`data-range-calendar-grid`	`''`	Present on the grid element.

DateRangePicker.GridRow

A row in the grid of dates in the calendar.

Property	Type	Description
`ref` $bindable	`HTMLTableRowElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-disabled`	`''`	Present on the grid row element when the calendar is disabled.
`data-readonly`	`''`	Present on the grid row element when the calendar is readonly.
`data-range-calendar-grid-row`	`''`	Present on the grid row element.

DateRangePicker.GridHead

The head of the grid of dates in the calendar.

Property	Type	Description
`ref` $bindable	`HTMLTableSectionElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-disabled`	`''`	Present on the grid head element when the calendar is disabled.
`data-readonly`	`''`	Present on the grid head element when the calendar is readonly.
`data-range-calendar-grid-head`	`''`	Present on the grid head element.

DateRangePicker.HeadCell

A cell in the head of the grid of dates in the calendar.

Property	Type	Description
`ref` $bindable	`HTMLTableCellElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-disabled`	`''`	Present on the head cell element when the calendar is disabled.
`data-readonly`	`''`	Present on the head cell element when the calendar is readonly.
`data-range-calendar-head-cell`	`''`	Present on the head cell element.

DateRangePicker.GridBody

The body of the grid of dates in the calendar.

Property	Type	Description
`ref` $bindable	`HTMLTableSectionElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-disabled`	`''`	Present on the grid element when the calendar is disabled.
`data-readonly`	`''`	Present on the grid element when the calendar is readonly.
`data-range-calendar-grid-body`	`''`	Present on the grid body element.

DateRangePicker.Cell

A cell in the calendar grid.

Property	Type	Description
`date`	`DateValue`	The date for the cell. `Default: —— undefined`
`month`	`DateValue`	The current month the date is being displayed in. `Default: —— undefined`
`ref` $bindable	`HTMLTableCellElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-disabled`	`''`	Present when the day is disabled.
`data-unavailable`	`''`	Present when the day is unavailable.
`data-today`	`''`	Present when the day is today.
`data-outside-month`	`''`	Present when the day is outside the current month.
`data-outside-visible-months`	`''`	Present when the day is outside the visible months.
`data-focused`	`''`	Present when the day is focused.
`data-selected`	`''`	Present when the day is selected.
`data-value`	`''`	The date in the format "YYYY-MM-DD".
`data-range-calendar-cell`	`''`	Present on the cell element.
`data-range-start`	`''`	Present when the cell is the start of a selection range.
`data-range-end`	`''`	Present when the cell is the end of a selection range.
`data-range-middle`	`''`	Present when the cell is in the middle of a selection range, but not the start or end of the selection.
`data-highlighted`	`''`	Present when the cell is highlighted within a selection range.

DateRangePicker.Day

A day in the calendar grid.

Property	Type	Description
`ref` $bindable	`HTMLDivElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description
`data-disabled`	`''`	Present when the day is disabled.
`data-unavailable`	`''`	Present when the day is unavailable.
`data-today`	`''`	Present when the day is today.
`data-outside-month`	`''`	Present when the day is outside the current month.
`data-outside-visible-months`	`''`	Present when the day is outside the visible months.
`data-focused`	`''`	Present when the day is focused.
`data-selected`	`''`	Present when the day is selected.
`data-value`	`''`	The date in the format "YYYY-MM-DD".
`data-range-calendar-day`	`''`	Present on the day element.
`data-range-start`	`''`	Present when the cell is the start of a selection range.
`data-range-end`	`''`	Present when the cell is the end of a selection range.
`data-range-middle`	`''`	Present when the cell is in the middle of a selection range, but not the start or end of the selection.
`data-highlighted`	`''`	Present when the cell is highlighted within a selection range.

DateRangePicker.MonthSelect

A select you can use to navigate to a specific month in the calendar view.

Property	Type	Description
`months`	`number[]`	The month values to render in the select. `Default: [1-12]`
`monthFormat`	`enum`	The format to use for the month strings provided via the `months` slot prop. If a function is provided, it will be called with the month number as an argument and should return a string. `Default: ''narrow''`
`ref` $bindable	`HTMLSelectElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description	Details
`data-disabled`	`''`	Present on the month select element when the calendar is disabled.
`data-range-calendar-month-select`	`''`	Present on the month select element.

DateRangePicker.YearSelect

A select you can use to navigate to a specific year in the calendar view.

Property	Type	Description
`years`	`number[]`	The year values to render in the select. Default: The current year or placeholder year (whichever is higher) + 10 and minus 100 years. When a `minValue`/`maxValue` is provided to `Calendar.Root`, those will be used to constrain the range.
`yearFormat`	`enum`	The format to use for the year strings provided via the `years` slot prop. If a function is provided, it will be called with the year as an argument and should return a string. `Default: ''numeric''`
`ref` $bindable	`HTMLSelectElement`	The underlying DOM element being rendered. You can bind to this to get a reference to the element. `Default: null`
`children`	`Snippet`	The children content to render. `Default: —— undefined`
`child`	`Snippet`	Use render delegation to render your own element. See Child Snippet docs for more information. `Default: —— undefined`

Data Attribute	Value	Description	Details
`data-disabled`	`''`	Present on the year select element when the calendar is disabled.
`data-range-calendar-year-select`	`''`	Present on the year select element.

Date Range Picker Documentation

Heads up!

Structure

Managing Placeholder State

Two-Way Binding

Fully Controlled

Managing Value State

Two-Way Binding

Fully Controlled

Managing Open State

Two-Way Binding

Fully Controlled

Customization

API Reference

DateRangePicker.Root

DateRangePicker.Label

DateRangePicker.Input

DateRangePicker.Segment

DateRangePicker.Trigger

DateRangePicker.Content

DateRangePicker.Portal

DateRangePicker.Calendar

DateRangePicker.Header

DateRangePicker.PrevButton

DateRangePicker.Heading

DateRangePicker.NextButton

DateRangePicker.Grid

DateRangePicker.GridRow

DateRangePicker.GridHead

DateRangePicker.HeadCell

DateRangePicker.GridBody

DateRangePicker.Cell

DateRangePicker.Day

DateRangePicker.MonthSelect

DateRangePicker.YearSelect

Date Range Picker