A big pile of improvements and new features including a new fieldMethod, additional preview controls, and more.

Author: scottboms

README.md

@@ -30,18 +30,22 @@ git submodule add https://github.com/scottboms/kirby-events-field.git site/plugi
 
 In a Page blueprint, add a new field with the type `event.` Standard field attributes such as `label, required, help`, etc. can also be used to override defaults. Use `empty` to change the text displayed when the field is in an empty state.
 
-#### Field Properties
-
-| Name      | Type    | Default | Description                                                      |
-|-----------|---------|---------|------------------------------------------------------------------|
-| empty     | string  | `null`  | The placeholder text if no information has been added            |
-| time      | boolean | `true`  | Include time as part of date fields                              |
-| eventName | boolean | `true`  | If `true`, the field is available in the form                    |
-| endDate   | boolean | `true`  | If `true`, the field is available in the form                    |
-| venue     | boolean | `true`  | If `true`, the field is available in the form                    | 
-| url       | boolean | `true`  | If `true`, the field is available in the form                    | 
-| details   | boolean | `true`  | If `true`, the field is available in the form                    | 
-| preview   | array   | `[ ]`   | Optional array of field names to display in the preview          | 
+### Field Properties
+
+| Name       | Type    | Default | Description                                                     |
+|------------|---------|---------|-----------------------------------------------------------------|
+| empty      | string  | `null`  | The placeholder text if no information has been added           |
+| eventName  | boolean | `true`  | If `true`, the field is available in the form                   |
+| endDate    | boolean | `true`  | If `true`, the field is available in the form                   |
+| hoursStart | boolean | `true`  | If `true`, the field is available in the form                   |
+| hoursEnd   | boolean | `true`  | If `true`, the field is available in the form                   |
+| city       | boolean | `true`  | If `true`, the field is available in the form                   | 
+| state      | boolean | `true`  | If `true`, the field is available in the form                   | 
+| country    | boolean | `true`  | If `true`, the field is available in the form                   | 
+| venue      | boolean | `true`  | If `true`, the field is available in the form                   | 
+| url        | boolean | `true`  | If `true`, the field is available in the form                   | 
+| details    | boolean | `true`  | If `true`, the field is available in the form                   | 
+| preview    | array   | `[ ]`   | Optional array of field names to display in the preview         | 
 
 
 ```yml
@@ -55,11 +59,15 @@ In a Page blueprint, add a new field with the type `event.` Standard field attri
     type: event
     empty: 'Add an event'
 
-    # field attributes to include
+    # optional field properties
     eventName: true
-    endDate: false
-    time: false
+    endDate: true
+    hoursStart: true
+    hoursEnd: true
     venue: true
+    city: true
+    state: true
+    country: true
     url: true
     details: true
 
@@ -68,9 +76,14 @@ In a Page blueprint, add a new field with the type `event.` Standard field attri
       - eventName
       - startDate
       - endDate
+      - hoursStart
+      - hoursEnd
+      - eventDates # summary of startDate, endDate
+      - eventHours # summary of hoursStart, hoursEnd
       - city
       - state
       - country
+      - location # summary of city, state, country
       - venue
       - url
       - details
@@ -87,7 +100,9 @@ To access an event field in your templates, you can use the toEvent() method.
 
 <div class="dates">
 	<span class="start"><?= $event->startDate()->toDate('M d, Y') ?></span> –
-	<span class="end"><?= $event->endDate()->toDate('M d, Y') ?></span>
+	<span class="end"><?= $event->endDate()->toDate('M d, Y') ?></span>, daily from
+	<span class="start"><?= $event->hoursStart()->toDate('g:i a') ?></span> – 
+	<span class="end"><?= $event->hoursEnd()->toDate('g:i a') ?></span>
 </div>
 
 <div class="location">
@@ -101,6 +116,10 @@ To access an event field in your templates, you can use the toEvent() method.
 <?php endif ?>
 ```
 
+### Field Methods
+
+Special Field Methods have been included to provide additional utility when utilizing the field. These include a `toEvent()` wrapper which behaves similarly to Kirby's native toStructure() method. Additionally, a `daysUntil()` method allows you to provide a simple countdown based on the field's `startDate` value.
+
 
 ## Compatibility
 

composer.json

@@ -1,5 +1,5 @@
 {
-  "name": "scottboms/events",
+  "name": "scottboms/events-field",
   "description": "Events Field plugin for Kirby",
   "type": "kirby-plugin",
   "homepage": "https://github.com/scottboms/kirby-events-field",

index.js

@@ -17,22 +17,24 @@
 	throw new Exception('Events Field requires Kirby v4 or v5');
 }
 
-Kirby::plugin('scottboms/events', [
+Kirby::plugin('scottboms/events-field', [
 	'fields' => [
 		'event' => [
 			'props' => [
 				'value' => function ($value = null) {
 					$event = Yaml::decode($value);
 					return [
-						'eventName' => null,
-						'startDate' => null,
-						'endDate'   => null,
-						'city'      => null,
-						'state'     => null,
-						'country'   => null,
-						'venue'     => null,
-						'url'       => null,
-						'details'   => null,
+						'eventName'  => null,
+						'startDate'  => null,
+						'endDate'    => null,
+						'hoursStart' => null,
+						'hoursEnd'   => null,
+						'city'       => null,
+						'state'      => null,
+						'country'    => null,
+						'venue'      => null,
+						'url'        => null,
+						'details'    => null,
 						...$event
 					];
 				},
@@ -41,58 +43,22 @@
 				},
 
 				// edit-drawer toggles (independent of preview)
-				'eventName' => fn ($value = true)  => (bool)$value,
-				'endDate'   => fn ($value = true)  => (bool)$value,
-				'venue'     => fn ($value = true)  => (bool)$value,
-				'url'       => fn ($value = true)  => (bool)$value,
-				'details'   => fn ($value = true)  => (bool)$value,
-				'time'      => fn ($value = true)  => (bool)$value,
-				'empty'     => fn ($value = false) => (bool)$value,
+				'eventName'  => fn ($value = true)  => (bool)$value,
+				'endDate'    => fn ($value = true)  => (bool)$value,
+				'hoursStart' => fn ($value = true) => (bool)$value,
+				'hoursEnd'   => fn ($value = true) => (bool)$value,
+				'venue'      => fn ($value = true)  => (bool)$value,
+				'url'        => fn ($value = true)  => (bool)$value,
+				'details'    => fn ($value = true)  => (bool)$value,
+				'empty'      => fn ($value = false) => (bool)$value,
 			]
 		]
 	],
 
-	'fieldMethods' => [
-		/**
-		 * $page->event()->toEvent()
-		 * returns an obj with field instances: startDate(), endDate(), city(), etc.
-		 */
-		'toEvent' => function (Field $field) {
-			$raw = $field->value();
-			$data = is_array($raw) ? $raw : (is_string($raw) ? (Yaml::decode($raw) ?? []) : []);
-
-			$defaults = [
-				'eventName' => null,
-				'startDate' => null,
-				'endDate'   => null,
-				'city'      => null,
-				'state'     => null,
-				'country'   => null,
-				'venue'     => null,
-				'url'       => null,
-				'details'   => null,
-			];
-			$data = array_merge($defaults, $data);
-
-			foreach ($data as $k => $v) {
-				if ($v === '' || $v === []) {
-					$data[$k] = null;
-				}
-			}
-
-			// wrap everything as field instances so you can call ->toDate(), ->isNotEmpty(), etc.
-			$parent = $field->parent() ?? site();
-			$wrapped = [];
-			foreach ($data as $key => $value) {
-				$wrapped[$key] = new Field($parent, $key, $value);
-			}
-			//return as obj, so $event->startDate() returns a field
-			return new Obj($wrapped);
-		}
-	],
+	'fieldMethods' => require __DIR__ . '/lib/fieldMethods.php',
 
 	'info' => [
-		'version'  => '1.0.0',
+		'version'  => '1.1.0',
 		'homepage' => 'https://github.com/scottboms/kirby-events-field',
 		'license'  => 'MIT',
 		'authors'  => [[ 'name' => 'Scott Boms', 'url' => 'https://scottboms.com' ]],