@proyecto-viviana/solid-stately 0.2.7 → 0.4.0

package/src/calendar/createCalendarState.d.ts

@@ -4,127 +4,149 @@
  * Provides state management for calendar components.
  * Based on @react-stately/calendar useCalendarState
  */
-import { type Accessor } from 'solid-js';
-import { type CalendarDate, type DateValue } from '@internationalized/date';
-import { type MaybeAccessor } from '../utils';
-export type ValidationState = 'valid' | 'invalid';
+import { type Accessor } from "solid-js";
+import {
+  type Calendar as InternationalizedCalendar,
+  type CalendarDate,
+  type CalendarIdentifier,
+  type DateValue,
+} from "@internationalized/date";
+import { type MaybeAccessor } from "../utils";
+export type ValidationState = "valid" | "invalid";
+export type CalendarPageBehavior = "single" | "visible";
+export type CalendarSelectionAlignment = "start" | "center" | "end";
+export type CalendarDayOfWeek = "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat";
 export interface CalendarStateProps<T extends DateValue = DateValue> {
-    /** The current value (controlled). */
-    value?: MaybeAccessor<T | null>;
-    /** The default value (uncontrolled). */
-    defaultValue?: T | null;
-    /** Handler called when the value changes. */
-    onChange?: (value: T) => void;
-    /** The minimum allowed date. */
-    minValue?: MaybeAccessor<DateValue | undefined>;
-    /** The maximum allowed date. */
-    maxValue?: MaybeAccessor<DateValue | undefined>;
-    /** Whether the calendar is disabled. */
-    isDisabled?: MaybeAccessor<boolean>;
-    /** Whether the calendar is read-only. */
-    isReadOnly?: MaybeAccessor<boolean>;
-    /** Whether dates outside the visible range are automatically focused. */
-    autoFocus?: boolean;
-    /** The date that is focused when the calendar first mounts. */
-    focusedValue?: MaybeAccessor<DateValue | undefined>;
-    /** The default focused date (uncontrolled). */
-    defaultFocusedValue?: DateValue;
-    /** Handler called when the focused date changes. */
-    onFocusChange?: (date: CalendarDate) => void;
-    /** The locale to use for formatting. */
-    locale?: string;
-    /** Callback that is called for each date in the calendar to determine if it is unavailable. */
-    isDateUnavailable?: (date: DateValue) => boolean;
-    /** The number of months to display at once. */
-    visibleMonths?: number;
-    /** Whether to automatically focus the calendar when it is mounted. */
-    autoFocusOnMount?: boolean;
-    /** Controls which days are disabled. */
-    isDateDisabled?: (date: DateValue) => boolean;
-    /** Validation state. */
-    validationState?: MaybeAccessor<ValidationState | undefined>;
-    /** Error message. */
-    errorMessage?: string;
-    /** The first day of the week (0 = Sunday, 1 = Monday, etc.). */
-    firstDayOfWeek?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+  /** The current value (controlled). */
+  value?: MaybeAccessor<T | null>;
+  /** The default value (uncontrolled). */
+  defaultValue?: T | null;
+  /** Handler called when the value changes. */
+  onChange?: (value: T | null) => void;
+  /** The minimum allowed date. */
+  minValue?: MaybeAccessor<DateValue | undefined>;
+  /** The maximum allowed date. */
+  maxValue?: MaybeAccessor<DateValue | undefined>;
+  /** Whether the calendar is disabled. */
+  isDisabled?: MaybeAccessor<boolean>;
+  /** Whether the calendar is read-only. */
+  isReadOnly?: MaybeAccessor<boolean>;
+  /** Whether dates outside the visible range are automatically focused. */
+  autoFocus?: boolean;
+  /** The date that is focused when the calendar first mounts. */
+  focusedValue?: MaybeAccessor<DateValue | null | undefined>;
+  /** The default focused date (uncontrolled). */
+  defaultFocusedValue?: DateValue;
+  /** Handler called when the focused date changes. */
+  onFocusChange?: (date: CalendarDate) => void;
+  /** The locale to use for formatting. */
+  locale?: MaybeAccessor<string | undefined>;
+  /** Creates a calendar object for a locale calendar identifier. */
+  createCalendar?: (identifier: CalendarIdentifier) => InternationalizedCalendar;
+  /** Callback that is called for each date in the calendar to determine if it is unavailable. */
+  isDateUnavailable?: (date: DateValue) => boolean;
+  /** The number of months to display at once. */
+  visibleMonths?: number;
+  /** Controls whether paging advances by one month or by the visible month range. */
+  pageBehavior?: CalendarPageBehavior;
+  /** Determines how the visible months align around the initial focused date. */
+  selectionAlignment?: CalendarSelectionAlignment;
+  /** Whether to automatically focus the calendar when it is mounted. */
+  autoFocusOnMount?: boolean;
+  /** Controls which days are disabled. */
+  isDateDisabled?: (date: DateValue) => boolean;
+  /** Validation state. */
+  validationState?: MaybeAccessor<ValidationState | undefined>;
+  /** Error message. */
+  errorMessage?: string;
+  /** The first day of the week (0 = Sunday, 1 = Monday, etc.). */
+  firstDayOfWeek?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
 }
 export interface CalendarState<T extends DateValue = DateValue> {
-    /** The currently selected date. */
-    value: Accessor<T | null>;
-    /** Sets the selected date. */
-    setValue: (value: T | null) => void;
-    /** The currently focused date. */
-    focusedDate: Accessor<CalendarDate>;
-    /** Sets the focused date. */
-    setFocusedDate: (date: CalendarDate) => void;
-    /** Whether the calendar is disabled. */
-    isDisabled: Accessor<boolean>;
-    /** Whether the calendar is read-only. */
-    isReadOnly: Accessor<boolean>;
-    /** The visible date range (first and last day of visible month(s)). */
-    visibleRange: Accessor<{
-        start: CalendarDate;
-        end: CalendarDate;
-    }>;
-    /** The timezone used for date calculations. */
-    timeZone: string;
-    /** The validation state. */
-    validationState: Accessor<ValidationState | undefined>;
-    /** Whether a date is selected. */
-    isSelected: (date: DateValue) => boolean;
-    /** Whether a date is focused. */
-    isCellFocused: (date: DateValue) => boolean;
-    /** Whether a date is unavailable. */
-    isCellUnavailable: (date: DateValue) => boolean;
-    /** Whether a date is disabled. */
-    isCellDisabled: (date: DateValue) => boolean;
-    /** Whether a date is outside the visible range. */
-    isOutsideVisibleRange: (date: DateValue) => boolean;
-    /** Whether a date is invalid. */
-    isInvalid: (date: DateValue) => boolean;
-    /** Moves focus to the previous page (month). */
-    focusPreviousPage: () => void;
-    /** Moves focus to the next page (month). */
-    focusNextPage: () => void;
-    /** Moves focus to the previous section (year). */
-    focusPreviousSection: () => void;
-    /** Moves focus to the next section (year). */
-    focusNextSection: () => void;
-    /** Moves focus to the previous day. */
-    focusPreviousDay: () => void;
-    /** Moves focus to the next day. */
-    focusNextDay: () => void;
-    /** Moves focus to the previous week. */
-    focusPreviousWeek: () => void;
-    /** Moves focus to the next week. */
-    focusNextWeek: () => void;
-    /** Moves focus to the start of the month. */
-    focusPageStart: () => void;
-    /** Moves focus to the end of the month. */
-    focusPageEnd: () => void;
-    /** Selects the focused date. */
-    selectFocusedDate: () => void;
-    /** Selects a specific date. */
-    selectDate: (date: CalendarDate) => void;
-    /** Whether focus is currently within the calendar. */
-    isFocused: Accessor<boolean>;
-    /** Sets whether focus is within the calendar. */
-    setFocused: (focused: boolean) => void;
-    /** Gets the dates for a week in the visible range. */
-    getDatesInWeek: (weekIndex: number, monthStartDate?: CalendarDate) => (CalendarDate | null)[];
-    /** Gets the number of weeks in a month. */
-    getWeeksInMonth: (date?: CalendarDate) => number;
-    /** The week day headers. */
-    weekDays: Accessor<string[]>;
-    /** The title for the calendar (formatted month and year). */
-    title: Accessor<string>;
-    /** The number of visible months. */
-    visibleMonths: number;
-    /** Whether the calendar is paginating (for animations). */
-    isPaginating: Accessor<boolean>;
+  /** The currently selected date. */
+  value: Accessor<T | null>;
+  /** Sets the selected date. */
+  setValue: (value: T | null) => void;
+  /** The currently focused date. */
+  focusedDate: Accessor<CalendarDate>;
+  /** Sets the focused date. */
+  setFocusedDate: (date: CalendarDate) => void;
+  /** Whether the calendar is disabled. */
+  isDisabled: Accessor<boolean>;
+  /** Whether the calendar is read-only. */
+  isReadOnly: Accessor<boolean>;
+  /** The visible date range (first and last day of visible month(s)). */
+  visibleRange: Accessor<{
+    start: CalendarDate;
+    end: CalendarDate;
+  }>;
+  /** The timezone used for date calculations. */
+  timeZone: string;
+  /** The locale used for formatting and locale-specific week starts. */
+  locale: Accessor<string>;
+  /** The explicitly requested first weekday, or undefined for the locale default. */
+  firstDayOfWeek: Accessor<CalendarDayOfWeek | undefined>;
+  /** The validation state. */
+  validationState: Accessor<ValidationState | undefined>;
+  /** Whether the current value is invalid according to validation state. */
+  isValueInvalid: Accessor<boolean>;
+  /** Whether a date is selected. */
+  isSelected: (date: DateValue) => boolean;
+  /** Whether a date is focused. */
+  isCellFocused: (date: DateValue) => boolean;
+  /** Whether a date is unavailable. */
+  isCellUnavailable: (date: DateValue) => boolean;
+  /** Whether a date is disabled. */
+  isCellDisabled: (date: DateValue) => boolean;
+  /** Whether a date is outside the visible range. */
+  isOutsideVisibleRange: (date: DateValue) => boolean;
+  /** Whether a date is invalid. */
+  isInvalid: (date: DateValue) => boolean;
+  /** Moves focus to the previous page (month). */
+  focusPreviousPage: () => void;
+  /** Moves focus to the next page (month). */
+  focusNextPage: () => void;
+  /** Moves focus to the previous section (year). */
+  focusPreviousSection: () => void;
+  /** Moves focus to the next section (year). */
+  focusNextSection: () => void;
+  /** Moves focus to the previous day. */
+  focusPreviousDay: () => void;
+  /** Moves focus to the next day. */
+  focusNextDay: () => void;
+  /** Moves focus to the previous week. */
+  focusPreviousWeek: () => void;
+  /** Moves focus to the next week. */
+  focusNextWeek: () => void;
+  /** Moves focus to the start of the month. */
+  focusPageStart: () => void;
+  /** Moves focus to the end of the month. */
+  focusPageEnd: () => void;
+  /** Selects the focused date. */
+  selectFocusedDate: () => void;
+  /** Selects a specific date. */
+  selectDate: (date: CalendarDate) => void;
+  /** Whether focus is currently within the calendar. */
+  isFocused: Accessor<boolean>;
+  /** Sets whether focus is within the calendar. */
+  setFocused: (focused: boolean) => void;
+  /** Gets the dates for a week in the visible range. */
+  getDatesInWeek: (weekIndex: number, monthStartDate?: CalendarDate) => (CalendarDate | null)[];
+  /** Gets the number of weeks in a month. */
+  getWeeksInMonth: (date?: CalendarDate) => number;
+  /** The week day headers. */
+  weekDays: Accessor<string[]>;
+  /** The title for the calendar (formatted month and year). */
+  title: Accessor<string>;
+  /** The number of visible months. */
+  visibleMonths: number;
+  /** Whether the calendar is paginating (for animations). */
+  isPaginating: Accessor<boolean>;
 }
 /**
  * Provides state management for a calendar component.
  */
-export declare function createCalendarState<T extends DateValue = CalendarDate>(props?: CalendarStateProps<T>): CalendarState<T>;
-//# sourceMappingURL=createCalendarState.d.ts.map
+export declare function createCalendarState<T extends DateValue = CalendarDate>(
+  props?: CalendarStateProps<T>,
+): CalendarState<T>;
+//# sourceMappingURL=createCalendarState.d.ts.map