Reference
Calendar icons
import { … } from "@johnmorrisdotca/koyomi-calendars";
Exports
| Name | Kind | What it is |
|---|---|---|
CALENDAR_HOUSINGS | constant | The housings an icon can sit in: square (the icon alone) and circle (on a coloured disc). |
CALENDAR_PRESETS | constant | The named looks: flat, disc, ringed, tilted and disc-ringed. |
CALENDAR_THEME_ALIASES | constant | The ten names of 0.12 and 0.13, still accepted: each reads as the theme that replaced it. |
CALENDAR_THEME_LABELS | constant | Each design's name for a picker, in English and in Japanese. |
CALENDAR_THEMES | constant | The 18 designs, by name. |
CALENDAR_TURN_MAX | constant | The most the icon may be turned either way, in degrees. |
CALENDAR_YEAR_CLEAR | constant | The share of the drawing's width the year keeps clear of the bottom of its zone. |
CALENDAR_YEAR_MIN | constant | The year is never smaller than this share of the drawing's width (its font size). |
CalendarDate | type | A day on the calendar: a four-digit year, a month 1 to 12 and a day of the month. |
CalendarHousing | type | One of the housings in CALENDAR_HOUSINGS. |
calendarIcon | function | An original calendar-page SVG for a month, day and optional year. |
CalendarIconOptions | type | What calendarIcon takes: the date, the design and the look of one calendar page. |
calendarLayout | function | The box, the page and the year's room of a theme, with and without a year. |
CalendarLayout | type | Where a theme puts the day and the year; a theme's layout says it once and the drawing and the tests both read it. |
CalendarLook | type | The three options a preset sets: a housing, rings and a turn. |
calendarMoon | function | The phase of the moon at noon UTC on a date, in eighths of a lunation: 0 new, 2 first quarter, 4 full, 6 last quarter. |
CalendarPreset | type | One of the names in CALENDAR_PRESETS. |
calendarPresetOf | function | Reads a preset's name. |
CalendarTheme | type | One of the names in CALENDAR_THEMES. |
calendarThemeOf | function | Reads a design's name, or an older name for one. |
calendarWeekend | function | The Saturday and the Sunday of the weekend a date is in. |
JAPANESE_HOLIDAY_YEARS | constant | The first and last year the holiday rules describe. |
japaneseHoliday | function | The public holiday of a day, in both languages. |
JapaneseHoliday | type | A Japanese public holiday's name, in Japanese and in English. |
japaneseHolidaysOf | function | Every public holiday of a year, computed from the law's rules. |
OLD_CALENDAR_YEARS | constant | The first and last year the old-calendar astronomy is held to. |
oldCalendarDate | function | The old-calendar date of a Gregorian date, from the new moons and the sun's longitude. |
OldDate | type | A date of the old Japanese calendar (旧暦, kyūreki): a month 1 to 12, a day, and whether the month is a leap month. |
Rokuyo | type | One day of the six-day cycle (六曜, rokuyō): its name, its reading and an English gloss. |
ROKUYO | constant | The six days in order of (old month + old day) mod 6, with the reading and an English gloss. |
rokuyoOf | function | The day of the six-day cycle (六曜, rokuyō) of a Gregorian date. |