From 1a0b3b07dd2c5610d7f65efd3a8f9acba5a099fd Mon Sep 17 00:00:00 2001
From: Michael Bauer <michael-bauer@posteo.de>
Date: Wed, 16 Apr 2025 16:47:29 +0200
Subject: [PATCH] Document CalendarEventDialog's events-prop
---
.../calendar/CalendarEventDialog.vue | 29 ++++++++++++++++++-
1 file changed, 28 insertions(+), 1 deletion(-)
diff --git a/aleksis/core/frontend/components/calendar/CalendarEventDialog.vue b/aleksis/core/frontend/components/calendar/CalendarEventDialog.vue
index 45729786a..04926bea9 100644
--- a/aleksis/core/frontend/components/calendar/CalendarEventDialog.vue
+++ b/aleksis/core/frontend/components/calendar/CalendarEventDialog.vue
@@ -169,7 +169,34 @@ export default {
};
},
props: {
- // TODO
+ /**
+ * An object with event-name and event-description key-value-pairs.
+ *
+ * @example {
+ * example-event-name:
+ * {
+ * // Required
+ * createMutation: exampleEventCreateMutation,
+ * updateMutation: exampleEventUpdateMutation,
+ * fields: {
+ * example-field-name: {
+ * // required
+ * default: default-value,
+ * cols: 6, // number of columns in dialog
+ * // optional
+ * textKey: "example-key", // key for field-name lookup
+ * hide: true, // Hide this field in dialog
+ * filter: false, // Filter this result from object send to server
+ * },
+ * ...
+ * },
+ * // Optional
+ * textKey: "example-key", // key for event-name lookup
+ * filter: (object) => { Do something with object before sending to server }
+ * },
+ * ...
+ * }
+ */
events: {
type: Object,
required: false,
--
GitLab