Skip to content

buildMonthGrid — @gj-kit/expo-ui

A public function from @gj-kit/expo-ui. The signature below is taken directly from the 0.8.1 release declaration.

import { buildMonthGrid } from '@gj-kit/expo-ui';
/**
* Lays a month out as weeks of seven cells. The first and last weeks are
* completed with real adjacent-month dates flagged `inMonth: false`, and the
* grid spans exactly as many weeks as the month needs (4–6) — a month that
* fills whole weeks exactly gets no padding cells at all.
*
* Every month of the supported year space (1–9999) lays out without throwing.
* At the two edge months (January 0001, December 9999) the padding cells name
* days outside that space (year 0 / 10000) — see the MonthGridCell caveat;
* such cells are not valid CalendarDates.
*/
declare function buildMonthGrid(year: number, month: number, weekStartsOn?: CalendarWeekStart): MonthGrid;

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

  • Package: @gj-kit/expo-ui
  • Version: 0.8.1
  • Public entry: .
  • Source: GitHub