diff --git a/aleksis/core/frontend/components/calendar/CalendarEventDialog.vue b/aleksis/core/frontend/components/calendar/CalendarEventDialog.vue index 45729786a080640b7ac0ce3dab32261e43fcc5dd..04926bea9251ab45754d5595b2b3e5fb24ae7339 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,