@nocoo/basalt 2.0.2 → 2.1.0

package/dist/components/date-picker.d.ts

@@ -1,3 +1,4 @@
+import * as React from "react";
 import { type ComponentProps } from "react";
 export type DatePickerRange = {
     from: string;
@@ -10,6 +11,36 @@ export type DatePickerPreset = {
         to: string;
     };
 };
+export type DatePickerLabels = {
+    /**
+     * Accessible label for the calendar popup container.
+     * @default "Date calendar" (or derived from `aria-label`)
+     */
+    calendar?: string;
+    /**
+     * Accessible label for previous month button.
+     * @default "Prev"
+     */
+    previousMonth?: string;
+    /**
+     * Accessible label for next month button.
+     * @default "Next"
+     */
+    nextMonth?: string;
+    /**
+     * Fallback label for the trigger when no date is chosen.
+     * @default "Pick a date"
+     */
+    placeholder?: string;
+    /**
+     * Custom validation error message displayed when form validation fails.
+     */
+    validationMessage?: string;
+    /**
+     * Accessible keyboard navigation instructions announced for the calendar grid.
+     */
+    keyboardInstructions?: string;
+};
 export type DatePickerProps = Omit<ComponentProps<"input">, "value" | "defaultValue" | "onChange" | "type" | "children" | "disabled" | "name" | "required" | "min" | "max"> & {
     /**
      * The controlled ISO date in single mode.
@@ -28,6 +59,21 @@ export type DatePickerProps = Omit<ComponentProps<"input">, "value" | "defaultVa
      * @default single
      */
     mode?: "single" | "range";
+    /**
+     * The controlled displayed month in `YYYY-MM` format (at least 4-digit positive year).
+     * If omitted or invalid, falls back smoothly to `defaultMonth`, selected date, or today.
+     */
+    month?: string;
+    /**
+     * The uncontrolled initial displayed month in `YYYY-MM` format (at least 4-digit positive year).
+     * If omitted or invalid, falls back smoothly to selected date or today.
+     */
+    defaultMonth?: string;
+    /**
+     * Called only when calendar navigation requests a month change (`YYYY-MM`).
+     * Not invoked during component render or synchronous prop synchronization.
+     */
+    onMonthChange?: (month: string) => void;
     /**
      * The controlled range in range mode.
      */
@@ -66,12 +112,17 @@ export type DatePickerProps = Omit<ComponentProps<"input">, "value" | "defaultVa
      * Custom formatter for the trigger label.
      */
     formatDate?: (date: Date) => string;
+    /**
+     * Optional localized labels for calendar dialog, navigation, and trigger placeholder.
+     */
+    labels?: DatePickerLabels;
     /**
      * Native form field name.
      */
     name?: string;
     /**
-     * Native required constraint.
+     * Native required constraint. When readOnly is set, native required validation is disabled.
+     * When an empty required DatePicker submits, the visible trigger receives focus and invalid state.
      */
     required?: boolean;
     /**
@@ -87,4 +138,4 @@ export type DatePickerProps = Omit<ComponentProps<"input">, "value" | "defaultVa
      */
     disabled?: boolean;
 };
-export declare function DatePicker({ value, defaultValue, onChange, mode, rangeValue, defaultRangeValue, onRangeChange, isDisabledDate, presets, locale, weekStartsOn, timeZone, formatDate, name, required, min, max, disabled, className, id, "aria-label": ariaLabel, "aria-describedby": ariaDescribedBy, "aria-invalid": ariaInvalid, ...inputRest }: DatePickerProps): import("react").JSX.Element;
+export declare function DatePicker({ value, defaultValue, onChange, mode, month: controlledMonthProp, defaultMonth: defaultMonthProp, onMonthChange, rangeValue, defaultRangeValue, onRangeChange, isDisabledDate, presets, locale, weekStartsOn, timeZone, formatDate, name, required, min, max, disabled, className, id, "aria-label": ariaLabel, "aria-describedby": ariaDescribedBy, "aria-invalid": ariaInvalid, labels, ...inputRest }: DatePickerProps): React.JSX.Element;