Type Alias: Modifiers

Modifiers: Record<string, boolean>

Represents the modifiers that match a specific day in the calendar.

• Retrieve modifiers using the OnSelectHandler via the onSelect prop, or within custom components using the useDayPicker hook.
• Includes built-in modifiers from DayFlag and SelectionState.
• Add custom modifiers using the modifiers prop.

Example

const modifiers: Modifiers = {
  today: false, // the day is not today
  selected: true, // the day is selected
  disabled: false, // the day is not disabled
  outside: false, // the day is not outside the month
  focused: false, // the day is not focused

  weekend: false // custom modifier example for matching a weekend
  booked: true // custom modifier example for matching a booked day
  available: false // custom modifier example for matching an available day
  };

See

https://daypicker.dev/guides/custom-modifiers

Defined in

src/types/shared.ts:344