| to | No | End of the date range, inclusive (yyyy-MM-dd). | |
| from | No | Start of a date range, instead of year (yyyy-MM-dd). | |
| year | No | Calendar year, e.g. 2027. Defaults to this year. | |
| region | No | Where the person works: england-and-wales, scotland or northern-ireland for UK bank holidays (from gov.uk); IE for Ireland; an Australian state or territory as AU-NSW, AU-VIC, AU-QLD, AU-WA, AU-SA, AU-TAS, AU-ACT or AU-NT (their public holidays differ a lot); US for US federal holidays; or a two-letter ISO 3166-1 country code such as DE or FR for other countries' public holidays (from Nager.Date). Defaults to england-and-wales. | england-and-wales |
| holiday | No | Only holidays whose name contains this, e.g. "Easter", "Christmas", "May". | |
| workdays | No | Days the person works, e.g. ["mon","tue","wed","thu"] for a four-day week. Defaults to Monday to Friday. | |
| us_holidays | No | US only: which holidays the person's employer gives. Private employers choose: common = the usual six (New Year's Day, Memorial Day, Independence Day, Labor Day, Thanksgiving, Christmas); federal = all 11 federal holidays; custom = the ones in us_holiday_ids. Default here: federal, to show every option. | federal |
| max_leave_days | No | Most days of leave for one break. Default 9. | |
| us_holiday_ids | No | US only, with us_holidays: custom. Any of: new-years-day, mlk-day, washingtons-birthday, memorial-day, juneteenth, independence-day, labor-day, columbus-day, veterans-day, thanksgiving, day-after-thanksgiving, christmas-day (day-after-thanksgiving isn't federal, but many employers give it). | |
| next_working_day_off | No | Ireland only: true if the person's employer gives the next working day off when a public holiday falls on a Saturday or Sunday (the civil service and banks do; Irish law doesn't require it, so the employer may give a day within a month, an extra day's leave or a day's pay instead). Adds those days, e.g. Mon 27 and Tue 28 Dec 2027. Default false. | |