sy-ui-lib 1.0.15 → 1.0.16

package/dist/components/DatePicker/DatePicker.component.d.ts

@@ -1,3 +1,61 @@
 import { DatePickerProps } from './DatePicker.types';
+/**
+ * DatePicker Component
+ *
+ * A flexible and reusable date picker component that supports both single date
+ * selection and date range selection. It provides built-in constraints, default
+ * selections, and responsive sizing for different UI needs.
+ *
+ * Props:
+ * @param {string} [title="Date"] Label or placeholder text displayed when no date is selected.
+ * @param {"single" | "range"} [variant="single"]  Determines the mode of the date picker.
+ *        Use `"single"` for selecting one date or `"range"` for selecting a start and end date.
+ * @param {Date} [value]  Selected date value (used in single mode).
+ * @param {(date: Date | undefined) => void} [onChange] Callback triggered when a single date is selected.
+ * @param {Date} [fromDate] Start date (used in range mode).
+ * @param {Date} [toDate] - End date (used in range mode).
+ * @param {(date: Date | undefined) => void} [onFromChange] Callback triggered when the "from" date changes.
+ * @param {(date: Date | undefined) => void} [onToChange] Callback triggered when the "to" date changes.
+ * @param {"sm" | "lg" | "full"} [size="sm"] - Controls the width of the date picker.
+ *        `"sm"` for compact, `"lg"` for wider input, and `"full"` for full width.
+ * @param {"sm" | "lg"} [height="lg"] - Controls the height of the input field.
+ * @param {number} [maxPastDays] - Restricts selection to only the last N days from today.
+ * @param {number} [maxRangeDays] - Limits the maximum selectable range between "from" and "to" dates.
+ * @param {boolean} [currentSelected=false] - If true, automatically selects today's date
+ *        (or default range if range mode is enabled).
+ * @param {number} [rangeDays=0] - Defines the default range in days (used when `currentSelected` is true).
+ *        Example: If `rangeDays = 4`, then range will be from (today - 4 days) to today.
+ * @returns A responsive date picker component supporting both single and range selection modes.
+ * @example
+ * Single Date:
+ * <DatePicker
+ *   title="Select Date"
+ *   variant="single"
+ *   value={date}
+ *   onChange={(d) => setDate(d)}
+ * />
+ *
+ * Date Range:
+ * <DatePicker
+ *   variant="range"
+ *   fromDate={from}
+ *   toDate={to}
+ *   onFromChange={setFrom}
+ *   onToChange={setTo}
+ * />
+ *
+ * Default Today:
+ * <DatePicker
+ *   variant="single"
+ *   currentSelected
+ * />
+ *
+ * Last N Days Range:
+ * <DatePicker
+ *   variant="range"
+ *   currentSelected
+ *   rangeDays={7}
+ * />
+ */
 declare const DatePicker: React.FC<DatePickerProps>;
 export default DatePicker;

package/dist/components/DatePicker/DatePicker.types.d.ts

@@ -17,11 +17,13 @@ export interface DatePickerProps {
     onFromChange?: (date: Date | undefined) => void;
     onToChange?: (date: Date | undefined) => void;
     size?: DatePickerSize;
-    /** 👇 NEW: height controlled from parent */
+    /** height controlled from parent */
     height?: "sm" | "lg";
     /** Constraints */
     maxPastDays?: number;
     maxRangeDays?: number;
     /** Default select */
     currentSelected?: boolean;
+    /** Default select range */
+    rangeDays?: number;
 }