# Koyomi v0.2.1 - Table of Contents

> Dates for Phoenix: date, range, time and recurrence pickers for LiveView forms, with Ecto types and the same rules on the server.

## Pages

- [Koyomi](readme.md)
- [Changelog](changelog.md)

- Guides
  - [Quickstart](quickstart.md)
  - [Pickers](pickers.md)
  - [Forms](forms.md)
  - [Filters and URLs](filters.md)
  - [Rules](rules.md)
  - [Typing dates](typing.md)
  - [Locales and calendars](calendars.md)
  - [Time zones](time_zones.md)
  - [Day content](days.md)
  - [Recurrence](recurrence.md)
  - [Testing](testing.md)
  - [Theming](theming.md)

- Reference
  - [Accessibility](accessibility.md)
  - [Known limits](limits.md)

## Modules

- [Koyomi.Dates](Koyomi.Dates.md): An Ecto type for a set of days, stored in a `date[]` column (an array
of dates), for the multiple-date picker.
- [Koyomi.Holiday](Koyomi.Holiday.md): A public holiday on one day, as `Koyomi.Holidays` lists it.
- [Koyomi.Holidays.AR](Koyomi.Holidays.AR.md): The national holidays of Argentina (Ley 27.399), in Spanish.
- [Koyomi.Holidays.AT](Koyomi.Holidays.AT.md): The public holidays of Austria (Feiertagsruhegesetz and
Arbeitsruhegesetz), in German.

- [Koyomi.Holidays.AU](Koyomi.Holidays.AU.md): The public holidays of Australia kept in every state and territory, in
English.
- [Koyomi.Holidays.BE](Koyomi.Holidays.BE.md): The ten legal public holidays of Belgium, in Dutch, the language of
most Belgians (French and German are official too).
- [Koyomi.Holidays.BR](Koyomi.Holidays.BR.md): The national holidays of Brazil, in Portuguese.
- [Koyomi.Holidays.CA](Koyomi.Holidays.CA.md): The general holidays of Canada's federal jurisdiction (Canada Labour
Code), in English: the national choice, since each province keeps its
own list.
- [Koyomi.Holidays.CH](Koyomi.Holidays.CH.md): The holidays of Switzerland kept in every canton, in German, the
language of most Swiss (French, Italian and Romansh are official too).
- [Koyomi.Holidays.DE](Koyomi.Holidays.DE.md): The public holidays of Germany kept in every state, in German.
- [Koyomi.Holidays.DK](Koyomi.Holidays.DK.md): The public holidays of Denmark (helligdage), in Danish.
- [Koyomi.Holidays.ES](Koyomi.Holidays.ES.md): The national holidays of Spain, in Spanish: the days that are holidays
in every autonomous community.
- [Koyomi.Holidays.FI](Koyomi.Holidays.FI.md): The public holidays of Finland, in Finnish, the language of most Finns
(Swedish is official too).
- [Koyomi.Holidays.FR](Koyomi.Holidays.FR.md): The public holidays of metropolitan France (Code du travail, article
L3133-1), in French.
- [Koyomi.Holidays.GB](Koyomi.Holidays.GB.md): The bank holidays of England and Wales, in English. Scotland and
Northern Ireland have other lists, and are not covered.
- [Koyomi.Holidays.IE](Koyomi.Holidays.IE.md): The public holidays of Ireland (Organisation of Working Time Act 1997),
in English, the language most people use for them.
- [Koyomi.Holidays.IN](Koyomi.Holidays.IN.md): The three national holidays of India, in Hindi: Republic Day,
Independence Day and Gandhi Jayanti.
- [Koyomi.Holidays.IT](Koyomi.Holidays.IT.md): The national holidays of Italy, in Italian.
- [Koyomi.Holidays.JP](Koyomi.Holidays.JP.md): The national holidays of Japan (国民の祝日に関する法律), in Japanese.
- [Koyomi.Holidays.MX](Koyomi.Holidays.MX.md): The mandatory rest days of Mexico (Ley Federal del Trabajo, article 74),
in Spanish.
- [Koyomi.Holidays.NL](Koyomi.Holidays.NL.md): The national holidays of the Netherlands, in Dutch.
- [Koyomi.Holidays.NO](Koyomi.Holidays.NO.md): The public holidays of Norway (helligdager and offentlige høytidsdager),
in Norwegian Bokmål.

- [Koyomi.Holidays.NZ](Koyomi.Holidays.NZ.md): The national public holidays of New Zealand (Holidays Act 2003), in
English.
- [Koyomi.Holidays.PL](Koyomi.Holidays.PL.md): The public holidays of Poland (Ustawa o dniach wolnych od pracy), in
Polish.
- [Koyomi.Holidays.PT](Koyomi.Holidays.PT.md): The mandatory public holidays of Portugal (Código do Trabalho, article
234), in Portuguese.
- [Koyomi.Holidays.Provider](Koyomi.Holidays.Provider.md): A source of holidays that `Koyomi.Holidays` can read, for example the
holidays of a region or the days a company is closed.
- [Koyomi.Holidays.Rules](Koyomi.Holidays.Rules.md): Date rules for holidays: Easter, the nth weekday of a month, and the
days that replace a holiday on a weekend. The built-in countries use
them, and a `Koyomi.Holidays.Provider` can too.
- [Koyomi.Holidays.SE](Koyomi.Holidays.SE.md): The public holidays of Sweden (allmänna helgdagar), in Swedish.
- [Koyomi.Holidays.US](Koyomi.Holidays.US.md): The federal holidays of the United States (5 U.S.C. 6103), in English.
- [Koyomi.Holidays.ZA](Koyomi.Holidays.ZA.md): The public holidays of South Africa (Public Holidays Act 1994), in
English, the language South Africans share most.

- Pickers
  - [Koyomi](Koyomi.md): Koyomi (暦) adds date pickers to a Phoenix app.
  - [Koyomi.Components](Koyomi.Components.md): Function components for the Koyomi pickers.
  - [Koyomi.Live](Koyomi.Live.md): Helpers for a LiveView (or a LiveComponent) with Koyomi pickers.
  - [Koyomi.Messages](Koyomi.Messages.md): The words of the pickers: button labels, hints, announcements for screen
readers and the messages of a refused choice.
  - [Koyomi.Presets](Koyomi.Presets.md): Presets: the common choices beside the calendar, such as "Today",
"Last 7 days" or "In a month".

- Rules
  - [Koyomi.Changeset](Koyomi.Changeset.md): Changeset validations with the rules of a picker (see `Koyomi.Rules`).
  - [Koyomi.Rules](Koyomi.Rules.md): The rules of a picker: which days, ranges and times a person may choose.

- Types
  - [Koyomi.DateRange](Koyomi.DateRange.md): An Ecto type for a range of days. The value is a `Date.Range` with a
step of 1, both ends included.
  - [Koyomi.DateTimeRange](Koyomi.DateTimeRange.md): An Ecto type for a span of time: a start and an end instant, the start
included and the end left out (`[from, to)`), as for a booking from
14:00 to 16:00.
  - [Koyomi.Month](Koyomi.Month.md): An Ecto type for a month, stored in a `:date` column as the first day
of the month.
  - [Koyomi.Week](Koyomi.Week.md): An Ecto type for an ISO 8601 week, stored in a `:date` column as the
Monday of the week.

- Calendar
  - [Koyomi.Holidays](Koyomi.Holidays.md): Public holidays, computed by rule, for the pickers to mark days.
  - [Koyomi.ISOWeek](Koyomi.ISOWeek.md): ISO 8601 weeks: weeks start on Monday, and week 1 of a year is the week
that holds the year's first Thursday. A week is written `2027-W11`.
  - [Koyomi.Recurrence](Koyomi.Recurrence.md): A recurrence rule: a subset of the RFC 5545 `RRULE`, with the same
parsing, serialization, occurrences and descriptions as the browser
module `rrule.ts`.

- Testing
  - [Koyomi.Test](Koyomi.Test.md): Helpers for `Phoenix.LiveViewTest`, to pick values in tests with no
browser.

## Mix Tasks

- [mix koyomi.build](Mix.Tasks.Koyomi.Build.md): Builds the Koyomi pickers into `priv/static`.
- [mix koyomi.install](Mix.Tasks.Koyomi.Install.md): Sets up Koyomi in a Phoenix application.
- [mix koyomi.release_check](Mix.Tasks.Koyomi.ReleaseCheck.md): Checks the built files before a release of Koyomi.