@archpublicwebsite/rangepicker 1.0.8 → 1.0.11

package/README.md

@@ -38,10 +38,47 @@ const dates = ref('')
 </script>
 
 <template>
-  <RangepickerInput 
-    v-model="dates" 
+  <RangepickerInput
+    v-model="dates"
+    primary-color="#3b82f6"
+    placeholder="Check in / Check out"
+  />
+</template>
+```
+
+### TypeScript Support
+
+Full TypeScript support with exported types for type-safe development:
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue'
+import {
+  RangepickerInput,
+  type RangepickerProps,
+  type DateRange
+} from '@archpublicwebsite/rangepicker'
+import '@archpublicwebsite/rangepicker/style.css'
+
+// Type-safe date range
+const dates = ref<DateRange>({ startDate: '', endDate: '' })
+
+// Type-safe props configuration
+const pickerOptions: Partial<RangepickerProps> = {
+  format: 'DD/MM/YYYY',
+  autoApply: true,
+  minDays: 2,
+  maxDays: 30,
+  showTooltip: true
+}
+</script>
+
+<template>
+  <RangepickerInput
+    v-model="dates"
+    v-bind="pickerOptions"
     primary-color="#3b82f6"
-    placeholder="Check in / Check out" 
+    placeholder="Check in / Check out"
   />
 </template>
 ```
@@ -161,6 +198,21 @@ const options = {
 ### Basic Usage
 
 ```vue
+<script setup lang="ts">
+import { ref, computed } from 'vue'
+import { Rangepicker, type DateRange } from '@archpublicwebsite/rangepicker'
+import '@archpublicwebsite/rangepicker/style.css'
+
+const triggerRef = ref<HTMLElement | null>(null)
+const isOpen = ref(false)
+const dateRange = ref<DateRange>({ startDate: '', endDate: '' })
+
+const dateRangeText = computed(() => {
+  if (!dateRange.value.startDate || !dateRange.value.endDate) return ''
+  return `${dateRange.value.startDate} - ${dateRange.value.endDate}`
+})
+</script>
+
 <template>
   <div>
     <input
@@ -177,25 +229,10 @@ const options = {
       v-model:is-open="isOpen"
       :trigger-element="triggerRef"
       :value-of-months="2"
-      :format="'DD MMM YYYY'"
+      format="DD MMM YYYY"
     />
   </div>
 </template>
-
-<script setup lang="ts">
-import { ref, computed } from 'vue'
-import { Rangepicker } from '@archpublicwebsite/rangepicker'
-import '@archpublicwebsite/rangepicker/style.css'
-
-const triggerRef = ref<HTMLElement | null>(null)
-const isOpen = ref(false)
-const dateRange = ref({ startDate: '', endDate: '' })
-
-const dateRangeText = computed(() => {
-  if (!dateRange.value.startDate || !dateRange.value.endDate) return ''
-  return `${dateRange.value.startDate} - ${dateRange.value.endDate}`
-})
-</script>
 ```
 
 ### Using the Composable
@@ -203,67 +240,43 @@ const dateRangeText = computed(() => {
 ```vue
 <script setup lang="ts">
 import { ref } from 'vue'
-import { Rangepicker, useRangepicker } from '@archpublicwebsite/rangepicker'
+import {
+  Rangepicker,
+  useRangepicker,
+  type RangepickerProps
+} from '@archpublicwebsite/rangepicker'
 import '@archpublicwebsite/rangepicker/style.css'
 
 const triggerRef = ref<HTMLElement | null>(null)
-const { isOpen, dateRange, open, close, toggle } = useRangepicker(triggerRef, {
+
+// Type-safe composable options
+const options: Partial<RangepickerProps> = {
   valueOfMonths: 2,
   format: 'DD MMM YYYY',
   minDays: 1,
-})
-</script>
-```
+  autoApply: true
+}
 
-### Hotel Booking Example
+const { isOpen, dateRange, open, close, toggle } = useRangepicker(triggerRef, options)
+</script>
 
-```vue
 <template>
   <div>
-    <input
-      ref="bookingInputRef"
-      type="text"
-      :value="bookingText"
-      placeholder="Check-in - Check-out"
-      readonly
-      @click="isBookingOpen = true"
-    />
+    <button ref="triggerRef" @click="toggle">
+      {{ dateRange.startDate && dateRange.endDate
+        ? `${dateRange.startDate} - ${dateRange.endDate}`
+        : 'Select dates' }}
+    </button>
 
     <Rangepicker
-      v-model="bookingDates"
-      v-model:is-open="isBookingOpen"
-      :trigger-element="bookingInputRef"
-      :value-of-months="2"
-      :value-of-columns="2"
-      :min-days="1"
-      :format="'DD MMM YYYY'"
-      :show-tooltip="true"
-      :holidays="holidays"
-      :min-date="today"
-      variant="desktop"
+      v-model="dateRange"
+      v-model:is-open="isOpen"
+      :trigger-element="triggerRef"
+      v-bind="options"
     />
   </div>
 </template>
-
-<script setup lang="ts">
-import { ref, computed } from 'vue'
-import { Rangepicker } from '@archpublicwebsite/rangepicker'
-import '@archpublicwebsite/rangepicker/style.css'
-import dayjs from 'dayjs'
-
-const bookingInputRef = ref<HTMLElement | null>(null)
-const isBookingOpen = ref(false)
-const bookingDates = ref({ startDate: '', endDate: '' })
-const today = dayjs().format('YYYY-MM-DD')
-const holidays = ref(['2025-12-25', '2025-01-01'])
-
-const bookingText = computed(() => {
-  if (!bookingDates.value.startDate || !bookingDates.value.endDate) return ''
-  return `${bookingDates.value.startDate} - ${bookingDates.value.endDate}`
-})
-</script>
 ```
-
 ## Props
 
 | Prop | Type | Default | Description |
@@ -299,6 +312,128 @@ const bookingText = computed(() => {
 | `dateSelected` | `Dayjs` | Emitted when a date is clicked |
 | `rangeSelected` | `{ start: Dayjs, end: Dayjs }` | Emitted when range is complete |
 
+## TypeScript Support
+
+This package is built with TypeScript and provides full type definitions. All types are automatically exported for your convenience.
+
+### Available Types
+
+```typescript
+import type {
+  RangepickerProps,    // Component props interface
+  RangepickerEmits,    // Event emitter interface
+  DateRange,           // Date range object type
+  CalendarDay,         // Internal calendar day type
+  CalendarMonth        // Internal calendar month type
+} from '@archpublicwebsite/rangepicker'
+```
+
+### Type Definitions
+
+#### `RangepickerProps`
+Complete props interface with JSDoc documentation. All props are optional with sensible defaults:
+
+```typescript
+interface RangepickerProps {
+  modelValue?: { startDate?: string | Date | Dayjs; endDate?: string | Date | Dayjs }
+  isOpen?: boolean
+  variant?: 'desktop' | 'mobile'
+  minDate?: string | Date | Dayjs
+  maxDate?: string | Date | Dayjs
+  minDays?: number
+  maxDays?: number
+  close?: boolean
+  valueOfMonths?: number  // default: 2
+  valueOfColumns?: number // default: 2
+  disabledDates?: (string | Date)[]
+  holidays?: (string | Date)[]
+  format?: string         // default: 'YYYY-MM-DD'
+  delimiter?: string      // default: ' - '
+  placeholder?: string
+  label?: string
+  showTooltip?: boolean   // default: true
+  autoApply?: boolean     // default: false
+  position?: 'auto' | 'top' | 'bottom'
+  triggerElement?: HTMLElement | null
+  colorStyles?: Record<string, string>
+}
+```
+
+#### `DateRange`
+Type for the v-model binding:
+
+```typescript
+interface DateRange {
+  startDate: string
+  endDate: string
+}
+```
+
+#### `RangepickerEmits`
+Event emitter types for type-safe event handling:
+
+```typescript
+interface RangepickerEmits {
+  'update:modelValue': [value: { startDate: string; endDate: string }]
+  'update:isOpen': [value: boolean]
+  'dateSelected': [date: Dayjs]
+  'rangeSelected': [start: Dayjs, end: Dayjs]
+}
+```
+
+### Usage Examples
+
+#### Type-Safe Component Props
+
+```typescript
+import type { RangepickerProps } from '@archpublicwebsite/rangepicker'
+
+// Define props with autocomplete support
+const config: Partial<RangepickerProps> = {
+  format: 'DD/MM/YYYY',
+  minDays: 2,
+  maxDays: 30,
+  autoApply: true,
+  showTooltip: true
+}
+```
+
+#### Type-Safe Event Handlers
+
+```typescript
+import type { Dayjs } from 'dayjs'
+
+function handleDateSelected(date: Dayjs) {
+  console.log('Selected:', date.format('YYYY-MM-DD'))
+}
+
+function handleRangeSelected(start: Dayjs, end: Dayjs) {
+  const nights = end.diff(start, 'day')
+  console.log(`Booking: ${nights} nights`)
+}
+```
+
+#### Type-Safe Refs
+
+```typescript
+import { ref } from 'vue'
+import type { DateRange } from '@archpublicwebsite/rangepicker'
+
+const dateRange = ref<DateRange>({ startDate: '', endDate: '' })
+const holidays = ref<string[]>(['2025-12-25', '2025-01-01'])
+const disabledDates = ref<Date[]>([new Date('2025-12-24')])
+```
+
+### IDE Support
+
+With the exported types, you'll get:
+
+- ✅ **Autocomplete** - IntelliSense for all props and events
+- ✅ **Type Checking** - Compile-time error detection
+- ✅ **Documentation** - Hover tooltips with prop descriptions and default values
+- ✅ **Refactoring** - Safe rename and refactor operations
+- ✅ **Error Prevention** - Catch typos and incorrect prop usage before runtime
+
 ## Development
 
 ```bash
@@ -318,31 +453,6 @@ pnpm type-check
 pnpm preview
 ```
 
-## Package Structure
-
-```
-packages/rangepicker/
-├── dist/                  # Built files (published to npm)
-│   ├── rangepicker.js    # ES module (39.91 KB, gzipped: 9.42 KB)
-│   ├── rangepicker.umd.cjs  # UMD module (20.18 KB, gzipped: 7.07 KB)
-│   ├── style.css         # Compiled styles with arch- prefix (48.69 KB, gzipped: 5.29 KB)
-│   └── *.d.ts            # TypeScript type definitions
-├── src/
-│   ├── index.ts          # Main entry point
-│   ├── Rangepicker.vue   # Core calendar component
-│   ├── RangepickerInput.vue # Input wrapper component
-│   ├── types.ts          # Type definitions
-│   ├── utils/
-│   │   ├── calendar.ts   # Calendar generation logic
-│   │   ├── date.ts       # Dayjs utilities
-│   │   └── position.ts   # Smart positioning
-│   └── styles/
-│       └── rangepicker.scss  # Tailwind CSS with arch- prefix
-├── package.json
-├── vite.config.ts
-└── tailwind.config.js    # With prefix: 'arch-'
-```
-
 ## CSS Architecture
 
 The component uses **Tailwind CSS with `arch-` prefix** to prevent conflicts with other frameworks:

package/dist/Rangepicker.vue.d.ts

@@ -1,31 +1,6 @@
 import { Dayjs } from 'dayjs';
-interface Props {
-    modelValue?: {
-        startDate?: string | Date | Dayjs;
-        endDate?: string | Date | Dayjs;
-    };
-    isOpen?: boolean;
-    variant?: 'desktop' | 'mobile';
-    minDate?: string | Date | Dayjs;
-    maxDate?: string | Date | Dayjs;
-    minDays?: number;
-    maxDays?: number;
-    close?: boolean;
-    valueOfMonths?: number;
-    valueOfColumns?: number;
-    disabledDates?: (string | Date)[];
-    holidays?: (string | Date)[];
-    format?: string;
-    delimiter?: string;
-    placeholder?: string;
-    label?: string;
-    showTooltip?: boolean;
-    autoApply?: boolean;
-    position?: 'auto' | 'top' | 'bottom';
-    triggerElement?: HTMLElement | null;
-    colorStyles?: Record<string, string>;
-}
-declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+import { RangepickerProps } from './types';
+declare const _default: import('vue').DefineComponent<RangepickerProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     "update:modelValue": (value: {
         startDate: string;
         endDate: string;
@@ -33,7 +8,7 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
     "update:isOpen": (value: boolean) => any;
     dateSelected: (date: Dayjs) => any;
     rangeSelected: (start: Dayjs, end: Dayjs) => any;
-}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{
+}, string, import('vue').PublicProps, Readonly<RangepickerProps> & Readonly<{
     "onUpdate:modelValue"?: (value: {
         startDate: string;
         endDate: string;

package/dist/Rangepicker.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Rangepicker.vue.d.ts","sourceRoot":"","sources":["../src/Rangepicker.vue"],"names":[],"mappings":"AA2iBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAiClC,UAAU,KAAK;IACb,UAAU,CAAC,EAAE;QACX,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAAA;QACjC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAAA;KAChC,CAAA;IACD,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAAA;IAC/B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAAA;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,aAAa,CAAC,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAA;IACjC,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAA;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAA;IACpC,cAAc,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACrC;;;mBAvC2C,MAAM;iBAAW,MAAM;;;;;;;mBAAvB,MAAM;iBAAW,MAAM;;;;;;YAmBxD,OAAO;aACN,SAAS,GAAG,QAAQ;mBAMd,MAAM;oBACL,MAAM;YAGd,MAAM;eACH,MAAM;iBAGJ,OAAO;eACT,OAAO;cACR,MAAM,GAAG,KAAK,GAAG,QAAQ;;;;AAqnBtC,wBAUG"}
+{"version":3,"file":"Rangepicker.vue.d.ts","sourceRoot":"","sources":["../src/Rangepicker.vue"],"names":[],"mappings":"AA0jBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAInC,OAAO,KAAK,EAAe,gBAAgB,EAAE,MAAM,SAAS,CAAC;;;mBAejB,MAAM;iBAAW,MAAM;;;;;;;mBAAvB,MAAM;iBAAW,MAAM;;;;;;;;;;;;;;;;;;AA+lBnE,wBAUG"}

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import './styles/rangepicker.scss';
 import Rangepicker from './Rangepicker.vue';
 import RangepickerInput from './RangepickerInput.vue';
-import type { DateRange, RangepickerProps } from './types';
+import type { DateRange, RangepickerProps, RangepickerEmits, CalendarDay, CalendarMonth } from './types';
 export default RangepickerInput;
 export { Rangepicker, RangepickerInput };
-export type { RangepickerProps, DateRange };
+export type { RangepickerProps, RangepickerEmits, DateRange, CalendarDay, CalendarMonth };
 export declare function useRangepicker(triggerRef: any, options?: Partial<RangepickerProps>): {
     isOpen: import("vue").Ref<boolean, boolean>;
     dateRange: import("vue").Ref<{

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,2BAA2B,CAAA;AAClC,OAAO,WAAW,MAAM,mBAAmB,CAAA;AAC3C,OAAO,gBAAgB,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAG1D,eAAe,gBAAgB,CAAA;AAG/B,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAA;AAGxC,YAAY,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAA;AAG3C,wBAAgB,cAAc,CAAC,UAAU,EAAE,GAAG,EAAE,OAAO,GAAE,OAAO,CAAC,gBAAgB,CAAM;;;;;;;;;;;;;EAgBtF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,2BAA2B,CAAA;AAClC,OAAO,WAAW,MAAM,mBAAmB,CAAA;AAC3C,OAAO,gBAAgB,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAGxG,eAAe,gBAAgB,CAAA;AAG/B,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAA;AAGxC,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,CAAA;AAGzF,wBAAgB,cAAc,CAAC,UAAU,EAAE,GAAG,EAAE,OAAO,GAAE,OAAO,CAAC,gBAAgB,CAAM;;;;;;;;;;;;;EAgBtF"}