sanity-plugin-recurring-dates 1.0.2 → 1.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Tom Smith
+Copyright (c) 2024 Tom Smith
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -68,6 +68,9 @@ export default defineConfig({
         timeFormat: 'HH:mm',
         timeStep: 15,
       },
+
+      // Changes the date picker to date only, no time
+      dateOnly: true, // defaults to false
     }),
   ],
 })
@@ -102,6 +105,9 @@ defineField({
       timeFormat: 'HH:mm',
       timeStep: 15,
     },
+
+    // Changes the date picker to date only, no time
+    dateOnly: true, // defaults to false
   },
 })
 ```
@@ -120,6 +126,18 @@ Here is an example of the data stored on the field after configuring a recurring
 
 As the plugin uses the standard Sanity `datetime` field type, the start and end dates are stored in UTC. The `rrule` string is in line with the recurrence rules defined in the [iCalendar RFC](https://tools.ietf.org/html/rfc5545), with rules generated by the [rrule.js](https://github.com/jakubroztocil/rrule) library.
 
+If you enable the `dateOnly` option, then the time will not be present on the field:
+
+```json
+{
+  "rrule": "RRULE:FREQ=MONTHLY;INTERVAL=1;BYDAY=+1MO",
+  "startDate": "2023-08-01",
+  "endDate": "2023-08-01"
+}
+```
+
+Depending on how you use the data, you may need to append a time to the date before using it on your front-end.
+
 ### Using the rules on a frontend
 
 Whilst displaying the recurring dates on a frontend is beyond the scope of this plugin, there are a couple of considerations worth calling out.

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export declare interface PluginConfig {
   hideEndDate?: boolean
   hideCustom?: boolean
   dateTimeOptions?: DatetimeOptions
+  dateOnly?: boolean
 }
 
 export declare interface RecurringDate {