ds-schedule-actions.md

ds-schedule-actions

A component which takes an event occurrence and schedule and provides a menu for the user to perform common actions on them.

Properties

• schedule Schedule required: The schedule to perform actions on.
• calendar-event CalendarEvent required: The event instance to perform actions on.
• calendar Calendar: The optional calendar to update/refresh as actions are performed on the schedule.
• labels object: The labels to use in the component.

{ // Defaults
  remove:     'Remove this event',
  exclude:    'Remove this occurrence',
  cancel:     'Cancel this occurrence',
  uncancel:   'Undo cancellation',
  move:       'Move this occurrence',
  include:    'Add new occurrence'
}

• allow-remove boolean (default=true): If the menu allows the event to be removed from the calendar.
• allow-exclude boolean (default=true): If the menu allows the event occurrence to be removed from the schedule.
• allow-cancel boolean (default=true): If the menu allows the event occurrence to be cancelled in the schedule.
• allow-uncancel boolean (default=true): If the menu allows the event occurrence to be uncancelled in the schedule.
• allow-move boolean (default=true): If the menu allows the event occurrence to be moved in the schedule.
• allow-include boolean (default=true): If the menu allows the event occurrence to be duplicated in the schedule.

Events

• remove ScheduleActionsEvent: Occurs when the user selects "remove event". If any listening components don't mark handled = true then this component will proceed with normal removal behavior.
• exclude ScheduleActionsEvent: Occurs when the user selects "remove event occurrence". If any listening components don't mark handled = true then this component will proceed with normal exclusion behavior.
• cancel ScheduleActionsEvent: Occurs when the user has chosen to cancel the event occurrence. If any listening components don't mark handled = true then this component will proceed with normal cancelling behavior.
• uncancel ScheduleActionsEvent: Occurs when the user has chosen to uncancel the event occurrence. If any listening components don't mark handled = true then this component will proceed with normal uncancelling behavior.
• move ScheduleActionsEvent: Occurs when the user has chosen to move the event occurrence. If any listening components don't mark handled = true then this component will proceed with normal moving behavior.
• include ScheduleActionsEvent: Occurs when the user has chosen to duplicate the event occurrence. If any listening components don't mark handled = true then this component will proceed with normal duplicate behavior.
• finish ScheduleActionsEvent: Occurs when any of the actions have been performed.

Slots

• default: The component which triggers the actions menu.
• scheduleActionsAdditional {schedule, calendarEvent, calendar}: An additional set of v-list-tiles to add to the menu.

Methods

• remove void: Removes the event from the calendar.
• exclude void: Removes the event occurrence from the schedule.
• cancel void: Marks the event occurrence as cancelled.
• uncancel void: Removes the cancel status from the event occurrence.
• moveStart void: Starts the process of moving the event occurrence to a different day & time.
• includeStart void: Starts the process of duplicating the event occurrence to a different day & time.

Data

• movingDate boolean: If the user is selecting a day to move the event occurrence to.
• movingTime boolean: If the user is selecting a time to move the event occurrence to.
• includingDate boolean: If the user is selecting a day to duplicate the event occurrence to.
• includingTime boolean: If the user is selecting a time to duplicate the event occurrence to.
• targetDate Day: The day selected for moving or duplicating.
• targetTime Time: The time selected for moving or duplicating.

Computed

• repeats boolean: If the schedule has multiple events.
• event Event: The event being acted on.
• canRemove boolean: If the event can be removed from the calendar.
• canExclude boolean: If the event occurrence can be removed from the schedule.
• canCancel boolean: If the event occurrence can be cancelled.
• canUncancel boolean: If the event occurrence can be un-cancelled.
• canMove boolean: If the event occurrence can be moved.
• canInclude boolean: If the event occurrence can be duplicated.
• moving boolean: If the user is in the middle of moving the event occurrence.
• including boolean: If the user is in the middle of duplicating the event occurrence.

Types

ScheduleActionsEvent

• type string: The name of the event.
• schedule Schedule: The schedule performing an action on.
• calendarEvent CalendarEvent: The instance of an event being acted on.
• calendar Calendar: The optional calendar that the schedule and event exist in.
• event Event: The event which contains data and schedule information.
• handled boolean (default=false): If the action has been handled by any listeners. If this is not marked true then this component will try to perform the action itself.
• refresh boolean (default=true): If the action should refresh the calendar (if provided).
• target Day: The day & time to move or duplicate an event to.
• $vm Vue: The instance of the component.
• $element HTMLElement: The element of the component.